/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""A convenience class around smtplib."""
18
18
 
19
 
from email import Utils
20
 
import errno
 
19
from email.Utils import getaddresses, parseaddr
21
20
import smtplib
22
 
import socket
23
21
 
24
 
from bzrlib import (
25
 
    config,
26
 
    osutils,
27
 
    )
28
 
from bzrlib.errors import (
29
 
    NoDestinationAddress,
30
 
    SMTPError,
31
 
    DefaultSMTPConnectionRefused,
32
 
    SMTPConnectionRefused,
33
 
    )
 
22
from bzrlib import ui
 
23
from bzrlib.errors import BzrCommandError, NoDestinationAddress
34
24
 
35
25
 
36
26
class SMTPConnection(object):
43
33
 
44
34
    _default_smtp_server = 'localhost'
45
35
 
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
 
36
    def __init__(self, config):
50
37
        self._config = config
51
 
        self._config_smtp_server = config.get_user_option('smtp_server')
52
 
        self._smtp_server = self._config_smtp_server
 
38
        self._smtp_server = config.get_user_option('smtp_server')
53
39
        if self._smtp_server is None:
54
40
            self._smtp_server = self._default_smtp_server
55
41
 
64
50
            return
65
51
 
66
52
        self._create_connection()
67
 
        # FIXME: _authenticate() should only be called when the server has
68
 
        # refused unauthenticated access, so it can safely try to authenticate 
69
 
        # with the default username. JRV20090407
70
53
        self._authenticate()
71
54
 
72
55
    def _create_connection(self):
73
56
        """Create an SMTP connection."""
74
 
        self._connection = self._smtp_factory()
75
 
        try:
76
 
            self._connection.connect(self._smtp_server)
77
 
        except socket.error, e:
78
 
            if e.args[0] == errno.ECONNREFUSED:
79
 
                if self._config_smtp_server is None:
80
 
                    raise DefaultSMTPConnectionRefused(socket.error,
81
 
                                                       self._smtp_server)
82
 
                else:
83
 
                    raise SMTPConnectionRefused(socket.error,
84
 
                                                self._smtp_server)
85
 
            else:
86
 
                raise
87
 
 
88
 
        # Say EHLO (falling back to HELO) to query the server's features.
89
 
        code, resp = self._connection.ehlo()
90
 
        if not (200 <= code <= 299):
91
 
            code, resp = self._connection.helo()
92
 
            if not (200 <= code <= 299):
93
 
                raise SMTPError("server refused HELO: %d %s" % (code, resp))
94
 
 
95
 
        # Use TLS if the server advertised it:
96
 
        if self._connection.has_extn("starttls"):
97
 
            code, resp = self._connection.starttls()
98
 
            if not (200 <= code <= 299):
99
 
                raise SMTPError("server refused STARTTLS: %d %s" % (code, resp))
100
 
            # Say EHLO again, to check for newly revealed features
101
 
            code, resp = self._connection.ehlo()
102
 
            if not (200 <= code <= 299):
103
 
                raise SMTPError("server refused EHLO: %d %s" % (code, resp))
 
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()
104
64
 
105
65
    def _authenticate(self):
106
66
        """If necessary authenticate yourself to the server."""
107
 
        auth = config.AuthenticationConfig()
108
67
        if self._smtp_username is None:
109
 
            # FIXME: Since _authenticate gets called even when no authentication
110
 
            # is necessary, it's not possible to use the default username 
111
 
            # here yet.
112
 
            self._smtp_username = auth.get_user('smtp', self._smtp_server)
113
 
            if self._smtp_username is None:
114
 
                return
 
68
            return
115
69
 
116
70
        if self._smtp_password is None:
117
 
            self._smtp_password = auth.get_password(
118
 
                'smtp', self._smtp_server, self._smtp_username)
119
 
 
120
 
        # smtplib requires that the username and password be byte
121
 
        # strings.  The CRAM-MD5 spec doesn't give any guidance on
122
 
        # encodings, but the SASL PLAIN spec says UTF-8, so that's
123
 
        # what we'll use.
124
 
        username = osutils.safe_utf8(self._smtp_username)
125
 
        password = osutils.safe_utf8(self._smtp_password)
126
 
 
127
 
        self._connection.login(username, password)
 
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)
128
77
 
129
78
    @staticmethod
130
79
    def get_message_addresses(message):
131
80
        """Get the origin and destination addresses of a message.
132
81
 
133
 
        :param message: A message object supporting get() to access its
134
 
            headers, like email.Message or bzrlib.email_message.EmailMessage.
 
82
        :param message: An email.Message or email.MIMEMultipart object.
135
83
        :return: A pair (from_email, to_emails), where from_email is the email
136
84
            address in the From header, and to_emails a list of all the
137
85
            addresses in the To, Cc, and Bcc headers.
138
86
        """
139
 
        from_email = Utils.parseaddr(message.get('From', None))[1]
 
87
        from_email = parseaddr(message['From'])[1]
140
88
        to_full_addresses = []
141
89
        for header in ['To', 'Cc', 'Bcc']:
142
 
            value = message.get(header, None)
143
 
            if value:
144
 
                to_full_addresses.append(value)
145
 
        to_emails = [ pair[1] for pair in
146
 
                Utils.getaddresses(to_full_addresses) ]
 
90
            to_full_addresses += message.get_all(header, [])
 
91
        to_emails = [ pair[1] for pair in getaddresses(to_full_addresses) ]
147
92
 
148
93
        return from_email, to_emails
149
94
 
150
95
    def send_email(self, message):
151
96
        """Send an email message.
152
97
 
153
 
        The message will be sent to all addresses in the To, Cc and Bcc
154
 
        headers.
 
98
        The message will be sent to all addresses in the To, Cc and Bcc headers.
155
99
 
156
100
        :param message: An email.Message or email.MIMEMultipart object.
157
101
        :return: None
163
107
 
164
108
        try:
165
109
            self._connect()
166
 
            self._connection.sendmail(from_email, to_emails,
167
 
                                      message.as_string())
 
110
            self._connection.sendmail(from_email, to_emails, message.as_string())
168
111
        except smtplib.SMTPRecipientsRefused, e:
169
 
            raise SMTPError('server refused recipient: %d %s' %
170
 
                    e.recipients.values()[0])
 
112
            raise BzrCommandError('SMTP server refused recipient: %d %s' 
 
113
                % e.recipients.values()[0])
171
114
        except smtplib.SMTPResponseException, e:
172
 
            raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
 
115
            raise BzrCommandError('SMTP error: %d %s' % (e.smtp_code,
 
116
                e.smtp_error))
173
117
        except smtplib.SMTPException, e:
174
 
            raise SMTPError(str(e))
 
118
            raise BzrCommandError('SMTP error: ' + str(e))