Basic acl functionality added

[imap-restore-mail] / mail_iterator.py

'''
restore-mail-inject.py - Tool to inject mails via IMAP

Copyright (c) 2012 Intra2net AG
'''

import imaplib
import re

MAILBOX_RESP = re.compile(r'\((?P<flags>.*?)\) "(?P<delimiter>.*)" (?P<name>.*)')
UIDVAL_RESP = re.compile(r'(?P<name>.*) \(UIDVALIDITY (?P<uidval>.*)\)')

class MailIterator:
    """This class communicates with the e-mail server."""

    # class attributes
    # IMAP4_SSL for connection with an IMAP server
    mail_con = None
    # list of tuples (uidvalidity, mailboxname) for the retrieved mailboxes
    mailboxes = None
    # logged in status
    logged_in = None

    def __init__(self, server, username, password):
        """Creates a connection and a user session."""
        # authentication
        try:
            self.mail_con = imaplib.IMAP4_SSL(server)
            self.mail_con.login(username, password)
            print("Logged in as %s." % username)
        except:
            self.logged_in = False
            print("Could not log in as user " + username + ".")
            raise UserWarning
        self.logged_in = True

        # prepare mailboxes
        _result, mailboxes = self.mail_con.list()
        self.mailboxes = []
        for mailbox in mailboxes:
            mailbox = MAILBOX_RESP.match(mailbox.decode('iso-8859-1')).groups()
            self.mailboxes.append(mailbox)
        self.mailboxes = sorted(self.mailboxes, key=lambda box: box[2], reverse=True)
        return

    def __del__(self):
        """Closes the connection and the user session."""
        if self.logged_in:
            try:
                self.mail_con.close()
                self.mail_con.logout()
            except:
                pass

    def clear_inbox_acls(self, user):
        """Resets the inbox acls for each user."""
        try:
            hashref = self.mail_con.getacl("INBOX")
        except:
            print("Could not get the acls of INBOX.")
        print(hashref)
        for acluser in hashref:
            if acluser != user:
                try:
                    #print(self.mail_con.setacl("INBOX", acluser, ""))
                    print("Reset acls on INBOX for user %s" % acluser)
                except:
                    print("Could not reset acls on INBOX for user %s" % acluser)
        return

    def add_acls(self, mailbox, mailbox_list, original_user, target_user):
        """Add acls to mailbox."""
        
        # change encoding to internal cyrus format and make folder absolute
        mailbox = mailbox.replace("INBOX/", "user/" + original_user + "/")
        mailbox = mailbox.replace(".", "^")
        mailbox = mailbox.replace("/", ".")
    
        lookfor = mailbox
        for current_folder in mailbox_list:
            # find folder to set all acls
            if current_folder[0] == lookfor:
                acl_listref = current_folder[1]
                for aclref in acl_listref:
                    print(aclref[0], target_user, original_user)
                    if aclref[0] != target_user and aclref[0] != original_user:
                        try:
                            #self.mail_con.setacl(mailbox, thisaclref[0], thisaclref[1])
                            print("Set acls %s for user %s on mailbox %s." % (aclref[1], aclref[0], mailbox))
                        except:
                            print("Could not set acls %s for user %s on mailbox %s." % (aclref[1], aclref[0], mailbox))    
                break

        return

    def delete_mailboxes(self, deleted_mailbox):
        """Delete specified mailbox or empty inbox."""
        for mailbox in self.mailboxes:
            pattern = '^\"?' + deleted_mailbox
            # if INBOX it cannot be deleted so add delimiter
            if (deleted_mailbox == "INBOX"):
                pattern += mailbox[1]
            if re.compile(pattern).match(mailbox[2]):
                result, data = self.mail_con.delete(mailbox[2])
                if result == "OK":
                    print("Deleted mailbox %s" % mailbox[2])
                else:
                    print("Could not delete folder %s: %s" % (mailbox[2], data[0]))         
        return

    def create_mailbox(self, mailbox):
        """Create new mailbox to inject messages."""
        if mailbox != "INBOX":
            result, data = self.mail_con.create(mailbox)
            if result == "OK":
                print("Creating mailbox %s" % mailbox)
            else:
                print("Could not create mailbox %s: %s" % (mailbox, data[0]))
        return

    def inject_message(self, message, mailbox, internal_date):
        """Inject a message into a mailbox."""
        
        #$imap->append_file($folder, $full_path, undef, "\\Seen", true)
        try:
            result, data = self.mail_con.append(mailbox, "\\Seen",
                                                internal_date, message)
            print("Appending message to mailbox %s" % mailbox)
        except:
            raise UserWarning("Could not append the e-mail." % message)
        return