← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smtp_connection.py

  • Committer: Adeodato Simó
  • Date: 2007-06-19 16:11:26 UTC
  • mto: (2547.1.1 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 2548.
  • Revision ID: dato@net.com.org.es-20070619161126-zwni0l40maepwyj5
New SMTPConnection class, a reduced version of that in bzr-email.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smtp_connection.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""A convenience class around smtplib."""
 
18
 
 
19
from email.Utils import getaddresses, parseaddr
 
20
import smtplib
 
21
 
 
22
from bzrlib import ui
 
23
from bzrlib.errors import BzrCommandError, NoDestinationAddress
 
24
 
 
25
 
 
26
class SMTPConnection(object):
 
27
    """Connect to an SMTP server and send an email.
 
28
 
 
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.
 
32
    """
 
33
 
 
34
    _default_smtp_server = 'localhost'
 
35
 
 
36
    def __init__(self, config):
 
37
        self._config = 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
 
41
 
 
42
        self._smtp_username = config.get_user_option('smtp_username')
 
43
        self._smtp_password = config.get_user_option('smtp_password')
 
44
 
 
45
        self._connection = None
 
46
 
 
47
    def _connect(self):
 
48
        """If we haven't connected, connect and authenticate."""
 
49
        if self._connection is not None:
 
50
            return
 
51
 
 
52
        self._create_connection()
 
53
        self._authenticate()
 
54
 
 
55
    def _create_connection(self):
 
56
        """Create an SMTP connection."""
 
57
        self._connection = smtplib.SMTP()
 
58
        self._connection.connect(self._smtp_server)
 
59
 
 
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
 
62
        # to fail anyway).
 
63
        self._connection.starttls()
 
64
 
 
65
    def _authenticate(self):
 
66
        """If necessary authenticate yourself to the server."""
 
67
        if self._smtp_username is None:
 
68
            return
 
69
 
 
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)
 
75
 
 
76
        self._connection.login(self._smtp_username, self._smtp_password)
 
77
 
 
78
    @staticmethod
 
79
    def get_message_addresses(message):
 
80
        """Get the origin and destination addresses of a message.
 
81
 
 
82
        :param message: An email.Message or email.MIMEMultipart object.
 
83
        :return: A pair (from_email, to_emails), where from_email is the email
 
84
            address in the From header, and to_emails a list of all the
 
85
            addresses in the To, Cc, and Bcc headers.
 
86
        """
 
87
        from_email = parseaddr(message['From'])[1]
 
88
        to_full_addresses = []
 
89
        for header in ['To', 'Cc', 'Bcc']:
 
90
            to_full_addresses += message.get_all(header, [])
 
91
        to_emails = [ pair[1] for pair in getaddresses(to_full_addresses) ]
 
92
 
 
93
        return from_email, to_emails
 
94
 
 
95
    def send_email(self, message):
 
96
        """Send an email message.
 
97
 
 
98
        The message will be sent to all addresses in the To, Cc and Bcc headers.
 
99
 
 
100
        :param message: An email.Message or email.MIMEMultipart object.
 
101
        :return: None
 
102
        """
 
103
        from_email, to_emails = self.get_message_addresses(message)
 
104
 
 
105
        if not to_emails:
 
106
            raise NoDestinationAddress
 
107
 
 
108
        try:
 
109
            self._connect()
 
110
            self._connection.sendmail(from_email, to_emails, message.as_string())
 
111
        except smtplib.SMTPRecipientsRefused, e:
 
112
            raise BzrCommandError('SMTP server refused recipient: %d %s' 
 
113
                % e.recipients.values()[0])
 
114
        except smtplib.SMTPResponseException, e:
 
115
            raise BzrCommandError('SMTP error: %d %s' % (e.smtp_code,
 
116
                e.smtp_error))
 
117
        except smtplib.SMTPException, e:
 
118
            raise BzrCommandError('SMTP error: ' + str(e))