Commit | Line | Data |
---|---|---|
c9da760a PD |
1 | ''' |
2 | mail_iterator.py - The module contains the MailIterator class. | |
3 | ||
4 | Copyright (c) 2012 Intra2net AG | |
5 | Author: Plamen Dimitrov | |
6 | ||
7 | This program is free software: you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation, either version 3 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
c9da760a PD |
16 | ''' |
17 | ||
18 | import imaplib | |
19 | import re | |
20 | import time | |
8fe4e3ff | 21 | import logging |
c9da760a | 22 | |
8301e589 PD |
23 | MAILBOX_RESP = re.compile(r'\((?P<flags>.*?)\) "(?P<delimiter>.*)" (?P<name>.*)') |
24 | UIDVAL_RESP = re.compile(r'(?P<name>.*) \(UIDVALIDITY (?P<uidval>.*)\)') | |
c9da760a PD |
25 | |
26 | class MailIterator: | |
27 | """This class communicates with the e-mail server.""" | |
c9da760a | 28 | |
7a1d4c35 PD |
29 | # class attributes |
30 | # IMAP4_SSL for connection with an IMAP server | |
31 | mail_con = None | |
32 | # list of tuples (uidvalidity, mailboxname) for the retrieved mailboxes | |
33 | mailboxes = None | |
97bd6bea PD |
34 | # logged in status |
35 | logged_in = None | |
7a1d4c35 | 36 | |
c9da760a PD |
37 | def __init__(self, server, username, password): |
38 | """Creates a connection and a user session.""" | |
97bd6bea PD |
39 | try: |
40 | self.mail_con = imaplib.IMAP4_SSL(server) | |
41 | self.mail_con.login(username, password) | |
42 | logging.info("Logged in as %s.", username) | |
43 | except: | |
44 | self.logged_in = False | |
45 | raise UserWarning("Could not log in as user " + username + ".") | |
46 | self.logged_in = True | |
c9da760a PD |
47 | result, self.mailboxes = self.mail_con.list() |
48 | if(result!="OK"): | |
49 | raise UserWarning("Could not retrieve mailboxes for user " + username + ".") | |
50 | ||
51 | def __del__(self): | |
52 | """Closes the connection and the user session.""" | |
97bd6bea PD |
53 | if(self.logged_in): |
54 | self.mail_con.close() | |
55 | self.mail_con.logout() | |
c9da760a PD |
56 | |
57 | def __iter__(self): | |
8301e589 | 58 | """Iterates through all mailboxes, returns (uidval,name).""" |
c9da760a | 59 | for mailbox in self.mailboxes: |
8fe4e3ff | 60 | logging.debug("Checking mailbox %s.", mailbox) |
8a9d4c89 | 61 | mailbox = MAILBOX_RESP.match(mailbox.decode('iso-8859-1')).groups() |
8301e589 PD |
62 | result, data = self.mail_con.status(mailbox[2], '(UIDVALIDITY)') |
63 | if(result!="OK"): | |
64 | raise UserWarning("Could not retrieve mailbox uidvalidity.") | |
8a9d4c89 | 65 | uidval = UIDVAL_RESP.match(data[0].decode('iso-8859-1')).groups() |
8fe4e3ff | 66 | logging.debug("Extracted mailbox info is %s %s.", data[0], uidval) |
c9da760a | 67 | self.mail_con.select(mailbox[2]) |
8301e589 | 68 | yield (mailbox[2], uidval[1]) |
c9da760a PD |
69 | |
70 | def fetch_messages(self): | |
71 | """Fetches the messages from the current mailbox, return list of uids.""" | |
72 | result, data = self.mail_con.uid('search', None, "ALL") | |
73 | if(result!="OK"): | |
74 | raise UserWarning("Could not fetch messages.") | |
c9da760a PD |
75 | mailid_list = data[0].split() |
76 | return mailid_list | |
77 | ||
78 | def fetch_internal_date(self, mid): | |
79 | """Fetches the internal date of a message, returns a time tuple.""" | |
80 | result, data = self.mail_con.uid('fetch', mid, '(INTERNALDATE)') | |
81 | if(result!="OK"): | |
82 | raise UserWarning("Could not fetch the internal date of message" + mid + ".") | |
83 | internal_date = imaplib.Internaldate2tuple(data[0]) | |
84 | return internal_date | |
85 | ||
86 | def fetch_received_date(self, mid): | |
87 | """Fetches the received date of a message, returns bytes reponse.""" | |
88 | result, data = self.mail_con.uid('fetch', mid, '(BODY.PEEK[HEADER.FIELDS (RECEIVED)])') | |
89 | if(result!="OK"): | |
90 | raise UserWarning("Could not fetch the received header of message" + mid + ".") | |
8a9d4c89 | 91 | return data[0][1].decode('iso-8859-1') |
c9da760a PD |
92 | |
93 | def update_message(self, mid, mailbox, internal_date): | |
94 | """Replaces a message with one with correct internal date.""" | |
95 | internal_date_seconds = time.mktime(internal_date.timetuple()) | |
96 | internal_date_str = imaplib.Time2Internaldate(internal_date_seconds) | |
97 | result, data = self.mail_con.uid('fetch', mid, '(RFC822)') | |
98 | if(result!="OK"): | |
99 | raise UserWarning("Could not retrieve the entire e-mail" + mid + ".") | |
8fe4e3ff | 100 | #logging.debug("Entire e-mail is: %s", data[0][1]) |
c9da760a PD |
101 | |
102 | fetched_flags = self.mail_con.uid('fetch', mid, '(FLAGS)')[1][0] | |
103 | parsed_flags = imaplib.ParseFlags(fetched_flags) | |
8a9d4c89 | 104 | flags_str = " ".join(flag.decode('iso-8859-1') for flag in parsed_flags) |
c9da760a PD |
105 | result, data = self.mail_con.append(mailbox, flags_str, |
106 | internal_date_str, data[0][1]) | |
8fe4e3ff | 107 | logging.debug("Adding corrected copy of the message reponse: %s %s", result, data) |
c9da760a PD |
108 | if(result!="OK"): |
109 | raise UserWarning("Could not replace the e-mail" + mid + ".") | |
110 | else: | |
111 | result, data = self.mail_con.uid('STORE', mid, '+FLAGS', r'(\Deleted)') | |
8fe4e3ff | 112 | logging.debug("Removing old copy of the message reponse: %s %s", result, data) |
c9da760a PD |
113 | if(result!="OK"): |
114 | raise UserWarning("Could not delete the e-mail" + mid + ".") | |
115 | else: self.mail_con.expunge() | |
116 | return |