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
25
from bzrlib.errors import (
28
DefaultSMTPConnectionRefused,
29
SMTPConnectionRefused,
33
class SMTPConnection(object):
34
"""Connect to an SMTP server and send an email.
36
This is a gateway between bzrlib.config.Config and smtplib.SMTP. It
37
understands the basic bzr SMTP configuration information: smtp_server,
38
smtp_username, and smtp_password.
41
_default_smtp_server = 'localhost'
43
def __init__(self, config, _smtp_factory=None):
44
self._smtp_factory = _smtp_factory
45
if self._smtp_factory is None:
46
self._smtp_factory = smtplib.SMTP
48
self._config_smtp_server = config.get_user_option('smtp_server')
49
self._smtp_server = self._config_smtp_server
50
if self._smtp_server is None:
51
self._smtp_server = self._default_smtp_server
53
self._smtp_username = config.get_user_option('smtp_username')
54
self._smtp_password = config.get_user_option('smtp_password')
56
self._connection = None
59
"""If we haven't connected, connect and authenticate."""
60
if self._connection is not None:
63
self._create_connection()
66
def _create_connection(self):
67
"""Create an SMTP connection."""
68
self._connection = self._smtp_factory()
70
self._connection.connect(self._smtp_server)
71
except socket.error, e:
72
if e.args[0] == errno.ECONNREFUSED:
73
if self._config_smtp_server is None:
74
raise DefaultSMTPConnectionRefused(socket.error,
77
raise SMTPConnectionRefused(socket.error,
82
# Say EHLO (falling back to HELO) to query the server's features.
83
code, resp = self._connection.ehlo()
84
if not (200 <= code <= 299):
85
code, resp = self._connection.helo()
86
if not (200 <= code <= 299):
87
raise SMTPError("server refused HELO: %d %s" % (code, resp))
89
# Use TLS if the server advertised it:
90
if self._connection.has_extn("starttls"):
91
code, resp = self._connection.starttls()
92
if not (200 <= code <= 299):
93
raise SMTPError("server refused STARTTLS: %d %s" % (code, resp))
94
# Say EHLO again, to check for newly revealed features
95
code, resp = self._connection.ehlo()
96
if not (200 <= code <= 299):
97
raise SMTPError("server refused EHLO: %d %s" % (code, resp))
99
def _authenticate(self):
100
"""If necessary authenticate yourself to the server."""
101
if self._smtp_username is None:
104
if self._smtp_password is None:
105
self._smtp_password = ui.ui_factory.get_password(
106
'Please enter the SMTP password: %(user)s@%(host)s',
107
user=self._smtp_username,
108
host=self._smtp_server)
110
self._connection.login(self._smtp_username, self._smtp_password)
113
def get_message_addresses(message):
114
"""Get the origin and destination addresses of a message.
116
:param message: A message object supporting get() to access its
117
headers, like email.Message or bzrlib.email_message.EmailMessage.
118
:return: A pair (from_email, to_emails), where from_email is the email
119
address in the From header, and to_emails a list of all the
120
addresses in the To, Cc, and Bcc headers.
122
from_email = Utils.parseaddr(message.get('From', None))[1]
123
to_full_addresses = []
124
for header in ['To', 'Cc', 'Bcc']:
125
value = message.get(header, None)
127
to_full_addresses.append(value)
128
to_emails = [ pair[1] for pair in
129
Utils.getaddresses(to_full_addresses) ]
131
return from_email, to_emails
133
def send_email(self, message):
134
"""Send an email message.
136
The message will be sent to all addresses in the To, Cc and Bcc
139
:param message: An email.Message or email.MIMEMultipart object.
142
from_email, to_emails = self.get_message_addresses(message)
145
raise NoDestinationAddress
149
self._connection.sendmail(from_email, to_emails,
151
except smtplib.SMTPRecipientsRefused, e:
152
raise SMTPError('server refused recipient: %d %s' %
153
e.recipients.values()[0])
154
except smtplib.SMTPResponseException, e:
155
raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
156
except smtplib.SMTPException, e:
157
raise SMTPError(str(e))
added
removed
bzrlib/smtp_connection.py
