Skip to content

Commit

Permalink
Merge branch 'brighid/docs/rename-flag'
Browse files Browse the repository at this point in the history
closes #166
  • Loading branch information
flokli committed Nov 7, 2017
2 parents 87313c9 + 72099de commit 27237fd
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 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,26 @@ in the configuration section. By providing
afew will only check mails at most 15 days old.

Rename
------

Set this option if you are using the `mbsync` IMAP syncing tool.
`mbsync` adds a unique identifier to files' names when it syncs them.
If the `rename` option is not set, moving files can cause UID conflicts
and prevent `mbsync` from syncing with error messages such as
"Maildir error: duplicate UID 1234" or "UID 567 is beyond highest assigned UID 89".

When the option is set, afew will rename files while moving them,
removing the UID but preserving other `mbsync` information.
This allows `mbsync` to assign a new UID to the file and avoid UID conflicts.

If you are using `offlineimap`, you can safely ignore this option.

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

Expand All @@ -100,4 +121,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 27237fd

Please sign in to comment.