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
23
from bzrlib.errors import NoDestinationAddress, SMTPError
26
class SMTPConnection(object):
27
"""Connect to an SMTP server and send an email.
29
This is a gateway between bzrlib.config.Config and smtplib.SMTP. It
30
understands the basic bzr SMTP configuration information: smtp_server,
31
smtp_username, and smtp_password.
34
_default_smtp_server = 'localhost'
36
def __init__(self, config):
38
self._smtp_server = config.get_user_option('smtp_server')
39
if self._smtp_server is None:
40
self._smtp_server = self._default_smtp_server
42
self._smtp_username = config.get_user_option('smtp_username')
43
self._smtp_password = config.get_user_option('smtp_password')
45
self._connection = None
48
"""If we haven't connected, connect and authenticate."""
49
if self._connection is not None:
52
self._create_connection()
55
def _create_connection(self):
56
"""Create an SMTP connection."""
57
self._connection = smtplib.SMTP()
58
self._connection.connect(self._smtp_server)
60
# If this fails, it just returns an error, but it shouldn't raise an
61
# exception unless something goes really wrong (in which case we want
63
self._connection.starttls()
65
def _authenticate(self):
66
"""If necessary authenticate yourself to the server."""
67
if self._smtp_username is None:
70
if self._smtp_password is None:
71
self._smtp_password = ui.ui_factory.get_password(
72
'Please enter the SMTP password: %(user)s@%(host)s',
73
user=self._smtp_username,
74
host=self._smtp_server)
76
self._connection.login(self._smtp_username, self._smtp_password)
79
def get_message_addresses(message):
80
"""Get the origin and destination addresses of a message.
82
:param message: A message object supporting get() to access its
83
headers, like email.Message or bzrlib.email_message.EmailMessage.
84
:return: A pair (from_email, to_emails), where from_email is the email
85
address in the From header, and to_emails a list of all the
86
addresses in the To, Cc, and Bcc headers.
88
from_email = Utils.parseaddr(message.get('From', None))[1]
89
to_full_addresses = []
90
for header in ['To', 'Cc', 'Bcc']:
91
value = message.get(header, None)
93
to_full_addresses.append(value)
94
to_emails = [ pair[1] for pair in
95
Utils.getaddresses(to_full_addresses) ]
97
return from_email, to_emails
99
def send_email(self, message):
100
"""Send an email message.
102
The message will be sent to all addresses in the To, Cc and Bcc
105
:param message: An email.Message or email.MIMEMultipart object.
108
from_email, to_emails = self.get_message_addresses(message)
111
raise NoDestinationAddress
115
self._connection.sendmail(from_email, to_emails,
117
except smtplib.SMTPRecipientsRefused, e:
118
raise SMTPError('server refused recipient: %d %s' %
119
e.recipients.values()[0])
120
except smtplib.SMTPResponseException, e:
121
raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
122
except smtplib.SMTPException, e:
123
raise SMTPError(str(e))
added
removed
bzrlib/smtp_connection.py
