1
# Copyright (C) 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""A convenience class around smtplib."""
19
from email import Utils
28
from bzrlib.errors import (
31
DefaultSMTPConnectionRefused,
32
SMTPConnectionRefused,
36
class SMTPConnection(object):
37
"""Connect to an SMTP server and send an email.
39
This is a gateway between bzrlib.config.Config and smtplib.SMTP. It
40
understands the basic bzr SMTP configuration information: smtp_server,
41
smtp_username, and smtp_password.
44
_default_smtp_server = 'localhost'
46
def __init__(self, config, _smtp_factory=None):
47
self._smtp_factory = _smtp_factory
48
if self._smtp_factory is None:
49
self._smtp_factory = smtplib.SMTP
51
self._config_smtp_server = config.get_user_option('smtp_server')
52
self._smtp_server = self._config_smtp_server
53
if self._smtp_server is None:
54
self._smtp_server = self._default_smtp_server
56
self._smtp_username = config.get_user_option('smtp_username')
57
self._smtp_password = config.get_user_option('smtp_password')
59
self._connection = None
62
"""If we haven't connected, connect and authenticate."""
63
if self._connection is not None:
66
self._create_connection()
69
def _create_connection(self):
70
"""Create an SMTP connection."""
71
self._connection = self._smtp_factory()
73
self._connection.connect(self._smtp_server)
74
except socket.error, e:
75
if e.args[0] == errno.ECONNREFUSED:
76
if self._config_smtp_server is None:
77
raise DefaultSMTPConnectionRefused(socket.error,
80
raise SMTPConnectionRefused(socket.error,
85
# Say EHLO (falling back to HELO) to query the server's features.
86
code, resp = self._connection.ehlo()
87
if not (200 <= code <= 299):
88
code, resp = self._connection.helo()
89
if not (200 <= code <= 299):
90
raise SMTPError("server refused HELO: %d %s" % (code, resp))
92
# Use TLS if the server advertised it:
93
if self._connection.has_extn("starttls"):
94
code, resp = self._connection.starttls()
95
if not (200 <= code <= 299):
96
raise SMTPError("server refused STARTTLS: %d %s" % (code, resp))
97
# Say EHLO again, to check for newly revealed features
98
code, resp = self._connection.ehlo()
99
if not (200 <= code <= 299):
100
raise SMTPError("server refused EHLO: %d %s" % (code, resp))
102
def _authenticate(self):
103
"""If necessary authenticate yourself to the server."""
104
auth = config.AuthenticationConfig()
105
if self._smtp_username is None:
106
self._smtp_username = auth.get_user('smtp', self._smtp_server)
107
if self._smtp_username is None:
110
if self._smtp_password is None:
111
self._smtp_password = auth.get_password(
112
'smtp', self._smtp_server, self._smtp_username)
114
self._connection.login(self._smtp_username, self._smtp_password)
117
def get_message_addresses(message):
118
"""Get the origin and destination addresses of a message.
120
:param message: A message object supporting get() to access its
121
headers, like email.Message or bzrlib.email_message.EmailMessage.
122
:return: A pair (from_email, to_emails), where from_email is the email
123
address in the From header, and to_emails a list of all the
124
addresses in the To, Cc, and Bcc headers.
126
from_email = Utils.parseaddr(message.get('From', None))[1]
127
to_full_addresses = []
128
for header in ['To', 'Cc', 'Bcc']:
129
value = message.get(header, None)
131
to_full_addresses.append(value)
132
to_emails = [ pair[1] for pair in
133
Utils.getaddresses(to_full_addresses) ]
135
return from_email, to_emails
137
def send_email(self, message):
138
"""Send an email message.
140
The message will be sent to all addresses in the To, Cc and Bcc
143
:param message: An email.Message or email.MIMEMultipart object.
146
from_email, to_emails = self.get_message_addresses(message)
149
raise NoDestinationAddress
153
self._connection.sendmail(from_email, to_emails,
155
except smtplib.SMTPRecipientsRefused, e:
156
raise SMTPError('server refused recipient: %d %s' %
157
e.recipients.values()[0])
158
except smtplib.SMTPResponseException, e:
159
raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
160
except smtplib.SMTPException, e:
161
raise SMTPError(str(e))
added
removed
bzrlib/smtp_connection.py
