aboutsummaryrefslogtreecommitdiffstats
path: root/archivemail.sgml
diff options
context:
space:
mode:
authorNikolaus Schulz <microschulz@web.de>2010-08-09 11:40:40 +0200
committerNikolaus Schulz <microschulz@web.de>2010-08-09 11:43:10 +0200
commit8d01846e3f88975437d217dd691cc334c3d113ec (patch)
tree9441aacbe8b0d62c7ad60f6b03d5bc9f7e3d2667 /archivemail.sgml
parentf08403c99bb651a97c9305112e0b5dc04135d90d (diff)
downloadarchivemail-8d01846e3f88975437d217dd691cc334c3d113ec.tar.gz
archivemail-8d01846e3f88975437d217dd691cc334c3d113ec.tar.bz2
archivemail-8d01846e3f88975437d217dd691cc334c3d113ec.zip
Manpage, TODO, CHANGELOG: document and record wildcard expansion in IMAP mailbox names
Diffstat (limited to 'archivemail.sgml')
-rw-r--r--archivemail.sgml19
1 files changed, 18 insertions, 1 deletions
diff --git a/archivemail.sgml b/archivemail.sgml
index 543cfc5..94f03a8 100644
--- a/archivemail.sgml
+++ b/archivemail.sgml
@@ -35,7 +35,7 @@
<RefEntry>
-<DocInfo><Date>31 July 2010</Date></DocInfo>
+<DocInfo><Date>9 August 2010</Date></DocInfo>
<RefMeta>
<RefEntryTitle>archivemail</RefEntryTitle>
@@ -97,6 +97,11 @@ mailboxes, but always writes <application/mbox/-format archives.
To archive an <application/IMAP/-format mailbox, use the format
<replaceable>imap://username:password@server/mailbox
</replaceable> to specify the mailbox.
+<application/archivemail/ will expand wildcards in <application/IMAP/ mailbox
+names according to <acronym>RFC</acronym> 3501, which says: <quote>
+The character "*" is a wildcard, and matches zero or more characters at this
+position. The character "%" is similar to "*", but it does not match a
+hierarchy delimiter.</quote>
You can omit the password from the <acronym/URL/; use the
<option>--pwfile</option> option to make <command/archivemail/ read the
password from a file, or alternatively just enter it upon request.
@@ -626,6 +631,18 @@ that are older than 90 days to compressed mailboxes in the
Note the protected quotes.
</Para>
</InformalExample>
+
+<InformalExample>
+<Para>
+ To archive all mails older than 180 days in subfolders of "foo" on the
+ given <application/IMAP/ server to corresponding archives in the current
+ working directory, reading the password from the file
+ <filename>~/imap-pass.txt</filename>:
+</Para>
+<screen>
+ <prompt>bash$ </prompt><userinput>archivemail --pwfile=~/imap-pass.txt imaps://user@example.org/foo/*</userinput>
+</screen>
+</InformalExample>
</RefSect1>
<RefSect1>