Skip to content

Commit

Permalink
Add docs for rename flag added in afewmail#91
Browse files Browse the repository at this point in the history
Previously the documentation was silent on this flag, which is an important one
for the users who want it.
  • Loading branch information
Brighid McDonnell committed Nov 4, 2017
1 parent 87313c9 commit 6207538
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/source/move_mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Here is a full sample configuration for move mode:
[MailMover]
folders = INBOX Junk
rename = False
max_age = 15
# rules
Expand Down Expand Up @@ -77,6 +78,18 @@ in the configuration section. By providing
afew will only check mails at most 15 days old.

Rename
------

When afew moves mail files, if the the `rename` option in the configuration is
set afew will rename those files. You should probably do this if you're using
the `mbsync` program to interact with your IMAP server.

.. code-block:: ini
rename = True
Limitations
-----------

Expand All @@ -100,4 +113,3 @@ moving it? ;)
feature. If you tag a mail with two tags and there is a rule for each
of them, both rules will apply. Your mail will be copied into two
destination folders, then removed from its original location.

0 comments on commit 6207538

Please sign in to comment.