--- /dev/null
+Compressed Folders Patch
+========================
+
+ Read from/write to compressed mailboxes
+
+Patch
+-----
+
+ To check if Mutt supports "Compress Folders", look for "+USE_COMPRESSED" in
+ the mutt version.
+
+ Dependencies
+ * mutt-1.5.24
+
+Introduction
+------------
+
+ The Compressed Folder patch allows Mutt to read mailbox files that are
+ compressed. But it isn't limited to compressed files. It works well with
+ encrypted files, too. In fact, if you can create a program/script to
+ convert to and from your format, then Mutt can read it.
+
+ The patch adds three hooks to Mutt: 'open-hook', 'close-hook' and
+ 'append-hook'. They define commands to: uncompress a file; compress a file;
+ append messages to an already compressed file.
+
+ There are some examples of both compressed and encrypted files, later. For
+ now, the documentation will just concentrate on compressed files.
+
+Commands
+--------
+
+ open-hook pattern shell-command
+ close-hook pattern shell-command
+ append-hook pattern shell-command
+
+ The shell-command must contain two placeholders for filenames: '%f' and
+ '%t'. These represent "from" and "to" filenames. It's a good idea to put
+ quotes around these placeholders.
+
+ If you need the exact string "%f" or "%t" in your command, simply double up
+ the "%" character, e.g. "%%f" or "%%t".
+
+ Not all Hooks are Required
+
+ | Open | Close | Append | Effect | Useful if |
+ |------|-------|--------|---------------------------------------------|-------------------------------------------------|
+ | Open | - | - | Folder is readonly | Folder is just a backup |
+ | Open | Close | - | Folder is read/write, but the entire folder | Compression format doesn't support appending |
+ | | | | must be written if anything is changed | Compression format doesn't support appending |
+ | Open | Close | Append | Folder is read/write and emails can be | Compression format supports appending |
+ | | | | efficiently added to the end | Compression format supports appending |
+ | Open | - | Append | Folder is readonly, but can be appended to | You want to store emails, but never change them |
+
+ > Note
+ >
+ > The command:
+ > - should return a non-zero exit status on failure
+ > - should not delete any files
+
+### Read from compressed mailbox
+
+ open-hook regexp shell-command
+
+ If Mutt is unable to open a file, it then looks for 'open-hook' that
+ matches the filename.
+
+ If your compression program doesn't have a well-defined extension, then you
+ can use '.' as the regexp.
+
+#### Example of open-hook
+
+ open-hook '.gz$' "gzip -cd '%f' > '%t'"
+
+ * Mutt finds a file, "example.gz", that it can't read
+ * Mutt has an 'open-hook' whose regexp matches the filename: '.gz$'
+ * Mutt uses the command 'gzip -cd' to create a temporary file that it *can*
+ read
+
+### Write to a compressed mailbox
+
+ close-hook regexp shell-command
+
+ When Mutt has finished with a compressed mail folder, it will look for a
+ matching 'close-hook' to recompress the file. This hook is optional.
+
+ > Note
+ >
+ > If the folder has not been modifed, the
+ > close-hook
+ > will not be called.
+
+#### Example of close-hook
+
+ close-hook '.gz$' "gzip -c '%t' > '%f'"
+
+ * Mutt has finished with a folder, "example.gz", that it opened with
+ 'open-hook'
+ * The folder has been modified
+ * Mutt has a 'close-hook' whose regexp matches the filename: '.gz$'
+ * Mutt uses the command 'gzip -c' to create a new compressed file
+
+### Append to a compressed mailbox
+
+ append-hook regexp shell-command
+
+ When Mutt wants to append an email to a compressed mail folder, it will
+ look for a matching 'append-hook'. This hook is optional.
+
+ Using the 'append-hook' will save time, but Mutt won't be able to determine
+ the type of the mail folder inside the compressed file.
+
+ Mutt will *assume* the type to be that of the '$mbox_type' variable. Mutt
+ also uses this type for temporary files.
+
+ Mutt will only use the 'append-hook' for existing files. The 'close-hook'
+ will be used for empty, or missing files.
+
+#### Example of append-hook
+
+ append-hook '.gz$' "gzip -c '%t' >> '%f'"
+
+ * Mutt wants to append an email to a folder, "example.gz", that it opened
+ with 'open-hook'
+ * Mutt has an 'append-hook' whose regexp matches the filename: '.gz$'
+ * Mutt knows the mailbox type from the '$mbox' variable
+ * Mutt uses the command 'gzip -c' to append to an existing compressed file
+
+### Empty Files
+
+ Mutt assumes that an empty file is not compressed. In this situation, unset
+ $save_empty, so that the compressed file will be removed if you delete all
+ of the messages.
+
+### Security
+
+ Encrypted files are decrypted into temporary files which are stored in the
+ $tmpdir directory. This could be a security risk.
+
+See Also
+--------
+
+ * NeoMutt project
+ * Compile-Time Features
+ * Regular Expressions
+ * $tmpdir
+ * $mbox_type
+ * $save_empty
+ * folder-hook
+
+Known Bugs
+----------
+
+ * The Compressed Folder hooks cannot deal with filenames that contains
+ quotes/apostrophes.
+
+Credits
+-------
+
+ * Roland Rosenfeld <roland@spinnaker.de>
+ * Alain Penders <Alain@Finale-Dev.com>
+ * Christoph "Myon" Berg <myon@debian.org>
+ * Evgeni Golov <evgeni@debian.org>
+ * Richard Russon <rich@flatcap.org>
+
</para>
</listitem>
+<listitem>
+<para>
+<link linkend="append-hook"><command>append-hook</command></link>
+</para>
+</listitem>
+
<listitem>
<para>
<link linkend="charset-hook"><command>charset-hook</command></link>
</para>
</listitem>
+<listitem>
+<para>
+<link linkend="close-hook"><command>close-hook</command></link>
+</para>
+</listitem>
+
<listitem>
<para>
<link linkend="crypt-hook"><command>crypt-hook</command></link>
</para>
</listitem>
+<listitem>
+<para>
+<link linkend="open-hook"><command>open-hook</command></link>
+</para>
+</listitem>
+
<listitem>
<para>
<link linkend="reply-hook"><command>reply-hook</command></link>
</chapter>
-<sect1 id="compressedfolders">
-<title>Compressed folders Support (OPTIONAL)</title>
-
-<para>
-If Mutt was compiled with compressed folders support (by running the
-<emphasis>configure</emphasis> script with the
-<emphasis>--enable-compressed</emphasis> flag), Mutt can open folders
-stored in an arbitrary format, provided that the user has a script to
-convert from/to this format to one of the accepted.
-
-The most common use is to open compressed archived folders e.g. with
-gzip.
-
-In addition, the user can provide a script that gets a folder in an
-accepted format and appends its context to the folder in the
-user-defined format, which may be faster than converting the entire
-folder to the accepted format, appending to it and converting back to
-the user-defined format.
-
-There are three hooks defined (<link
-linkend="open-hook">open-hook</link>, <link
-linkend="close-hook">close-hook</link> and <link
-linkend="append-hook">append-hook</link>) which define commands to
-uncompress and compress a folder and to append messages to an existing
-compressed folder respectively.
-
-For example:
-
-<screen>
-open-hook \\.gz$ "gzip -cd %f > %t"
-close-hook \\.gz$ "gzip -c %t > %f"
-append-hook \\.gz$ "gzip -c %t >> %f"
-</screen>
-
-You do not have to specify all of the commands. If you omit <link
-linkend="append-hook">append-hook</link>, the folder will be open and
-closed again each time you will add to it. If you omit <link
-linkend="close-hook">close-hook</link> (or give empty command) , the
-folder will be open in the mode. If you specify <link
-linkend="append-hook">append-hook</link> though you'll be able to
-append to the folder.
-
-Note that Mutt will only try to use hooks if the file is not in one of
-the accepted formats. In particular, if the file is empty, mutt
-supposes it is not compressed. This is important because it allows the
-use of programs that do not have well defined extensions. Just use
-"." as a regexp. But this may be surprising if your
-compressing script produces empty files. In this situation, unset
-<link linkend="save-empty">$save_empty</link>, so that
-the compressed file will be removed if you delete all of the messages.
-</para>
-
-<sect2 id="open-hook">
-<title>Open a compressed mailbox for reading</title>
-
-<para>
-Usage: <literal>open-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
-
-The <emphasis>command</emphasis> is the command that can be used for
-opening the folders whose names match <emphasis>regexp</emphasis>.
-
-The <emphasis>command</emphasis> string is the printf-like format
-string, and it should accept two parameters: %f, which is
-replaced with the (compressed) folder name, and %t which is
-replaced with the name of the temporary folder to which to write.
-
-%f and %t can be repeated any number of times in the
-command string, and all of the entries are replaced with the
-appropriate folder name. In addition, %% is replaced by
-%, as in printf, and any other %anything is left as is.
-
-The <emphasis>command</emphasis> should <emphasis
-role="bold">not</emphasis> remove the original compressed file. The
-<emphasis>command</emphasis> should return non-zero exit status if it
-fails, so mutt knows something's wrong.
-
-Example:
-
-<screen>
-open-hook \\.gz$ "gzip -cd %f > %t"
-</screen>
-
-If the <emphasis>command</emphasis> is empty, this operation is
-disabled for this file type.
-</para>
-</sect2>
-
-<sect2 id="close-hook">
-<title>Write a compressed mailbox</title>
-
-<para>
-Usage: <literal>close-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
-
-This is used to close the folder that was open with the <link
-linkend="open-hook">open-hook</link> command after some changes were
-made to it.
-
-The <emphasis>command</emphasis> string is the command that can be
-used for closing the folders whose names match
-<emphasis>regexp</emphasis>. It has the same format as in the <link
-linkend="open-hook">open-hook</link> command. Temporary folder in this
-case is the folder previously produced by the <link
-linkend="open-hook">open-hook</link> command.
-
-The <emphasis>command</emphasis> should <emphasis
-role="bold">not</emphasis> remove the decompressed file. The
-<emphasis>command</emphasis> should return non-zero exit status if it
-fails, so mutt knows something's wrong.
-
-Example:
-
-<screen>
-close-hook \\.gz$ "gzip -c %t > %f"
-</screen>
-
-If the <emphasis>command</emphasis> is empty, this operation is
-disabled for this file type, and the file can only be open in the
-read-only mode.
-
-<link linkend="close-hook">close-hook</link> is not called when you
-exit from the folder if the folder was not changed.
-</para>
-</sect2>
-
-<sect2 id="append-hook">
-<title>Append a message to a compressed mailbox</title>
-
-<para>
-Usage: <literal>append-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
-
-This command is used for saving to an existing compressed folder. The
-<emphasis>command</emphasis> is the command that can be used for
-appending to the folders whose names match
-<emphasis>regexp</emphasis>. It has the same format as in the <link
-linkend="open-hook">open-hook</link> command. The temporary folder in
-this case contains the messages that are being appended.
-
-The <emphasis>command</emphasis> should <emphasis
-role="bold">not</emphasis> remove the decompressed file. The
-<emphasis>command</emphasis> should return non-zero exit status if it
-fails, so mutt knows something's wrong.
-
-Example:
-
-<screen>
-append-hook \\.gz$ "gzip -c %t >> %f"
-</screen>
-
-When <link linkend="append-hook">append-hook</link> is used, the folder
-is not opened, which saves time, but this means that we can not find
-out what the folder type is. Thus the default (<link
-linkend="mbox-type">$mbox_type</link>) type is always
-supposed (i.e. this is the format used for the temporary folder).
-
-If the file does not exist when you save to it, <link
-linkend="close-hook">close-hook</link> is called, and not <link
-linkend="append-hook">append-hook</link>. <link
-linkend="append-hook">append-hook</link> is only for appending to
-existing folders.
-
-If the <emphasis>command</emphasis> is empty, this operation is
-disabled for this file type. In this case, the folder will be open and
-closed again (using <link linkend="open-hook">open-hook</link> and
-<link linkend="close-hook">close-hook</link>respectively) each time you
-will add to it.
-</para>
-</sect2>
-
-<sect2>
-<title>Encrypted folders</title>
-
-<para>
-The compressed folders support can also be used to handle encrypted
-folders. If you want to encrypt a folder with PGP, you may want to use
-the following hooks:
-
-<screen>
-open-hook \\.pgp$ "pgp -f < %f > %t"
-close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
-</screen>
-
-Please note, that PGP does not support appending to an encrypted
-folder, so there is no append-hook defined.
-
-If you are using GnuPG instead of PGP, you may use the following hooks
-instead:
-
-<screen>
-open-hook \\.gpg$ "gpg --decrypt < %f > %t"
-close-hook \\.gpg$ "gpg --encrypt --recipient YourGpgUserIdOrKeyId < %t > %f"
-</screen>
-
-<emphasis role="bold">Note:</emphasis> the folder is temporary stored
-decrypted in the /tmp directory, where it can be read by your system
-administrator. So think about the security aspects of this.
-</para>
-</sect2>
-</sect1>
-
<chapter id="mimesupport">
<title>Mutt's MIME Support</title>
</sect1>
+<sect1 id="compress">
+ <title>Compressed Folders Patch</title>
+ <subtitle>Read from/write to compressed mailboxes</subtitle>
+
+ <sect2 id="compress-patch">
+ <title>Patch</title>
+
+ <para>
+ To check if Mutt supports <quote>Compress Folders</quote>, look for
+ <quote>+USE_COMPRESSED</quote> in the mutt version.
+ See: <xref linkend="compile-time-features"/>.
+ </para>
+
+ <itemizedlist>
+ <title>Dependencies:</title>
+ <listitem><para>mutt-1.5.24</para></listitem>
+ </itemizedlist>
+
+ <para>This patch is part of the <ulink url="https://github.com/neomutt/neomutt/wiki">NeoMutt Project</ulink>.</para>
+ </sect2>
+
+ <sect2 id="compress-intro">
+ <title>Introduction</title>
+
+ <para>
+ The Compressed Folder patch allows Mutt to read mailbox files that are
+ compressed. But it isn't limited to compressed files. It works well
+ with encrypted files, too. In fact, if you can create a program/script
+ to convert to and from your format, then Mutt can read it.
+ </para>
+
+ <para>
+ The patch adds three hooks to Mutt: <literal>open-hook</literal>,
+ <literal>close-hook</literal> and <literal>append-hook</literal>. They
+ define commands to: uncompress a file; compress a file; append
+ messages to an already compressed file.
+ </para>
+
+ <para>
+ There are some examples of both compressed and encrypted files,
+ later. For now, the documentation will just concentrate on
+ compressed files.
+ </para>
+
+ </sect2>
+
+<!--
+ <sect2 id="compress-variables">
+ <title>Variables</title>
+ <para>None</para>
+ </sect2>
+
+ <sect2 id="compress-functions">
+ <title>Functions</title>
+ <para>None</para>
+ </sect2>
+-->
+
+ <sect2 id="compress-commands">
+ <title>Commands</title>
+ <cmdsynopsis>
+ <command>open-hook</command>
+ <arg choice="plain">
+ <replaceable class="parameter">pattern</replaceable>
+ </arg>
+ <arg choice="plain">
+ <replaceable class="parameter">shell-command</replaceable>
+ </arg>
+ <command>close-hook</command>
+ <arg choice="plain">
+ <replaceable class="parameter">pattern</replaceable>
+ </arg>
+ <arg choice="plain">
+ <replaceable class="parameter">shell-command</replaceable>
+ </arg>
+ <command>append-hook</command>
+ <arg choice="plain">
+ <replaceable class="parameter">pattern</replaceable>
+ </arg>
+ <arg choice="plain">
+ <replaceable class="parameter">shell-command</replaceable>
+ </arg>
+ </cmdsynopsis>
+
+ <para>
+ The shell-command must contain two placeholders for filenames:
+ <literal>%f</literal> and <literal>%t</literal>. These represent
+ <quote>from</quote> and <quote>to</quote> filenames. It's a good idea to
+ put quotes around these placeholders.
+ </para>
+
+ <para>
+ If you need the exact string <quote>%f</quote> or <quote>%t</quote> in your
+ command, simply double up the <quote>%</quote> character, e.g.
+ <quote>%%f</quote> or <quote>%%t</quote>.
+ </para>
+
+ <table id="table-compress-optional">
+ <title>Not all Hooks are Required</title>
+ <tgroup cols="5">
+ <thead>
+ <row>
+ <entry>Open</entry>
+ <entry>Close</entry>
+ <entry>Append</entry>
+ <entry>Effect</entry>
+ <entry>Useful if</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Open</entry>
+ <entry>-</entry>
+ <entry>-</entry>
+ <entry>Folder is readonly</entry>
+ <entry>The folder is just a backup</entry>
+ </row>
+ <row>
+ <entry>Open</entry>
+ <entry>Close</entry>
+ <entry>-</entry>
+ <entry>Folder is read/write, but the entire folder must be
+ written if anything is changed</entry>
+ <entry>Your compression format doesn't support appending</entry>
+ </row>
+ <row>
+ <entry>Open</entry>
+ <entry>Close</entry>
+ <entry>Append</entry>
+ <entry>Folder is read/write and emails can be efficiently added
+ to the end</entry>
+ <entry>Your compression format supports appending</entry>
+ </row>
+ <row>
+ <entry>Open</entry>
+ <entry>-</entry>
+ <entry>Append</entry>
+ <entry>Folder is readonly, but can be appended to</entry>
+ <entry>You want to store emails, but never change them</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <note>
+ The command:
+ <itemizedlist>
+ <listitem><para>should return a non-zero exit status on failure</para></listitem>
+ <listitem><para>should not delete any files</para></listitem>
+ </itemizedlist>
+ </note>
+
+ <sect3 id="open-hook">
+ <title>Read from compressed mailbox</title>
+
+ <screen>open-hook regexp shell-command</screen>
+
+ <para>
+ If Mutt is unable to open a file, it then looks for
+ <literal>open-hook</literal> that matches the filename.
+ </para>
+
+ <para>
+ If your compression program doesn't have a well-defined extension,
+ then you can use <literal>.</literal> as the regexp.
+ </para>
+
+ <sect4 id="compress-open-hook-example">
+ <title>Example of open-hook</title>
+
+ <screen>open-hook '\.gz$' "gzip -cd '%f' > '%t'"</screen>
+
+ <itemizedlist>
+ <listitem><para>Mutt finds a file, <quote>example.gz</quote>,
+ that it can't read</para></listitem>
+ <listitem><para>Mutt has an <literal>open-hook</literal>
+ whose regexp matches the filename:
+ <literal>\.gz$</literal></para></listitem>
+ <listitem><para>Mutt uses the command <literal>gzip -cd</literal>
+ to create a temporary file that it <emphasis>can</emphasis>
+ read</para></listitem>
+ </itemizedlist>
+ </sect4>
+ </sect3>
+
+ <sect3 id="close-hook">
+ <title>Write to a compressed mailbox</title>
+
+ <screen>close-hook regexp shell-command</screen>
+
+ <para>
+ When Mutt has finished with a compressed mail folder, it will look
+ for a matching <literal>close-hook</literal> to recompress the file.
+ This hook is <link linkend="table-compress-optional">optional</link>.
+ </para>
+
+ <note>
+ If the folder has not been modifed, the
+ <literal>close-hook</literal> will not be called.
+ </note>
+
+ <sect4 id="compress-close-hook-example">
+ <title>Example of close-hook</title>
+
+ <screen>close-hook '\.gz$' "gzip -c '%t' > '%f'"</screen>
+
+ <itemizedlist>
+ <listitem><para>Mutt has finished with a folder, <quote>example.gz</quote>,
+ that it opened with <literal>open-hook</literal></para></listitem>
+ <listitem><para>The folder has been modified</para></listitem>
+ <listitem><para>Mutt has a <literal>close-hook</literal> whose regexp
+ matches the filename: <literal>\.gz$</literal></para></listitem>
+ <listitem><para>Mutt uses the command <literal>gzip -c</literal>
+ to create a new compressed file</para></listitem>
+ </itemizedlist>
+ </sect4>
+ </sect3>
+
+ <sect3 id="append-hook">
+ <title>Append to a compressed mailbox</title>
+
+ <screen>append-hook regexp shell-command</screen>
+
+ <para>
+ When Mutt wants to append an email to a compressed mail folder, it
+ will look for a matching <literal>append-hook</literal>.
+ This hook is <link linkend="table-compress-optional">optional</link>.
+ </para>
+
+ <para>
+ Using the <literal>append-hook</literal> will save time, but
+ Mutt won't be able to determine the type of the mail folder
+ inside the compressed file.
+ </para>
+
+ <para>
+ Mutt will <emphasis>assume</emphasis> the type to be that of
+ the <literal>$mbox_type</literal> variable. Mutt also uses
+ this type for temporary files.
+ </para>
+
+ <para>
+ Mutt will only use the <literal>append-hook</literal> for existing files.
+ The <literal>close-hook</literal> will be used for empty, or missing files.
+ </para>
+
+ <sect4 id="compress-append-hook-example">
+ <title>Example of append-hook</title>
+
+ <screen>append-hook '\.gz$' "gzip -c '%t' >> '%f'"</screen>
+
+ <itemizedlist>
+ <listitem><para>Mutt wants to append an email to a folder, <quote>example.gz</quote>,
+ that it opened with <literal>open-hook</literal></para></listitem>
+ <listitem><para>Mutt has an <literal>append-hook</literal> whose regexp matches
+ the filename: <literal>\.gz$</literal></para></listitem>
+ <listitem><para>Mutt knows the mailbox type from the <literal>$mbox</literal>
+ variable</para></listitem>
+ <listitem><para>Mutt uses the command <literal>gzip -c</literal>
+ to append to an existing compressed file</para></listitem>
+ </itemizedlist>
+ </sect4>
+
+ </sect3>
+
+ <sect3 id="compress-empty">
+ <title>Empty Files</title>
+
+ <para>
+ Mutt assumes that an empty file is not compressed. In this
+ situation, unset <link linkend="save-empty">$save_empty</link>, so
+ that the compressed file will be removed if you delete all of the
+ messages.
+ </para>
+ </sect3>
+
+ <sect3 id="compress-security">
+ <title>Security</title>
+
+ <para>
+ Encrypted files are decrypted into temporary files which are
+ stored in the <link linkend="tmpdir">$tmpdir</link> directory.
+ This could be a security risk.
+ </para>
+ </sect3>
+ </sect2>
+
+<!--
+ <sect2 id="compress-colors">
+ <title>Colors</title>
+ <para>None</para>
+ </sect2>
+
+ <sect2 id="compress-sort">
+ <title>Sort</title>
+ <para>None</para>
+ </sect2>
+-->
+
+ <sect2 id="compress-muttrc">
+ <title>Muttrc</title>
+<screen>
+<emphasis role="comment"># Example Mutt config file for the 'compressed folders' feature.
+
+# This feature adds three hooks to Mutt which allow it to
+# work with compressed, or encrypted, mailboxes.
+
+# The hooks are of the form:
+# open-hook regexp "shell-command"
+# close-hook regexp "shell-command"
+# append-hook regexp "shell-command"
+
+# The 'append-hook' is optional.
+
+# Hander for gzip compressed mailboxes</emphasis>
+open-hook '\.gz$' "gzip -cd '%f' > '%t'"
+close-hook '\.gz$' "gzip -c '%t' > '%f'"
+append-hook '\.gz$' "gzip -c '%t' >> '%f'"
+
+<emphasis role="comment"># Hander for bzip2 compressed mailboxes</emphasis>
+open-hook '\.bz2$' "bzip2 -cd '%f' > '%t'"
+close-hook '\.bz2$' "bzip2 -c '%t' > '%f'"
+append-hook '\.bz2$' "bzip2 -c '%t' >> '%f'"
+
+<emphasis role="comment"># Hander for xz compressed mailboxes</emphasis>
+open-hook '\.xz$' "xz -cd '%f' > '%t'"
+close-hook '\.xz$' "xz -c '%t' > '%f'"
+append-hook '\.xz$' "xz -c '%t' >> '%f'"
+
+<emphasis role="comment"># Hander for pgp encrypted mailboxes
+# PGP does not support appending to an encrypted file</emphasis>
+open-hook '\.pgp$' "pgp -f < '%f' > '%t'"
+close-hook '\.pgp$' "pgp -fe YourPgpUserIdOrKeyId < '%t' > '%f'"
+
+<emphasis role="comment"># Hander for gpg encrypted mailboxes
+# gpg does not support appending to an encrypted file</emphasis>
+open-hook '\.gpg$' "gpg --decrypt < '%f' > '%t'"
+close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' > '%f'"
+
+<emphasis role="comment"># vim: syntax=muttrc</emphasis>
+</screen>
+ </sect2>
+
+ <sect2 id="compress-see-also">
+ <title>See Also</title>
+
+ <itemizedlist>
+ <listitem><para><ulink url="https://github.com/neomutt/neomutt/wiki">NeoMutt Project</ulink></para></listitem>
+ <listitem><para><link linkend="compile-time-features">Compile-Time Features</link></para></listitem>
+ <listitem><para><link linkend="regexp">Regular Expressions</link></para></listitem>
+ <listitem><para><link linkend="tmpdir">$tmpdir</link></para></listitem>
+ <listitem><para><link linkend="mbox-type">$mbox_type</link></para></listitem>
+ <listitem><para><link linkend="save-empty">$save_empty</link></para></listitem>
+ <listitem><para><link linkend="folder-hook">folder-hook</link></para></listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="compress-known-bugs">
+ <title>Known Bugs</title>
+
+ <itemizedlist>
+ <listitem><para>The Compressed Folder hooks cannot deal with filenames that contains quotes/apostrophes.</para></listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="compress-credits">
+ <title>Credits</title>
+ <itemizedlist>
+ <listitem><para>Roland Rosenfeld <email>roland@spinnaker.de</email></para></listitem>
+ <listitem><para>Alain Penders <email>Alain@Finale-Dev.com</email></para></listitem>
+ <listitem><para>Christoph <quote>Myon</quote> Berg <email>myon@debian.org</email></para></listitem>
+ <listitem><para>Evgeni Golov <email>evgeni@debian.org</email></para></listitem>
+ <listitem><para>Richard Russon <email>rich@flatcap.org</email></para></listitem>
+ </itemizedlist>
+ </sect2>
+</sect1>
+
</chapter>
<chapter id="security">
</cmdsynopsis>
</listitem>
+<listitem>
+<cmdsynopsis>
+<command><link linkend="append-hook">append-hook</link></command>
+<arg choice="plain">
+<replaceable class="parameter">pattern</replaceable>
+</arg>
+<arg choice="plain">
+<replaceable class="parameter">shell-command</replaceable>
+</arg>
+</cmdsynopsis>
+</listitem>
+
<listitem>
<cmdsynopsis>
<command><link linkend="auto-view">auto_view</link></command>
</cmdsynopsis>
</listitem>
+<listitem>
+<cmdsynopsis>
+<command><link linkend="close-hook">close-hook</link></command>
+<arg choice="plain">
+<replaceable class="parameter">pattern</replaceable>
+</arg>
+<arg choice="plain">
+<replaceable class="parameter">shell-command</replaceable>
+</arg>
+</cmdsynopsis>
+</listitem>
+
<listitem>
<cmdsynopsis>
<command><link linkend="color">color</link></command>
</cmdsynopsis>
</listitem>
+<listitem>
+<cmdsynopsis>
+<command><link linkend="open-hook">open-hook</link></command>
+<arg choice="plain">
+<replaceable class="parameter">pattern</replaceable>
+</arg>
+<arg choice="plain">
+<replaceable class="parameter">shell-command</replaceable>
+</arg>
+</cmdsynopsis>
+</listitem>
+
<listitem>
<cmdsynopsis>
<command><link linkend="crypt-hook">crypt-hook</link></command>
projects / neomutt / commitdiff