17
17
"""A convenience class around smtplib."""
19
from __future__ import absolute_import
22
from email.utils import getaddresses, parseaddr
23
except ImportError: # python < 3
24
from email.Utils import getaddresses, parseaddr
19
from email import Utils
28
from bzrlib.errors import (
31
DefaultSMTPConnectionRefused,
32
SMTPConnectionRefused,
40
smtp_password = config.Option('smtp_password', default=None,
42
Password to use for authentication to SMTP server.
44
smtp_server = config.Option('smtp_server', default=None,
46
Hostname of the SMTP server to use for sending email.
48
smtp_username = config.Option('smtp_username', default=None,
50
Username to use for authentication to SMTP server.
54
class SMTPError(BzrError):
56
_fmt = "SMTP error: %(error)s"
58
def __init__(self, error):
62
class SMTPConnectionRefused(SMTPError):
64
_fmt = "SMTP connection to %(host)s refused"
66
def __init__(self, error, host):
71
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
73
_fmt = "Please specify smtp_server. No server at default %(host)s."
76
class NoDestinationAddress(InternalBzrError):
78
_fmt = "Message does not have a destination address."
81
36
class SMTPConnection(object):
82
37
"""Connect to an SMTP server and send an email.
84
This is a gateway between breezy.config.Config and smtplib.SMTP. It
39
This is a gateway between bzrlib.config.Config and smtplib.SMTP. It
85
40
understands the basic bzr SMTP configuration information: smtp_server,
86
41
smtp_username, and smtp_password.
93
48
if self._smtp_factory is None:
94
49
self._smtp_factory = smtplib.SMTP
95
50
self._config = config
96
self._config_smtp_server = config.get('smtp_server')
51
self._config_smtp_server = config.get_user_option('smtp_server')
97
52
self._smtp_server = self._config_smtp_server
98
53
if self._smtp_server is None:
99
54
self._smtp_server = self._default_smtp_server
101
self._smtp_username = config.get('smtp_username')
102
self._smtp_password = config.get('smtp_password')
56
self._smtp_username = config.get_user_option('smtp_username')
57
self._smtp_password = config.get_user_option('smtp_password')
104
59
self._connection = None
111
66
self._create_connection()
112
67
# FIXME: _authenticate() should only be called when the server has
113
# refused unauthenticated access, so it can safely try to authenticate
68
# refused unauthenticated access, so it can safely try to authenticate
114
69
# with the default username. JRV20090407
115
70
self._authenticate()
119
74
self._connection = self._smtp_factory()
121
76
self._connection.connect(self._smtp_server)
122
except socket.error as e:
77
except socket.error, e:
123
78
if e.args[0] == errno.ECONNREFUSED:
124
79
if self._config_smtp_server is None:
125
80
raise DefaultSMTPConnectionRefused(socket.error,
141
96
if self._connection.has_extn("starttls"):
142
97
code, resp = self._connection.starttls()
143
98
if not (200 <= code <= 299):
144
raise SMTPError("server refused STARTTLS: %d %s" %
99
raise SMTPError("server refused STARTTLS: %d %s" % (code, resp))
146
100
# Say EHLO again, to check for newly revealed features
147
101
code, resp = self._connection.ehlo()
148
102
if not (200 <= code <= 299):
153
107
auth = config.AuthenticationConfig()
154
108
if self._smtp_username is None:
155
109
# FIXME: Since _authenticate gets called even when no authentication
156
# is necessary, it's not possible to use the default username
110
# is necessary, it's not possible to use the default username
158
112
self._smtp_username = auth.get_user('smtp', self._smtp_server)
159
113
if self._smtp_username is None:
177
131
"""Get the origin and destination addresses of a message.
179
133
:param message: A message object supporting get() to access its
180
headers, like email.message.Message or
181
breezy.email_message.EmailMessage.
134
headers, like email.Message or bzrlib.email_message.EmailMessage.
182
135
:return: A pair (from_email, to_emails), where from_email is the email
183
136
address in the From header, and to_emails a list of all the
184
137
addresses in the To, Cc, and Bcc headers.
186
from_email = parseaddr(message.get('From', None))[1]
139
from_email = Utils.parseaddr(message.get('From', None))[1]
187
140
to_full_addresses = []
188
141
for header in ['To', 'Cc', 'Bcc']:
189
142
value = message.get(header, None)
191
144
to_full_addresses.append(value)
192
to_emails = [pair[1] for pair in
193
getaddresses(to_full_addresses)]
145
to_emails = [ pair[1] for pair in
146
Utils.getaddresses(to_full_addresses) ]
195
148
return from_email, to_emails
200
153
The message will be sent to all addresses in the To, Cc and Bcc
203
:param message: An email.message.Message or
204
email.mime.multipart.MIMEMultipart object.
156
:param message: An email.Message or email.MIMEMultipart object.
207
159
from_email, to_emails = self.get_message_addresses(message)
214
166
self._connection.sendmail(from_email, to_emails,
215
167
message.as_string())
216
except smtplib.SMTPRecipientsRefused as e:
168
except smtplib.SMTPRecipientsRefused, e:
217
169
raise SMTPError('server refused recipient: %d %s' %
218
next(iter(e.recipients.values())))
219
except smtplib.SMTPResponseException as e:
170
e.recipients.values()[0])
171
except smtplib.SMTPResponseException, e:
220
172
raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
221
except smtplib.SMTPException as e:
173
except smtplib.SMTPException, e:
222
174
raise SMTPError(str(e))