2 restore-mail-inject.py - Tool to inject mails via IMAP
4 Copyright (c) 2012 Intra2net AG
6 This program relies on the following assumptions:
7 - IMAP hierarchy separator is / (unixhierarysep=yes)
8 - INBOX maps to user/[username]
9 - internal encoding of . etc. as of cyrus 2.2
13 from mail_iterator import MailIterator
14 from file_iterator import FileIterator
15 from warnings_handler import WarningsHandler
17 LOG_FILENAME = "restore_mail_inject.log"
18 LOG_FILE_LEVEL = logging.DEBUG
19 LOG_SHELL_LEVEL = logging.INFO
20 LOG_UNCLEAN_EXIT_LEVEL = logging.WARNING
25 # prepare configuration
26 args = configure_args()
27 warnings_handler = prepare_logger()
28 logging.info("The module restore_mail_inject.py started with user %s, folder %s and source %s.",
29 args.user, args.folder, args.srcdir)
31 # connect to unix socket or server
32 if(args.unix_socket_disabled):
33 session = MailIterator(args.user)
35 session = MailIterator(args.user)
36 #session = MailIterator("/var/imap/socket/imap", "cyrus", "geheim")
37 storage = FileIterator()
39 # retrieve mailbox list from the mailbox list file
40 mailbox_list = storage.load_mailbox_list(args.mboxlistfile)
42 # delete olf IMAP folders if no append requested
44 session.delete_mailboxes(args.folder)
45 if args.folder == "INBOX":
46 session.clear_inbox_acls(args.user)
49 path_generator = storage.load_mails(args.srcdir, args.folder)
50 for message, mailbox, date_modified in path_generator:
52 # mailboxes marked for creating and acl update
53 # add acls after all subfolders or their acls will be derived from parent folder
54 for new_mailbox in storage.created_mailboxes:
55 session.create_mailbox(new_mailbox)
56 for acl_mailbox in storage.acl_mailboxes:
57 session.add_acls(acl_mailbox, mailbox_list, args.ouser, args.user)
58 storage.created_mailboxes = []
59 storage.acl_mailboxes = []
61 session.inject_message(message, mailbox, date_modified)
63 # last iteration mailboxes in case root mailbox has no e-mails for injection
64 for new_mailbox in storage.created_mailboxes:
65 session.create_mailbox(new_mailbox)
66 for acl_mailbox in storage.acl_mailboxes:
67 session.add_acls(acl_mailbox, mailbox_list, args.ouser, args.user)
69 logging.info("Finished injecting mails. Exiting with code %s.", warnings_handler.detected_problems)
70 return warnings_handler.detected_problems
73 """Configure arguments and return them."""
75 parser = argparse.ArgumentParser(description="Tool to inject mails via IMAP.")
76 parser.add_argument('-u', '--username', dest='user', action='store',
77 required=True, help='user to store mails to')
78 parser.add_argument('-f', '--foldername', dest='folder', action='store',
79 default="INBOX", help='folder to store mails to - if not specified we overwrite INBOX')
80 parser.add_argument('-s', '--sourcedir', dest='srcdir', action='store',
81 required=True, help='folder to read mail from')
82 parser.add_argument('-m', '--mboxlistfile', dest='mboxlistfile', action='store',
83 default="", help='mboxlist file (flat file format) to read the ACLs from')
84 parser.add_argument('-o', '--ouser', dest='ouser', action='store',
85 default="", help='name of the original user (=username if not specified)')
86 parser.add_argument('-a', '--append', dest='append', action='store_true',
87 default=False, help="append mails, don't delete anything")
88 parser.add_argument('-n', '--normal', dest='unix_socket_disabled', action='store_true',
89 default=False, help='disable unix socket usage for the IMAP connection')
90 args = parser.parse_args()
92 if (args.folder != "INBOX"):
93 args.folder = "INBOX/" + args.folder
94 if (args.ouser == ""):
95 args.ouser = args.user
100 """Sets up the logging functionality"""
103 with open(LOG_FILENAME, 'w'):
106 # add basic configuration
107 logging.basicConfig(filename=LOG_FILENAME,
108 format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
109 level=LOG_FILE_LEVEL)
111 # add a handler for a console output
112 default_logger = logging.getLogger('')
113 console = logging.StreamHandler()
114 console.setLevel(LOG_SHELL_LEVEL)
115 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
116 console.setFormatter(formatter)
117 default_logger.addHandler(console)
119 # add a handler for warnings counting
120 warnings_handler = WarningsHandler()
121 warnings_handler.setLevel(LOG_UNCLEAN_EXIT_LEVEL)
122 default_logger.addHandler(warnings_handler)
123 return warnings_handler
125 if __name__ == "__main__":