2 restore-mail-inject.py - Tool to inject mails via IMAP
4 Copyright (c) 2012 Intra2net AG
11 MAIL_FILENAME = re.compile("^[0-9]+\.$")
12 MBOXFILE_LINE = re.compile("^(.*?)\t(?:\d )?default[\t ](.*)$")
13 ACL_STRING = re.compile("^(.*?)[\t ](.*?)\t(.*)$")
16 """This class iterates through the e-mail files."""
19 # mailboxes created during file traversal
20 created_mailboxes = None
21 # mailboxes to update during file traversal
25 """Creates a connection and a user session."""
27 self.created_mailboxes = []
28 self.acl_mailboxes = []
33 def _message_read(cls, filename):
34 """Retrieves a message from the message file."""
37 with open(filename, "r") as msgfile:
38 message = msgfile.read()
40 logging.warning("Could not open the e-mail file %s", filename)
46 def load_mailbox_list(cls, mboxlistfile = ""):
47 """Load the list of mailboxes and acl rights for each from file."""
50 if mboxlistfile != "":
52 with open(mboxlistfile, 'r') as acl_file:
55 linedata = MBOXFILE_LINE.match(line).groups()
56 if len(linedata) == 0:
57 logging.warning("Illegal line in mailbox list dump: %s", line)
62 # loop through acl rights string and build dictionary of users and rights
64 acldata = ACL_STRING.match(aclstr).groups()
66 logging.error("Illegal acl string in mailbox list dump: %s", line)
69 acls[acldata[0]] = acldata[1]
73 logging.warning("Could not open mboxlist file %s", mboxlistfile)
77 def load_mails(self, filepath, mailpath):
78 """Loads all e-mails from file hierarchy.
79 This recursive generator always returns a tuple of
80 the next found (e-mail, mailbox to store, internaldate)."""
82 logging.debug("Entered directory %s -> %s", filepath, mailpath)
84 filepath = os.path.abspath(filepath)
87 logging.warning("Can't open the directory %s", filepath)
89 # mark mailboxes that should be created
90 self.created_mailboxes.append(mailpath)
91 subpaths = os.listdir(filepath)
92 for subpath in subpaths:
93 if subpath == "." or subpath == "..":
95 new_filepath = filepath + "/" + subpath
96 if (os.path.isfile(new_filepath)):
97 if os.path.getsize(new_filepath) == 0:
98 logging.info("Skipping empty file %s", subpath)
100 if MAIL_FILENAME.match(subpath):
101 logging.info("Injecting file %s", subpath)
103 message = self._message_read(new_filepath)
104 # suggest file modification date for internaldate
105 yield (message, mailpath, os.path.getmtime(new_filepath))
107 logging.warning("Could not retrieve mail from the file %s", new_filepath)
109 if os.path.isdir(new_filepath):
110 # cyrus ^ vs . storage replacement
111 subpath = subpath.replace("^", ".")
112 new_mailpath = mailpath + "/" + subpath
113 logging.debug("Inserting mails from directory %s into mailbox %s", new_filepath, new_mailpath)
114 # load_mails($mboxdbref, $origuser, $targetuser)
115 rcrs_generator = self.load_mails(new_filepath, new_mailpath)
116 # you enter the generator in the for loop
117 for rcr in rcrs_generator:
119 logging.debug("Done with directory %s and mailbox %s", new_filepath, new_mailpath)
120 # mark mailboxes that need acl update
121 self.acl_mailboxes.append(mailpath)