1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
"""
This file is part of alot.
Alot is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
Alot is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with notmuch. If not, see <http://www.gnu.org/licenses/>.
Copyright (C) 2011 Patrick Totzke <patricktotzke@gmail.com>
"""
import os
import email
import tempfile
import re
import mimetypes
from datetime import datetime
from email.header import Header
import helper
from settings import get_mime_handler
class Message:
def __init__(self, dbman, msg, thread=None):
"""
:param dbman: db manager that is used for further lookups
:type dbman: alot.db.DBManager
:param msg: the wrapped message
:type msg: notmuch.database.Message
:param thread: this messages thread
:type thread: alot.db.thread
"""
self._dbman = dbman
self._id = msg.get_message_id()
self._thread_id = msg.get_thread_id()
self._thread = thread
self._datetime = datetime.fromtimestamp(msg.get_date())
self._filename = msg.get_filename()
# TODO: change api to return unicode
self._from = msg.get_header('From')
self._email = None # will be read upon first use
self._attachments = None # will be read upon first use
self._tags = set(msg.get_tags())
def __str__(self):
"""prettyprint the message"""
aname, aaddress = self.get_author()
if not aname:
aname = aaddress
#tags = ','.join(self.get_tags())
return "%s (%s)" % (aname, self.get_datestring())
def __hash__(self):
"""Implement hash(), so we can use Message() sets"""
return hash(self._id)
def __cmp__(self, other):
"""Implement cmp(), so we can compare Message()s"""
res = cmp(self.get_message_id(), other.get_message_id())
return res
def get_email(self):
"""returns email.Message representing this message"""
if not self._email:
f_mail = open(self.get_filename())
self._email = email.message_from_file(f_mail)
f_mail.close()
return self._email
def get_date(self):
"""returns date as datetime obj"""
return self._datetime
def get_filename(self):
"""returns absolute path of messages location"""
return self._filename
def get_message_id(self):
"""returns messages id (a string)"""
return self._id
def get_thread_id(self):
"""returns id of messages thread (a string)"""
return self._thread_id
def get_message_parts(self):
"""returns a list of all body parts of this message"""
out = []
for msg in self.get_email().walk():
if not msg.is_multipart():
out.append(msg)
return out
def get_tags(self):
"""returns tags attached to this message as list of strings"""
l = list(self._tags)
l.sort()
return l
def get_thread(self):
"""returns the thread this msg belongs to as alot.db.Thread object"""
if not self._thread:
self._thread = self._dbman.get_thread(self._thread_id)
return self._thread
def get_replies(self):
"""returns a list of replies to this msg"""
t = self.get_thread()
return t.get_replies_to(self)
def get_datestring(self, pretty=True):
"""returns formated datestring in sup-style, eg: 'Yest.3pm'"""
return helper.pretty_datetime(self._datetime)
def get_author(self):
"""returns realname and address pair of this messages author"""
return email.Utils.parseaddr(self._from)
def add_tags(self, tags):
"""adds tags to message
:param tags: tags to add
:type tags: list of str
"""
self._dbman.tag('id:' + self._id, tags)
self._tags = self._tags.union(tags)
def remove_tags(self, tags):
"""remove tags from message
:param tags: tags to remove
:type tags: list of str
"""
self._dbman.untag('id:' + self._id, tags)
self._tags = self._tags.difference(tags)
def get_attachments(self):
if not self._attachments:
self._attachments = []
for part in self.get_message_parts():
if part.get_content_maintype() != 'text':
self._attachments.append(Attachment(part))
return self._attachments
def accumulate_body(self):
return extract_body(self.get_email())
def matches(self, querystring):
searchfor = querystring + ' AND id:' + self._id
return self._dbman.count_messages(searchfor) > 0
def get_text_content(self):
res = ''
for part in self.get_email().walk():
ctype = part.get_content_type()
enc = part.get_content_charset()
if part.get_content_maintype() == 'text':
raw_payload = part.get_payload(decode=True)
if enc:
raw_payload = raw_payload.decode(enc, errors='replace')
else:
raw_payload = unicode(raw_payload, errors='replace')
res += raw_payload
return res
def extract_body(mail):
bodytxt = ''
for part in mail.walk():
ctype = part.get_content_type()
enc = part.get_content_charset()
raw_payload = part.get_payload(decode=True)
if part.get_content_maintype() == 'text':
if enc:
raw_payload = unicode(raw_payload, enc)
else:
raw_payload = unicode(raw_payload, errors='replace')
if ctype == 'text/plain':
bodytxt += raw_payload
else:
#get mime handler
handler = get_mime_handler(ctype, key='view',
interactive=False)
if handler:
#open tempfile. Not all handlers accept stuff from stdin
tmpfile = tempfile.NamedTemporaryFile(delete=False,
suffix='.html')
#write payload to tmpfile
if part.get_content_maintype() == 'text':
tmpfile.write(raw_payload.encode('utf8'))
else:
tmpfile.write(raw_payload)
#create and call external command
cmd = handler % tmpfile.name
rendered_payload = helper.cmd_output(cmd)
#remove tempfile
tmpfile.close()
os.unlink(tmpfile.name)
if rendered_payload: # handler had output
bodytxt += unicode(rendered_payload.strip(),
encoding='utf8', errors='replace')
elif part.get_content_maintype() == 'text':
bodytxt += raw_payload
# else drop
return bodytxt
def decode_to_unicode(part):
enc = part.get_content_charset()
raw_payload = part.get_payload(decode=True)
if enc:
raw_payload = unicode(raw_payload, enc)
else:
raw_payload = unicode(raw_payload, errors='replace')
return raw_payload
def decode_header(header):
valuelist = email.header.decode_header(header)
value = u''
for v, enc in valuelist:
if enc:
value = value + v.decode(enc)
else:
value = value + v
value = value.replace('\r', '')
value = value.replace('\n', ' ')
return value
def encode_header(key, value):
if key.lower() in ['from', 'to', 'cc', 'bcc']:
rawentries = value.split(',')
encodedentries = []
for entry in rawentries:
m = re.search('\s*(.*)\s+<(.*\@.*\.\w*)>$', entry)
if m:
name, address = m.groups()
header = Header(name + ' ', 'utf-8')
header.append('<%s>' % address, charset='ascii')
encodedentries.append(header.encode())
else:
encodedentries.append(entry.encode('ascii', errors='replace'))
value = Header(','.join(encodedentries))
elif key.lower() == 'subject':
value = Header(value, 'UTF-8')
else:
value = Header(value.encode('ascii', errors='replace'))
return value
class Attachment:
"""represents a single mail attachment"""
def __init__(self, emailpart):
"""
:param emailpart: a non-multipart email that is the attachment
:type emailpart: email.message.Message
"""
self.part = emailpart
def __str__(self):
return '%s:%s (%s)' % (self.get_content_type(),
self.get_filename(),
self.get_size())
def get_filename(self):
"""return the filename, extracted from content-disposition header"""
return self.part.get_filename()
def get_content_type(self):
"""mime type of the attachment"""
ctype = self.part.get_content_type()
if ctype == 'octet/stream' and self.get_filename():
ctype, enc = mimetypes.guess_type(self.get_filename())
return ctype
def get_size(self):
"""returns attachments size as human-readable string"""
size_in_kbyte = len(self.part.get_payload()) / 1024
if size_in_kbyte > 1024:
return "%.1fM" % (size_in_kbyte / 1024.0)
else:
return "%dK" % size_in_kbyte
def save(self, path):
"""save the attachment to disk. Uses self.get_filename
in case path is a directory"""
if self.get_filename() and os.path.isdir(path):
path = os.path.join(path, self.get_filename())
FILE = open(path, "w")
else:
FILE = tempfile.NamedTemporaryFile(delete=False)
FILE.write(self.part.get_payload(decode=True))
FILE.close()
return FILE.name
|