developer.intra2net.com Git - imap-restore-mail/blob - README

   1 Small tool to inject mails via IMAP
   2 that can be used to restore e-mails from account backup.
   3
   4 This program relies on the following assumptions:
   5 - IMAP hierarchy separator is / (unixhierarysep=yes)
   6 - INBOX maps to user/[username]
   7 - internal encoding of . etc. as of cyrus 2.2
   8
   9 Features:
  10 - File to mailbox option for restoring the mail folder hierarchy
  11 - Append mode - do not delete any mailboxes and messages while injecting files
  12 - Log to file and console with all actions
  13 - Output from the main function suggesting how many potential warnings
  14 during restoring are good to be reviewed by the user
  15
  16 Prerequisites:
  17 Python version 2.7 or later
  18
  19     Linux: Should be part of any modern linux distribution
  20     Windows: Get it from http://www.python.org/getit/windows/
  21
  22 Files that can be used by the program:
  23 - mboxlist.dump: Contains the stored ACL rights for each mailbox with line format:
  24     user.<owner>.<mailbox>      0 default       <username>      <acls> <usr2> <acls2> ...
  25
  26 Files that may be produced by the program:
  27 - restore_mail_inject.log: Log file. Will be truncated on script invocation.
  28 - test_file.dump: Test dump files can be produced during unit testing but are
  29 automatically removed
  30
  31 For more information please contact opensource@intra2net.com