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 | |
34 | ||
c9da760a PD |
35 | def __init__(self, server, username, password): |
36 | """Creates a connection and a user session.""" | |
37 | self.mail_con = imaplib.IMAP4_SSL(server) | |
38 | result, data = self.mail_con.login(username, password) | |
39 | if(result!="OK"): | |
40 | raise UserWarning("Could not log in as user " + username + ". " + data) | |
41 | result, self.mailboxes = self.mail_con.list() | |
42 | if(result!="OK"): | |
43 | raise UserWarning("Could not retrieve mailboxes for user " + username + ".") | |
44 | ||
45 | def __del__(self): | |
46 | """Closes the connection and the user session.""" | |
47 | self.mail_con.close() | |
48 | self.mail_con.logout() | |
49 | ||
50 | def __iter__(self): | |
8301e589 | 51 | """Iterates through all mailboxes, returns (uidval,name).""" |
c9da760a | 52 | for mailbox in self.mailboxes: |
8fe4e3ff | 53 | logging.debug("Checking mailbox %s.", mailbox) |
8301e589 PD |
54 | mailbox = MAILBOX_RESP.match(mailbox.decode("utf-8")).groups() |
55 | result, data = self.mail_con.status(mailbox[2], '(UIDVALIDITY)') | |
56 | if(result!="OK"): | |
57 | raise UserWarning("Could not retrieve mailbox uidvalidity.") | |
58 | uidval = UIDVAL_RESP.match(data[0].decode("utf-8")).groups() | |
8fe4e3ff | 59 | logging.debug("Extracted mailbox info is %s %s.", data[0], uidval) |
c9da760a | 60 | self.mail_con.select(mailbox[2]) |
8301e589 | 61 | yield (mailbox[2], uidval[1]) |
c9da760a PD |
62 | |
63 | def fetch_messages(self): | |
64 | """Fetches the messages from the current mailbox, return list of uids.""" | |
65 | result, data = self.mail_con.uid('search', None, "ALL") | |
66 | if(result!="OK"): | |
67 | raise UserWarning("Could not fetch messages.") | |
c9da760a PD |
68 | mailid_list = data[0].split() |
69 | return mailid_list | |
70 | ||
71 | def fetch_internal_date(self, mid): | |
72 | """Fetches the internal date of a message, returns a time tuple.""" | |
73 | result, data = self.mail_con.uid('fetch', mid, '(INTERNALDATE)') | |
74 | if(result!="OK"): | |
75 | raise UserWarning("Could not fetch the internal date of message" + mid + ".") | |
76 | internal_date = imaplib.Internaldate2tuple(data[0]) | |
77 | return internal_date | |
78 | ||
79 | def fetch_received_date(self, mid): | |
80 | """Fetches the received date of a message, returns bytes reponse.""" | |
81 | result, data = self.mail_con.uid('fetch', mid, '(BODY.PEEK[HEADER.FIELDS (RECEIVED)])') | |
82 | if(result!="OK"): | |
83 | raise UserWarning("Could not fetch the received header of message" + mid + ".") | |
84 | return data | |
85 | ||
86 | def update_message(self, mid, mailbox, internal_date): | |
87 | """Replaces a message with one with correct internal date.""" | |
88 | internal_date_seconds = time.mktime(internal_date.timetuple()) | |
89 | internal_date_str = imaplib.Time2Internaldate(internal_date_seconds) | |
90 | result, data = self.mail_con.uid('fetch', mid, '(RFC822)') | |
91 | if(result!="OK"): | |
92 | raise UserWarning("Could not retrieve the entire e-mail" + mid + ".") | |
8fe4e3ff | 93 | #logging.debug("Entire e-mail is: %s", data[0][1]) |
c9da760a PD |
94 | |
95 | fetched_flags = self.mail_con.uid('fetch', mid, '(FLAGS)')[1][0] | |
96 | parsed_flags = imaplib.ParseFlags(fetched_flags) | |
97 | flags_str = " ".join(flag.decode("utf-8") for flag in parsed_flags) | |
98 | result, data = self.mail_con.append(mailbox, flags_str, | |
99 | internal_date_str, data[0][1]) | |
8fe4e3ff | 100 | logging.debug("Adding corrected copy of the message reponse: %s %s", result, data) |
c9da760a PD |
101 | if(result!="OK"): |
102 | raise UserWarning("Could not replace the e-mail" + mid + ".") | |
103 | else: | |
104 | result, data = self.mail_con.uid('STORE', mid, '+FLAGS', r'(\Deleted)') | |
8fe4e3ff | 105 | logging.debug("Removing old copy of the message reponse: %s %s", result, data) |
c9da760a PD |
106 | if(result!="OK"): |
107 | raise UserWarning("Could not delete the e-mail" + mid + ".") | |
108 | else: self.mail_con.expunge() | |
109 | return |