Modules now in 'src' folder, COPYING and README added

[imap-restore-mail] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..6772052
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+Small tool to inject mails via IMAP
+that can be used to restore e-mails from account backup.
+
+This program relies on the following assumptions:
+- IMAP hierarchy separator is / (unixhierarysep=yes)
+- INBOX maps to user/[username]
+- internal encoding of . etc. as of cyrus 2.2
+
+Features:
+- File to mailbox option for restoring the mail folder hierarchy
+- Append mode - do not delete any mailboxes and messages while injecting files
+- Log to file and console with all actions
+- Output from the main function suggesting how many potential warnings
+during restoring are good to be reviewed by the user
+
+Prerequisites:
+Python version 2.7 or later
+
+    Linux: Should be part of any modern linux distribution
+    Windows: Get it from http://www.python.org/getit/windows/
+
+Files that can be used by the program:
+- mboxlist.dump: Contains the stored ACL rights for each mailbox with line format:
+    user.<owner>.<mailbox>     0 default       <username>      <acls> <usr2> <acls2> ...
+
+Files that may be produced by the program:
+- restore_mail_inject.log: Log file. Will be truncated on script invocation.
+- test_file.dump: Test dump files can be produced during unit testing but are
+automatically removed
+
+For more information please contact opensource@intra2net.com