Benjamin Peterson | 90f5ba5 | 2010-03-11 22:53:45 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python3 |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 2 | |
Barry Warsaw | a1ae884 | 2000-07-09 21:24:31 +0000 | [diff] [blame] | 3 | '''SMTP/ESMTP client class. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 4 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 5 | This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP |
| 6 | Authentication) and RFC 2487 (Secure SMTP over TLS). |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 8 | Notes: |
| 9 | |
| 10 | Please remember, when doing ESMTP, that the names of the SMTP service |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 11 | extensions are NOT the same thing as the option keywords for the RCPT |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 12 | and MAIL commands! |
| 13 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 14 | Example: |
| 15 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 16 | >>> import smtplib |
| 17 | >>> s=smtplib.SMTP("localhost") |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 18 | >>> print(s.help()) |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 19 | This is Sendmail version 8.8.4 |
| 20 | Topics: |
| 21 | HELO EHLO MAIL RCPT DATA |
| 22 | RSET NOOP QUIT HELP VRFY |
| 23 | EXPN VERB ETRN DSN |
| 24 | For more info use "HELP <topic>". |
| 25 | To report bugs in the implementation send email to |
| 26 | sendmail-bugs@sendmail.org. |
| 27 | For local information send email to Postmaster at your site. |
| 28 | End of HELP info |
| 29 | >>> s.putcmd("vrfy","someone@here") |
| 30 | >>> s.getreply() |
| 31 | (250, "Somebody OverHere <somebody@here.my.org>") |
| 32 | >>> s.quit() |
Barry Warsaw | a1ae884 | 2000-07-09 21:24:31 +0000 | [diff] [blame] | 33 | ''' |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 34 | |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 35 | # Author: The Dragon De Monsyne <dragondm@integral.org> |
| 36 | # ESMTP support, test code and doc fixes added by |
| 37 | # Eric S. Raymond <esr@thyrsus.com> |
| 38 | # Better RFC 821 compliance (MAIL and RCPT, and CRLF in data) |
| 39 | # by Carey Evans <c.evans@clear.net.nz>, for picky mail servers. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 40 | # RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 41 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 42 | # This was modified from the Python 1.5 library HTTP lib. |
| 43 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 44 | import socket |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 45 | import io |
Barry Warsaw | 0720177 | 1998-12-22 20:37:36 +0000 | [diff] [blame] | 46 | import re |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 47 | import email.utils |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 48 | import email.message |
| 49 | import email.generator |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 50 | import base64 |
| 51 | import hmac |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 52 | import copy |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 53 | import datetime |
| 54 | import sys |
Barry Warsaw | 2cc1f6d | 2007-08-30 14:28:55 +0000 | [diff] [blame] | 55 | from email.base64mime import body_encode as encode_base64 |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 56 | |
nde | 3faf826 | 2019-10-05 02:30:58 +0200 | [diff] [blame] | 57 | __all__ = ["SMTPException", "SMTPNotSupportedError", "SMTPServerDisconnected", "SMTPResponseException", |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 58 | "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError", |
| 59 | "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError", |
| 60 | "quoteaddr", "quotedata", "SMTP"] |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 61 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 62 | SMTP_PORT = 25 |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 63 | SMTP_SSL_PORT = 465 |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 64 | CRLF = "\r\n" |
| 65 | bCRLF = b"\r\n" |
Georg Brandl | b38b5c4 | 2014-02-10 22:11:21 +0100 | [diff] [blame] | 66 | _MAXLINE = 8192 # more than 8 times larger than RFC 821, 4.5.3 |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 67 | |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 68 | OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I) |
| 69 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 70 | # Exception classes used by this module. |
R David Murray | 8a34596 | 2013-04-14 06:46:35 -0400 | [diff] [blame] | 71 | class SMTPException(OSError): |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 72 | """Base class for all exceptions raised by this module.""" |
| 73 | |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 74 | class SMTPNotSupportedError(SMTPException): |
| 75 | """The command or option is not supported by the SMTP server. |
| 76 | |
| 77 | This exception is raised when an attempt is made to run a command or a |
| 78 | command with an option which is not supported by the server. |
| 79 | """ |
| 80 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 81 | class SMTPServerDisconnected(SMTPException): |
| 82 | """Not connected to any SMTP server. |
| 83 | |
| 84 | This exception is raised when the server unexpectedly disconnects, |
| 85 | or when an attempt is made to use the SMTP instance before |
| 86 | connecting it to a server. |
| 87 | """ |
| 88 | |
| 89 | class SMTPResponseException(SMTPException): |
| 90 | """Base class for all exceptions that include an SMTP error code. |
| 91 | |
| 92 | These exceptions are generated in some instances when the SMTP |
| 93 | server returns an error code. The error code is stored in the |
| 94 | `smtp_code' attribute of the error, and the `smtp_error' attribute |
| 95 | is set to the error message. |
| 96 | """ |
| 97 | |
| 98 | def __init__(self, code, msg): |
| 99 | self.smtp_code = code |
| 100 | self.smtp_error = msg |
| 101 | self.args = (code, msg) |
| 102 | |
| 103 | class SMTPSenderRefused(SMTPResponseException): |
| 104 | """Sender address refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 105 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 106 | In addition to the attributes set by on all SMTPResponseException |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 107 | exceptions, this sets `sender' to the string that the SMTP refused. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 108 | """ |
| 109 | |
| 110 | def __init__(self, code, msg, sender): |
| 111 | self.smtp_code = code |
| 112 | self.smtp_error = msg |
| 113 | self.sender = sender |
| 114 | self.args = (code, msg, sender) |
| 115 | |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 116 | class SMTPRecipientsRefused(SMTPException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 117 | """All recipient addresses refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 118 | |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 119 | The errors for each recipient are accessible through the attribute |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 120 | 'recipients', which is a dictionary of exactly the same sort as |
| 121 | SMTP.sendmail() returns. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 122 | """ |
| 123 | |
| 124 | def __init__(self, recipients): |
| 125 | self.recipients = recipients |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 126 | self.args = (recipients,) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 127 | |
| 128 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 129 | class SMTPDataError(SMTPResponseException): |
| 130 | """The SMTP server didn't accept the data.""" |
| 131 | |
| 132 | class SMTPConnectError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 133 | """Error during connection establishment.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 134 | |
| 135 | class SMTPHeloError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 136 | """The server refused our HELO reply.""" |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 137 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 138 | class SMTPAuthenticationError(SMTPResponseException): |
| 139 | """Authentication error. |
| 140 | |
| 141 | Most probably the server didn't accept the username/password |
| 142 | combination provided. |
| 143 | """ |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 144 | |
R David Murray | 4c14bba | 2011-07-18 21:59:53 -0400 | [diff] [blame] | 145 | def quoteaddr(addrstring): |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 146 | """Quote a subset of the email addresses defined by RFC 821. |
| 147 | |
Georg Brandl | 9f0f960 | 2008-06-12 22:23:59 +0000 | [diff] [blame] | 148 | Should be able to handle anything email.utils.parseaddr can handle. |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 149 | """ |
R David Murray | 4c14bba | 2011-07-18 21:59:53 -0400 | [diff] [blame] | 150 | displayname, addr = email.utils.parseaddr(addrstring) |
| 151 | if (displayname, addr) == ('', ''): |
| 152 | # parseaddr couldn't parse it, use it as is and hope for the best. |
| 153 | if addrstring.strip().startswith('<'): |
| 154 | return addrstring |
| 155 | return "<%s>" % addrstring |
| 156 | return "<%s>" % addr |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 157 | |
R David Murray | 4634676 | 2011-07-18 21:38:54 -0400 | [diff] [blame] | 158 | def _addr_only(addrstring): |
| 159 | displayname, addr = email.utils.parseaddr(addrstring) |
| 160 | if (displayname, addr) == ('', ''): |
| 161 | # parseaddr couldn't parse it, so use it as is. |
| 162 | return addrstring |
| 163 | return addr |
| 164 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 165 | # Legacy method kept for backward compatibility. |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 166 | def quotedata(data): |
| 167 | """Quote data for email. |
| 168 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 169 | Double leading '.', and change Unix newline '\\n', or Mac '\\r' into |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 170 | Internet CRLF end-of-line. |
| 171 | """ |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 172 | return re.sub(r'(?m)^\.', '..', |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 173 | re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)) |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 174 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 175 | def _quote_periods(bindata): |
R David Murray | 0f663d0 | 2011-06-09 15:05:57 -0400 | [diff] [blame] | 176 | return re.sub(br'(?m)^\.', b'..', bindata) |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 177 | |
| 178 | def _fix_eols(data): |
| 179 | return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data) |
| 180 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 181 | try: |
| 182 | import ssl |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 183 | except ImportError: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 184 | _have_ssl = False |
| 185 | else: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 186 | _have_ssl = True |
| 187 | |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 188 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 189 | class SMTP: |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 190 | """This class manages a connection to an SMTP or ESMTP server. |
| 191 | SMTP Objects: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 192 | SMTP objects have the following attributes: |
| 193 | helo_resp |
| 194 | This is the message given by the server in response to the |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 195 | most recent HELO command. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 196 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 197 | ehlo_resp |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 198 | This is the message given by the server in response to the |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 199 | most recent EHLO command. This is usually multiline. |
| 200 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 201 | does_esmtp |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 202 | This is a True value _after you do an EHLO command_, if the |
| 203 | server supports ESMTP. |
| 204 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 205 | esmtp_features |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 206 | This is a dictionary, which, if the server supports ESMTP, |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 207 | will _after you do an EHLO command_, contain the names of the |
| 208 | SMTP service extensions this server supports, and their |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 209 | parameters (if any). |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 210 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 211 | Note, all extension names are mapped to lower case in the |
| 212 | dictionary. |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 213 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 214 | See each method's docstrings for details. In general, there is a |
| 215 | method of the same name to perform each SMTP command. There is also a |
| 216 | method called 'sendmail' that will do an entire mail transaction. |
| 217 | """ |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 218 | debuglevel = 0 |
Romuald Brunet | 7b31397 | 2018-10-09 16:31:55 +0200 | [diff] [blame] | 219 | |
| 220 | sock = None |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 221 | file = None |
| 222 | helo_resp = None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 223 | ehlo_msg = "ehlo" |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 224 | ehlo_resp = None |
Ville Skyttä | da51ba4 | 2020-05-23 03:50:58 +0300 | [diff] [blame] | 225 | does_esmtp = False |
Antoine Pitrou | c1d5206 | 2011-05-07 19:39:37 +0200 | [diff] [blame] | 226 | default_port = SMTP_PORT |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 227 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 228 | def __init__(self, host='', port=0, local_hostname=None, |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 229 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 230 | source_address=None): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 231 | """Initialize a new instance. |
| 232 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 233 | If specified, `host' is the name of the remote host to which to |
| 234 | connect. If specified, `port' specifies the port to which to connect. |
R David Murray | 14ee3cf | 2013-04-13 14:40:33 -0400 | [diff] [blame] | 235 | By default, smtplib.SMTP_PORT is used. If a host is specified the |
R David Murray | 021362d | 2013-06-23 16:05:44 -0400 | [diff] [blame] | 236 | connect method is called, and if it returns anything other than a |
| 237 | success code an SMTPConnectError is raised. If specified, |
| 238 | `local_hostname` is used as the FQDN of the local host in the HELO/EHLO |
| 239 | command. Otherwise, the local hostname is found using |
| 240 | socket.getfqdn(). The `source_address` parameter takes a 2-tuple (host, |
| 241 | port) for the socket to bind to as its source address before |
| 242 | connecting. If the host is '' and port is 0, the OS default behavior |
| 243 | will be used. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 244 | |
| 245 | """ |
Christian Heimes | a5768f7 | 2013-12-02 20:44:17 +0100 | [diff] [blame] | 246 | self._host = host |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 247 | self.timeout = timeout |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 248 | self.esmtp_features = {} |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 249 | self.command_encoding = 'ascii' |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 250 | self.source_address = source_address |
| 251 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 252 | if host: |
| 253 | (code, msg) = self.connect(host, port) |
| 254 | if code != 220: |
Joel Hillacre | 9e98cd0 | 2017-05-23 23:14:50 -0600 | [diff] [blame] | 255 | self.close() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 256 | raise SMTPConnectError(code, msg) |
Raymond Hettinger | f13eb55 | 2002-06-02 00:40:05 +0000 | [diff] [blame] | 257 | if local_hostname is not None: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 258 | self.local_hostname = local_hostname |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 259 | else: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 260 | # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and |
| 261 | # if that can't be calculated, that we should use a domain literal |
| 262 | # instead (essentially an encoded IP address like [A.B.C.D]). |
| 263 | fqdn = socket.getfqdn() |
| 264 | if '.' in fqdn: |
| 265 | self.local_hostname = fqdn |
| 266 | else: |
| 267 | # We can't find an fqdn hostname, so use a domain literal |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 268 | addr = '127.0.0.1' |
| 269 | try: |
| 270 | addr = socket.gethostbyname(socket.gethostname()) |
| 271 | except socket.gaierror: |
| 272 | pass |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 273 | self.local_hostname = '[%s]' % addr |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 274 | |
Barry Warsaw | 1f5c958 | 2011-03-15 15:04:44 -0400 | [diff] [blame] | 275 | def __enter__(self): |
| 276 | return self |
| 277 | |
| 278 | def __exit__(self, *args): |
| 279 | try: |
| 280 | code, message = self.docmd("QUIT") |
| 281 | if code != 221: |
| 282 | raise SMTPResponseException(code, message) |
| 283 | except SMTPServerDisconnected: |
| 284 | pass |
| 285 | finally: |
| 286 | self.close() |
| 287 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 288 | def set_debuglevel(self, debuglevel): |
| 289 | """Set the debug output level. |
| 290 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 291 | A non-false value results in debug messages for connection and for all |
| 292 | messages sent to and received from the server. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 293 | |
| 294 | """ |
| 295 | self.debuglevel = debuglevel |
| 296 | |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 297 | def _print_debug(self, *args): |
| 298 | if self.debuglevel > 1: |
| 299 | print(datetime.datetime.now().time(), *args, file=sys.stderr) |
| 300 | else: |
| 301 | print(*args, file=sys.stderr) |
| 302 | |
Barry Warsaw | c918171 | 2008-03-19 14:25:51 +0000 | [diff] [blame] | 303 | def _get_socket(self, host, port, timeout): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 304 | # This makes it simpler for SMTP_SSL to use the SMTP connect code |
| 305 | # and just alter the socket connection bit. |
Dong-hee Na | 62e3973 | 2020-01-14 16:49:59 +0900 | [diff] [blame] | 306 | if timeout is not None and not timeout: |
| 307 | raise ValueError('Non-blocking socket (timeout=0) is not supported') |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 308 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 309 | self._print_debug('connect: to', (host, port), self.source_address) |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 310 | return socket.create_connection((host, port), timeout, |
| 311 | self.source_address) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 312 | |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 313 | def connect(self, host='localhost', port=0, source_address=None): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 314 | """Connect to a host on a given port. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 315 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 316 | If the hostname ends with a colon (`:') followed by a number, and |
| 317 | there is no port specified, that suffix will be stripped off and the |
| 318 | number interpreted as the port number to use. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 319 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 320 | Note: This method is automatically invoked by __init__, if a host is |
| 321 | specified during instantiation. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 322 | |
| 323 | """ |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 324 | |
| 325 | if source_address: |
| 326 | self.source_address = source_address |
| 327 | |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 328 | if not port and (host.find(':') == host.rfind(':')): |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 329 | i = host.rfind(':') |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 330 | if i >= 0: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 331 | host, port = host[:i], host[i + 1:] |
| 332 | try: |
| 333 | port = int(port) |
Eric S. Raymond | 8d87603 | 2001-02-09 10:14:53 +0000 | [diff] [blame] | 334 | except ValueError: |
Andrew Svetlov | 2ade6f2 | 2012-12-17 18:57:16 +0200 | [diff] [blame] | 335 | raise OSError("nonnumeric port") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 336 | if not port: |
| 337 | port = self.default_port |
Steve Dower | 44f91c3 | 2019-06-27 10:47:59 -0700 | [diff] [blame] | 338 | sys.audit("smtplib.connect", self, host, port) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 339 | self.sock = self._get_socket(host, port, self.timeout) |
Antoine Pitrou | f068ab8 | 2011-06-06 19:17:09 +0200 | [diff] [blame] | 340 | self.file = None |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 341 | (code, msg) = self.getreply() |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 342 | if self.debuglevel > 0: |
R David Murray | 37f1ba9 | 2015-04-16 18:54:56 -0400 | [diff] [blame] | 343 | self._print_debug('connect:', repr(msg)) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 344 | return (code, msg) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 345 | |
Guido van Rossum | 8a392d7 | 2007-11-21 22:09:45 +0000 | [diff] [blame] | 346 | def send(self, s): |
| 347 | """Send `s' to the server.""" |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 348 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 349 | self._print_debug('send:', repr(s)) |
Romuald Brunet | 7b31397 | 2018-10-09 16:31:55 +0200 | [diff] [blame] | 350 | if self.sock: |
Guido van Rossum | 8a392d7 | 2007-11-21 22:09:45 +0000 | [diff] [blame] | 351 | if isinstance(s, str): |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 352 | # send is used by the 'data' command, where command_encoding |
| 353 | # should not be used, but 'data' needs to convert the string to |
| 354 | # binary itself anyway, so that's not a problem. |
| 355 | s = s.encode(self.command_encoding) |
Steve Dower | 44f91c3 | 2019-06-27 10:47:59 -0700 | [diff] [blame] | 356 | sys.audit("smtplib.send", self, s) |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 357 | try: |
Guido van Rossum | 8a392d7 | 2007-11-21 22:09:45 +0000 | [diff] [blame] | 358 | self.sock.sendall(s) |
Andrew Svetlov | 2ade6f2 | 2012-12-17 18:57:16 +0200 | [diff] [blame] | 359 | except OSError: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 360 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 361 | raise SMTPServerDisconnected('Server not connected') |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 362 | else: |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 363 | raise SMTPServerDisconnected('please run connect() first') |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 364 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 365 | def putcmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 366 | """Send a command to the server.""" |
Guido van Rossum | db23d3d | 1999-06-09 15:13:10 +0000 | [diff] [blame] | 367 | if args == "": |
| 368 | str = '%s%s' % (cmd, CRLF) |
| 369 | else: |
| 370 | str = '%s %s%s' % (cmd, args, CRLF) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 371 | self.send(str) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 372 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 373 | def getreply(self): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 374 | """Get a reply from the server. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 375 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 376 | Returns a tuple consisting of: |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 377 | |
| 378 | - server response code (e.g. '250', or such, if all goes well) |
| 379 | Note: returns -1 if it can't read response code. |
| 380 | |
| 381 | - server response string corresponding to response code (multiline |
| 382 | responses are converted to a single, multiline string). |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 383 | |
| 384 | Raises SMTPServerDisconnected if end-of-file is reached. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 385 | """ |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 386 | resp = [] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 387 | if self.file is None: |
| 388 | self.file = self.sock.makefile('rb') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 389 | while 1: |
Benjamin Peterson | e1cdfd7 | 2009-01-18 21:02:37 +0000 | [diff] [blame] | 390 | try: |
Georg Brandl | b38b5c4 | 2014-02-10 22:11:21 +0100 | [diff] [blame] | 391 | line = self.file.readline(_MAXLINE + 1) |
Andrew Svetlov | 2ade6f2 | 2012-12-17 18:57:16 +0200 | [diff] [blame] | 392 | except OSError as e: |
Antoine Pitrou | 6b2e160 | 2011-08-28 01:20:42 +0200 | [diff] [blame] | 393 | self.close() |
| 394 | raise SMTPServerDisconnected("Connection unexpectedly closed: " |
| 395 | + str(e)) |
Guido van Rossum | 806c246 | 2007-08-06 23:33:07 +0000 | [diff] [blame] | 396 | if not line: |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 397 | self.close() |
| 398 | raise SMTPServerDisconnected("Connection unexpectedly closed") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 399 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 400 | self._print_debug('reply:', repr(line)) |
Georg Brandl | b38b5c4 | 2014-02-10 22:11:21 +0100 | [diff] [blame] | 401 | if len(line) > _MAXLINE: |
Senthil Kumaran | 4ce118e | 2014-06-03 07:24:54 -0700 | [diff] [blame] | 402 | self.close() |
Georg Brandl | b38b5c4 | 2014-02-10 22:11:21 +0100 | [diff] [blame] | 403 | raise SMTPResponseException(500, "Line too long.") |
Guido van Rossum | 806c246 | 2007-08-06 23:33:07 +0000 | [diff] [blame] | 404 | resp.append(line[4:].strip(b' \t\r\n')) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 405 | code = line[:3] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 406 | # Check that the error code is syntactically correct. |
| 407 | # Don't attempt to read a continuation line if it is broken. |
| 408 | try: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 409 | errcode = int(code) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 410 | except ValueError: |
| 411 | errcode = -1 |
| 412 | break |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 413 | # Check if multiline response. |
Guido van Rossum | 806c246 | 2007-08-06 23:33:07 +0000 | [diff] [blame] | 414 | if line[3:4] != b"-": |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 415 | break |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 416 | |
Guido van Rossum | c43e79f | 2007-06-18 18:26:36 +0000 | [diff] [blame] | 417 | errmsg = b"\n".join(resp) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 418 | if self.debuglevel > 0: |
R David Murray | 37f1ba9 | 2015-04-16 18:54:56 -0400 | [diff] [blame] | 419 | self._print_debug('reply: retcode (%s); Msg: %a' % (errcode, errmsg)) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 420 | return errcode, errmsg |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 421 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 422 | def docmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 423 | """Send a command, and return its response code.""" |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 424 | self.putcmd(cmd, args) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 425 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 426 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 427 | # std smtp commands |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 428 | def helo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 429 | """SMTP 'helo' command. |
| 430 | Hostname to send for this command defaults to the FQDN of the local |
| 431 | host. |
| 432 | """ |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 433 | self.putcmd("helo", name or self.local_hostname) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 434 | (code, msg) = self.getreply() |
| 435 | self.helo_resp = msg |
| 436 | return (code, msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 437 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 438 | def ehlo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 439 | """ SMTP 'ehlo' command. |
| 440 | Hostname to send for this command defaults to the FQDN of the local |
| 441 | host. |
| 442 | """ |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 443 | self.esmtp_features = {} |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 444 | self.putcmd(self.ehlo_msg, name or self.local_hostname) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 445 | (code, msg) = self.getreply() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 446 | # According to RFC1869 some (badly written) |
| 447 | # MTA's will disconnect on an ehlo. Toss an exception if |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 448 | # that happens -ddm |
| 449 | if code == -1 and len(msg) == 0: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 450 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 451 | raise SMTPServerDisconnected("Server not connected") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 452 | self.ehlo_resp = msg |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 453 | if code != 250: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 454 | return (code, msg) |
Ville Skyttä | da51ba4 | 2020-05-23 03:50:58 +0300 | [diff] [blame] | 455 | self.does_esmtp = True |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 456 | #parse the ehlo response -ddm |
Guido van Rossum | 04110fb | 2007-08-24 16:32:05 +0000 | [diff] [blame] | 457 | assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 458 | resp = self.ehlo_resp.decode("latin-1").split('\n') |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 459 | del resp[0] |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 460 | for each in resp: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 461 | # To be able to communicate with as many SMTP servers as possible, |
| 462 | # we have to take the old-style auth advertisement into account, |
| 463 | # because: |
| 464 | # 1) Else our SMTP feature parser gets confused. |
| 465 | # 2) There are some servers that only advertise the auth methods we |
| 466 | # support using the old style. |
| 467 | auth_match = OLDSTYLE_AUTH.match(each) |
| 468 | if auth_match: |
| 469 | # This doesn't remove duplicates, but that's no problem |
| 470 | self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \ |
| 471 | + " " + auth_match.groups(0)[0] |
| 472 | continue |
| 473 | |
Barry Warsaw | be22ae6 | 2002-04-15 20:03:30 +0000 | [diff] [blame] | 474 | # RFC 1869 requires a space between ehlo keyword and parameters. |
| 475 | # It's actually stricter, in that only spaces are allowed between |
| 476 | # parameters, but were not going to check for that here. Note |
| 477 | # that the space isn't present if there are no parameters. |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 478 | m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 479 | if m: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 480 | feature = m.group("feature").lower() |
| 481 | params = m.string[m.end("feature"):].strip() |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 482 | if feature == "auth": |
| 483 | self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \ |
| 484 | + " " + params |
| 485 | else: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 486 | self.esmtp_features[feature] = params |
| 487 | return (code, msg) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 488 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 489 | def has_extn(self, opt): |
| 490 | """Does the server support a given SMTP service extension?""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 491 | return opt.lower() in self.esmtp_features |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 492 | |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 493 | def help(self, args=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 494 | """SMTP 'help' command. |
| 495 | Returns help text from server.""" |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 496 | self.putcmd("help", args) |
Kurt B. Kaiser | 58bd190 | 2005-06-26 18:27:36 +0000 | [diff] [blame] | 497 | return self.getreply()[1] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 498 | |
| 499 | def rset(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 500 | """SMTP 'rset' command -- resets session.""" |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 501 | self.command_encoding = 'ascii' |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 502 | return self.docmd("rset") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 503 | |
R David Murray | afb151a | 2014-04-14 18:21:38 -0400 | [diff] [blame] | 504 | def _rset(self): |
| 505 | """Internal 'rset' command which ignores any SMTPServerDisconnected error. |
| 506 | |
| 507 | Used internally in the library, since the server disconnected error |
| 508 | should appear to the application when the *next* command is issued, if |
| 509 | we are doing an internal "safety" reset. |
| 510 | """ |
| 511 | try: |
| 512 | self.rset() |
| 513 | except SMTPServerDisconnected: |
| 514 | pass |
| 515 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 516 | def noop(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 517 | """SMTP 'noop' command -- doesn't do anything :>""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 518 | return self.docmd("noop") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 519 | |
Pablo Aguiar | d5fbe9b | 2018-09-08 00:04:48 +0200 | [diff] [blame] | 520 | def mail(self, sender, options=()): |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 521 | """SMTP 'mail' command -- begins mail xfer session. |
| 522 | |
| 523 | This method may raise the following exceptions: |
| 524 | |
| 525 | SMTPNotSupportedError The options parameter includes 'SMTPUTF8' |
| 526 | but the SMTPUTF8 extension is not supported by |
| 527 | the server. |
| 528 | """ |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 529 | optionlist = '' |
| 530 | if options and self.does_esmtp: |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 531 | if any(x.lower()=='smtputf8' for x in options): |
| 532 | if self.has_extn('smtputf8'): |
| 533 | self.command_encoding = 'utf-8' |
| 534 | else: |
| 535 | raise SMTPNotSupportedError( |
| 536 | 'SMTPUTF8 not supported by server') |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 537 | optionlist = ' ' + ' '.join(options) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 538 | self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 539 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 540 | |
Pablo Aguiar | d5fbe9b | 2018-09-08 00:04:48 +0200 | [diff] [blame] | 541 | def rcpt(self, recip, options=()): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 542 | """SMTP 'rcpt' command -- indicates 1 recipient for this mail.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 543 | optionlist = '' |
| 544 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 545 | optionlist = ' ' + ' '.join(options) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 546 | self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 547 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 548 | |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 549 | def data(self, msg): |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 550 | """SMTP 'DATA' command -- sends message data to server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 551 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 552 | Automatically quotes lines beginning with a period per rfc821. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 553 | Raises SMTPDataError if there is an unexpected reply to the |
| 554 | DATA command; the return value from this method is the final |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 555 | response code received when the all data is sent. If msg |
Serhiy Storchaka | 9f8a891 | 2015-04-03 18:12:41 +0300 | [diff] [blame] | 556 | is a string, lone '\\r' and '\\n' characters are converted to |
| 557 | '\\r\\n' characters. If msg is bytes, it is transmitted as is. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 558 | """ |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 559 | self.putcmd("data") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 560 | (code, repl) = self.getreply() |
| 561 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 562 | self._print_debug('data:', (code, repl)) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 563 | if code != 354: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 564 | raise SMTPDataError(code, repl) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 565 | else: |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 566 | if isinstance(msg, str): |
| 567 | msg = _fix_eols(msg).encode('ascii') |
| 568 | q = _quote_periods(msg) |
| 569 | if q[-2:] != bCRLF: |
| 570 | q = q + bCRLF |
| 571 | q = q + b"." + bCRLF |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 572 | self.send(q) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 573 | (code, msg) = self.getreply() |
| 574 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 575 | self._print_debug('data:', (code, msg)) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 576 | return (code, msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 577 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 578 | def verify(self, address): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 579 | """SMTP 'verify' command -- checks for address validity.""" |
R David Murray | 4634676 | 2011-07-18 21:38:54 -0400 | [diff] [blame] | 580 | self.putcmd("vrfy", _addr_only(address)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 581 | return self.getreply() |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 582 | # a.k.a. |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 583 | vrfy = verify |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 584 | |
| 585 | def expn(self, address): |
Christian Heimes | 90c3d9b | 2008-02-23 13:18:03 +0000 | [diff] [blame] | 586 | """SMTP 'expn' command -- expands a mailing list.""" |
R David Murray | 4634676 | 2011-07-18 21:38:54 -0400 | [diff] [blame] | 587 | self.putcmd("expn", _addr_only(address)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 588 | return self.getreply() |
| 589 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 590 | # some useful methods |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 591 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 592 | def ehlo_or_helo_if_needed(self): |
| 593 | """Call self.ehlo() and/or self.helo() if needed. |
| 594 | |
| 595 | If there has been no previous EHLO or HELO command this session, this |
| 596 | method tries ESMTP EHLO first. |
| 597 | |
| 598 | This method may raise the following exceptions: |
| 599 | |
| 600 | SMTPHeloError The server didn't reply properly to |
| 601 | the helo greeting. |
| 602 | """ |
| 603 | if self.helo_resp is None and self.ehlo_resp is None: |
| 604 | if not (200 <= self.ehlo()[0] <= 299): |
| 605 | (code, resp) = self.helo() |
| 606 | if not (200 <= code <= 299): |
| 607 | raise SMTPHeloError(code, resp) |
| 608 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 609 | def auth(self, mechanism, authobject, *, initial_response_ok=True): |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 610 | """Authentication command - requires response processing. |
| 611 | |
| 612 | 'mechanism' specifies which authentication mechanism is to |
| 613 | be used - the valid values are those listed in the 'auth' |
| 614 | element of 'esmtp_features'. |
| 615 | |
| 616 | 'authobject' must be a callable object taking a single argument: |
| 617 | |
| 618 | data = authobject(challenge) |
| 619 | |
| 620 | It will be called to process the server's challenge response; the |
| 621 | challenge argument it is passed will be a bytes. It should return |
Sebastian Rittau | 78deb7f | 2018-09-10 19:29:43 +0200 | [diff] [blame] | 622 | an ASCII string that will be base64 encoded and sent to the server. |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 623 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 624 | Keyword arguments: |
| 625 | - initial_response_ok: Allow sending the RFC 4954 initial-response |
| 626 | to the AUTH command, if the authentication methods supports it. |
| 627 | """ |
| 628 | # RFC 4954 allows auth methods to provide an initial response. Not all |
| 629 | # methods support it. By definition, if they return something other |
| 630 | # than None when challenge is None, then they do. See issue #15014. |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 631 | mechanism = mechanism.upper() |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 632 | initial_response = (authobject() if initial_response_ok else None) |
| 633 | if initial_response is not None: |
| 634 | response = encode_base64(initial_response.encode('ascii'), eol='') |
| 635 | (code, resp) = self.docmd("AUTH", mechanism + " " + response) |
| 636 | else: |
| 637 | (code, resp) = self.docmd("AUTH", mechanism) |
R David Murray | b0deeb4 | 2015-11-08 01:03:52 -0500 | [diff] [blame] | 638 | # If server responds with a challenge, send the response. |
| 639 | if code == 334: |
| 640 | challenge = base64.decodebytes(resp) |
| 641 | response = encode_base64( |
| 642 | authobject(challenge).encode('ascii'), eol='') |
| 643 | (code, resp) = self.docmd(response) |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 644 | if code in (235, 503): |
| 645 | return (code, resp) |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 646 | raise SMTPAuthenticationError(code, resp) |
| 647 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 648 | def auth_cram_md5(self, challenge=None): |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 649 | """ Authobject to use with CRAM-MD5 authentication. Requires self.user |
| 650 | and self.password to be set.""" |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 651 | # CRAM-MD5 does not support initial-response. |
| 652 | if challenge is None: |
| 653 | return None |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 654 | return self.user + " " + hmac.HMAC( |
| 655 | self.password.encode('ascii'), challenge, 'md5').hexdigest() |
| 656 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 657 | def auth_plain(self, challenge=None): |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 658 | """ Authobject to use with PLAIN authentication. Requires self.user and |
| 659 | self.password to be set.""" |
| 660 | return "\0%s\0%s" % (self.user, self.password) |
| 661 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 662 | def auth_login(self, challenge=None): |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 663 | """ Authobject to use with LOGIN authentication. Requires self.user and |
| 664 | self.password to be set.""" |
R David Murray | b0deeb4 | 2015-11-08 01:03:52 -0500 | [diff] [blame] | 665 | if challenge is None: |
| 666 | return self.user |
| 667 | else: |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 668 | return self.password |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 669 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 670 | def login(self, user, password, *, initial_response_ok=True): |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 671 | """Log in on an SMTP server that requires authentication. |
| 672 | |
| 673 | The arguments are: |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 674 | - user: The user name to authenticate with. |
| 675 | - password: The password for the authentication. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 676 | |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 677 | Keyword arguments: |
| 678 | - initial_response_ok: Allow sending the RFC 4954 initial-response |
| 679 | to the AUTH command, if the authentication methods supports it. |
| 680 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 681 | If there has been no previous EHLO or HELO command this session, this |
| 682 | method tries ESMTP EHLO first. |
| 683 | |
| 684 | This method will return normally if the authentication was successful. |
| 685 | |
| 686 | This method may raise the following exceptions: |
| 687 | |
| 688 | SMTPHeloError The server didn't reply properly to |
| 689 | the helo greeting. |
| 690 | SMTPAuthenticationError The server didn't accept the username/ |
| 691 | password combination. |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 692 | SMTPNotSupportedError The AUTH command is not supported by the |
| 693 | server. |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 694 | SMTPException No suitable authentication method was |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 695 | found. |
| 696 | """ |
| 697 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 698 | self.ehlo_or_helo_if_needed() |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 699 | if not self.has_extn("auth"): |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 700 | raise SMTPNotSupportedError( |
| 701 | "SMTP AUTH extension not supported by server.") |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 702 | |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 703 | # Authentication methods the server claims to support |
| 704 | advertised_authlist = self.esmtp_features["auth"].split() |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 705 | |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 706 | # Authentication methods we can handle in our preferred order: |
| 707 | preferred_auths = ['CRAM-MD5', 'PLAIN', 'LOGIN'] |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 708 | |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 709 | # We try the supported authentications in our preferred order, if |
| 710 | # the server supports them. |
| 711 | authlist = [auth for auth in preferred_auths |
| 712 | if auth in advertised_authlist] |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 713 | if not authlist: |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 714 | raise SMTPException("No suitable authentication method found.") |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 715 | |
| 716 | # Some servers advertise authentication methods they don't really |
| 717 | # support, so if authentication fails, we continue until we've tried |
| 718 | # all methods. |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 719 | self.user, self.password = user, password |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 720 | for authmethod in authlist: |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 721 | method_name = 'auth_' + authmethod.lower().replace('-', '_') |
| 722 | try: |
Barry Warsaw | c5ea754 | 2015-07-09 10:39:55 -0400 | [diff] [blame] | 723 | (code, resp) = self.auth( |
| 724 | authmethod, getattr(self, method_name), |
| 725 | initial_response_ok=initial_response_ok) |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 726 | # 235 == 'Authentication successful' |
| 727 | # 503 == 'Error: already authenticated' |
| 728 | if code in (235, 503): |
| 729 | return (code, resp) |
| 730 | except SMTPAuthenticationError as e: |
| 731 | last_exception = e |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 732 | |
R David Murray | 76e13c1 | 2014-07-03 14:47:46 -0400 | [diff] [blame] | 733 | # We could not login successfully. Return result of last attempt. |
| 734 | raise last_exception |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 735 | |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 736 | def starttls(self, keyfile=None, certfile=None, context=None): |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 737 | """Puts the connection to the SMTP server into TLS mode. |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 738 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 739 | If there has been no previous EHLO or HELO command this session, this |
| 740 | method tries ESMTP EHLO first. |
| 741 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 742 | If the server supports TLS, this will encrypt the rest of the SMTP |
| 743 | session. If you provide the keyfile and certfile parameters, |
| 744 | the identity of the SMTP server and client can be checked. This, |
| 745 | however, depends on whether the socket module really checks the |
| 746 | certificates. |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 747 | |
| 748 | This method may raise the following exceptions: |
| 749 | |
| 750 | SMTPHeloError The server didn't reply properly to |
| 751 | the helo greeting. |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 752 | """ |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 753 | self.ehlo_or_helo_if_needed() |
| 754 | if not self.has_extn("starttls"): |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 755 | raise SMTPNotSupportedError( |
| 756 | "STARTTLS extension not supported by server.") |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 757 | (resp, reply) = self.docmd("STARTTLS") |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 758 | if resp == 220: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 759 | if not _have_ssl: |
| 760 | raise RuntimeError("No SSL support included in this Python") |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 761 | if context is not None and keyfile is not None: |
| 762 | raise ValueError("context and keyfile arguments are mutually " |
| 763 | "exclusive") |
| 764 | if context is not None and certfile is not None: |
| 765 | raise ValueError("context and certfile arguments are mutually " |
| 766 | "exclusive") |
Christian Heimes | d048637 | 2016-09-10 23:23:33 +0200 | [diff] [blame] | 767 | if keyfile is not None or certfile is not None: |
| 768 | import warnings |
Pablo Aguiar | 4b5e62d | 2018-11-01 11:33:35 +0100 | [diff] [blame] | 769 | warnings.warn("keyfile and certfile are deprecated, use a " |
Christian Heimes | d048637 | 2016-09-10 23:23:33 +0200 | [diff] [blame] | 770 | "custom context instead", DeprecationWarning, 2) |
Christian Heimes | 67986f9 | 2013-11-23 22:43:47 +0100 | [diff] [blame] | 771 | if context is None: |
| 772 | context = ssl._create_stdlib_context(certfile=certfile, |
| 773 | keyfile=keyfile) |
Christian Heimes | a5768f7 | 2013-12-02 20:44:17 +0100 | [diff] [blame] | 774 | self.sock = context.wrap_socket(self.sock, |
Benjamin Peterson | 7243b57 | 2014-11-23 17:04:34 -0600 | [diff] [blame] | 775 | server_hostname=self._host) |
Antoine Pitrou | f068ab8 | 2011-06-06 19:17:09 +0200 | [diff] [blame] | 776 | self.file = None |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 777 | # RFC 3207: |
| 778 | # The client MUST discard any knowledge obtained from |
| 779 | # the server, such as the list of SMTP service extensions, |
| 780 | # which was not obtained from the TLS negotiation itself. |
| 781 | self.helo_resp = None |
| 782 | self.ehlo_resp = None |
| 783 | self.esmtp_features = {} |
Ville Skyttä | da51ba4 | 2020-05-23 03:50:58 +0300 | [diff] [blame] | 784 | self.does_esmtp = False |
Benjamin Peterson | 46b32f3 | 2016-06-11 13:16:42 -0700 | [diff] [blame] | 785 | else: |
| 786 | # RFC 3207: |
| 787 | # 501 Syntax error (no parameters allowed) |
| 788 | # 454 TLS not available due to temporary reason |
| 789 | raise SMTPResponseException(resp, reply) |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 790 | return (resp, reply) |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 791 | |
Pablo Aguiar | d5fbe9b | 2018-09-08 00:04:48 +0200 | [diff] [blame] | 792 | def sendmail(self, from_addr, to_addrs, msg, mail_options=(), |
| 793 | rcpt_options=()): |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 794 | """This command performs an entire mail transaction. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 795 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 796 | The arguments are: |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 797 | - from_addr : The address sending this mail. |
| 798 | - to_addrs : A list of addresses to send this mail to. A bare |
| 799 | string will be treated as a list with 1 address. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 800 | - msg : The message to send. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 801 | - mail_options : List of ESMTP options (such as 8bitmime) for the |
| 802 | mail command. |
| 803 | - rcpt_options : List of ESMTP options (such as DSN commands) for |
| 804 | all the rcpt commands. |
| 805 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 806 | msg may be a string containing characters in the ASCII range, or a byte |
| 807 | string. A string is encoded to bytes using the ascii codec, and lone |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 808 | \\r and \\n characters are converted to \\r\\n characters. |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 809 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 810 | If there has been no previous EHLO or HELO command this session, this |
| 811 | method tries ESMTP EHLO first. If the server does ESMTP, message size |
| 812 | and each of the specified options will be passed to it. If EHLO |
| 813 | fails, HELO will be tried and ESMTP options suppressed. |
| 814 | |
| 815 | This method will return normally if the mail is accepted for at least |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 816 | one recipient. It returns a dictionary, with one entry for each |
| 817 | recipient that was refused. Each entry contains a tuple of the SMTP |
| 818 | error code and the accompanying error message sent by the server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 819 | |
| 820 | This method may raise the following exceptions: |
| 821 | |
| 822 | SMTPHeloError The server didn't reply properly to |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 823 | the helo greeting. |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 824 | SMTPRecipientsRefused The server rejected ALL recipients |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 825 | (no mail was sent). |
| 826 | SMTPSenderRefused The server didn't accept the from_addr. |
| 827 | SMTPDataError The server replied with an unexpected |
| 828 | error code (other than a refusal of |
| 829 | a recipient). |
R David Murray | cee7cf6 | 2015-05-16 13:58:14 -0400 | [diff] [blame] | 830 | SMTPNotSupportedError The mail_options parameter includes 'SMTPUTF8' |
| 831 | but the SMTPUTF8 extension is not supported by |
| 832 | the server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 833 | |
| 834 | Note: the connection will be open even after an exception is raised. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 835 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 836 | Example: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 837 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 838 | >>> import smtplib |
| 839 | >>> s=smtplib.SMTP("localhost") |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 840 | >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"] |
Martin v. Löwis | 301b1cd | 2002-07-28 16:52:01 +0000 | [diff] [blame] | 841 | >>> msg = '''\\ |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 842 | ... From: Me@my.org |
| 843 | ... Subject: testin'... |
| 844 | ... |
| 845 | ... This is a test ''' |
| 846 | >>> s.sendmail("me@my.org",tolist,msg) |
| 847 | { "three@three.org" : ( 550 ,"User unknown" ) } |
| 848 | >>> s.quit() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 849 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 850 | In the above example, the message was accepted for delivery to three |
| 851 | of the four addresses, and one was rejected, with the error code |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 852 | 550. If all addresses are accepted, then the method will return an |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 853 | empty dictionary. |
| 854 | |
| 855 | """ |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 856 | self.ehlo_or_helo_if_needed() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 857 | esmtp_opts = [] |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 858 | if isinstance(msg, str): |
| 859 | msg = _fix_eols(msg).encode('ascii') |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 860 | if self.does_esmtp: |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 861 | if self.has_extn('size'): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 862 | esmtp_opts.append("size=%d" % len(msg)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 863 | for option in mail_options: |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 864 | esmtp_opts.append(option) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 865 | (code, resp) = self.mail(from_addr, esmtp_opts) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 866 | if code != 250: |
R David Murray | d312c74 | 2013-03-20 20:36:14 -0400 | [diff] [blame] | 867 | if code == 421: |
| 868 | self.close() |
| 869 | else: |
R David Murray | afb151a | 2014-04-14 18:21:38 -0400 | [diff] [blame] | 870 | self._rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 871 | raise SMTPSenderRefused(code, resp, from_addr) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 872 | senderrs = {} |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 873 | if isinstance(to_addrs, str): |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 874 | to_addrs = [to_addrs] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 875 | for each in to_addrs: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 876 | (code, resp) = self.rcpt(each, rcpt_options) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 877 | if (code != 250) and (code != 251): |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 878 | senderrs[each] = (code, resp) |
R David Murray | d312c74 | 2013-03-20 20:36:14 -0400 | [diff] [blame] | 879 | if code == 421: |
| 880 | self.close() |
| 881 | raise SMTPRecipientsRefused(senderrs) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 882 | if len(senderrs) == len(to_addrs): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 883 | # the server refused all our recipients |
R David Murray | afb151a | 2014-04-14 18:21:38 -0400 | [diff] [blame] | 884 | self._rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 885 | raise SMTPRecipientsRefused(senderrs) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 886 | (code, resp) = self.data(msg) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 887 | if code != 250: |
R David Murray | d312c74 | 2013-03-20 20:36:14 -0400 | [diff] [blame] | 888 | if code == 421: |
| 889 | self.close() |
| 890 | else: |
R David Murray | afb151a | 2014-04-14 18:21:38 -0400 | [diff] [blame] | 891 | self._rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 892 | raise SMTPDataError(code, resp) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 893 | #if we got here then somebody got our mail |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 894 | return senderrs |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 895 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 896 | def send_message(self, msg, from_addr=None, to_addrs=None, |
Pablo Aguiar | d5fbe9b | 2018-09-08 00:04:48 +0200 | [diff] [blame] | 897 | mail_options=(), rcpt_options=()): |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 898 | """Converts message to a bytestring and passes it to sendmail. |
| 899 | |
| 900 | The arguments are as for sendmail, except that msg is an |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 901 | email.message.Message object. If from_addr is None or to_addrs is |
| 902 | None, these arguments are taken from the headers of the Message as |
| 903 | described in RFC 2822 (a ValueError is raised if there is more than |
| 904 | one set of 'Resent-' headers). Regardless of the values of from_addr and |
| 905 | to_addr, any Bcc field (or Resent-Bcc field, when the Message is a |
| 906 | resent) of the Message object won't be transmitted. The Message |
| 907 | object is then serialized using email.generator.BytesGenerator and |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 908 | sendmail is called to transmit the message. If the sender or any of |
| 909 | the recipient addresses contain non-ASCII and the server advertises the |
| 910 | SMTPUTF8 capability, the policy is cloned with utf8 set to True for the |
| 911 | serialization, and SMTPUTF8 and BODY=8BITMIME are asserted on the send. |
Berker Peksag | e39682b | 2016-07-01 12:17:05 +0300 | [diff] [blame] | 912 | If the server does not support SMTPUTF8, an SMTPNotSupported error is |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 913 | raised. Otherwise the generator is called without modifying the |
| 914 | policy. |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 915 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 916 | """ |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 917 | # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822 |
| 918 | # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However, |
| 919 | # if there is more than one 'Resent-' block there's no way to |
| 920 | # unambiguously determine which one is the most recent in all cases, |
| 921 | # so rather than guess we raise a ValueError in that case. |
| 922 | # |
| 923 | # TODO implement heuristics to guess the correct Resent-* block with an |
| 924 | # option allowing the user to enable the heuristics. (It should be |
| 925 | # possible to guess correctly almost all of the time.) |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 926 | |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 927 | self.ehlo_or_helo_if_needed() |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 928 | resent = msg.get_all('Resent-Date') |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 929 | if resent is None: |
| 930 | header_prefix = '' |
| 931 | elif len(resent) == 1: |
| 932 | header_prefix = 'Resent-' |
| 933 | else: |
| 934 | raise ValueError("message has more than one 'Resent-' header block") |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 935 | if from_addr is None: |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 936 | # Prefer the sender field per RFC 2822:3.6.2. |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 937 | from_addr = (msg[header_prefix + 'Sender'] |
| 938 | if (header_prefix + 'Sender') in msg |
| 939 | else msg[header_prefix + 'From']) |
Stéphane Wirtel | 8d83e4b | 2018-01-31 01:02:51 +0100 | [diff] [blame] | 940 | from_addr = email.utils.getaddresses([from_addr])[0][1] |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 941 | if to_addrs is None: |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 942 | addr_fields = [f for f in (msg[header_prefix + 'To'], |
| 943 | msg[header_prefix + 'Bcc'], |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 944 | msg[header_prefix + 'Cc']) |
| 945 | if f is not None] |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 946 | to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)] |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 947 | # Make a local copy so we can delete the bcc headers. |
| 948 | msg_copy = copy.copy(msg) |
| 949 | del msg_copy['Bcc'] |
| 950 | del msg_copy['Resent-Bcc'] |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 951 | international = False |
| 952 | try: |
| 953 | ''.join([from_addr, *to_addrs]).encode('ascii') |
| 954 | except UnicodeEncodeError: |
| 955 | if not self.has_extn('smtputf8'): |
| 956 | raise SMTPNotSupportedError( |
| 957 | "One or more source or delivery addresses require" |
| 958 | " internationalized email support, but the server" |
| 959 | " does not advertise the required SMTPUTF8 capability") |
| 960 | international = True |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 961 | with io.BytesIO() as bytesmsg: |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 962 | if international: |
| 963 | g = email.generator.BytesGenerator( |
| 964 | bytesmsg, policy=msg.policy.clone(utf8=True)) |
Pablo Aguiar | d5fbe9b | 2018-09-08 00:04:48 +0200 | [diff] [blame] | 965 | mail_options = (*mail_options, 'SMTPUTF8', 'BODY=8BITMIME') |
R David Murray | 8308444 | 2015-05-17 19:27:22 -0400 | [diff] [blame] | 966 | else: |
| 967 | g = email.generator.BytesGenerator(bytesmsg) |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 968 | g.flatten(msg_copy, linesep='\r\n') |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 969 | flatmsg = bytesmsg.getvalue() |
| 970 | return self.sendmail(from_addr, to_addrs, flatmsg, mail_options, |
| 971 | rcpt_options) |
| 972 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 973 | def close(self): |
| 974 | """Close the connection to the SMTP server.""" |
Serhiy Storchaka | 7e7a3db | 2015-04-10 13:24:41 +0300 | [diff] [blame] | 975 | try: |
| 976 | file = self.file |
| 977 | self.file = None |
| 978 | if file: |
| 979 | file.close() |
| 980 | finally: |
| 981 | sock = self.sock |
| 982 | self.sock = None |
| 983 | if sock: |
| 984 | sock.close() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 985 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 986 | def quit(self): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 987 | """Terminate the SMTP session.""" |
Christian Heimes | ba4af49 | 2008-03-28 00:55:15 +0000 | [diff] [blame] | 988 | res = self.docmd("quit") |
R David Murray | 0cff49f | 2014-08-30 16:51:59 -0400 | [diff] [blame] | 989 | # A new EHLO is required after reconnecting with connect() |
| 990 | self.ehlo_resp = self.helo_resp = None |
| 991 | self.esmtp_features = {} |
| 992 | self.does_esmtp = False |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 993 | self.close() |
Christian Heimes | ba4af49 | 2008-03-28 00:55:15 +0000 | [diff] [blame] | 994 | return res |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 995 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 996 | if _have_ssl: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 997 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 998 | class SMTP_SSL(SMTP): |
R David Murray | 021362d | 2013-06-23 16:05:44 -0400 | [diff] [blame] | 999 | """ This is a subclass derived from SMTP that connects over an SSL |
| 1000 | encrypted socket (to use this class you need a socket module that was |
| 1001 | compiled with SSL support). If host is not specified, '' (the local |
| 1002 | host) is used. If port is omitted, the standard SMTP-over-SSL port |
| 1003 | (465) is used. local_hostname and source_address have the same meaning |
| 1004 | as they do in the SMTP class. keyfile and certfile are also optional - |
| 1005 | they can contain a PEM formatted private key and certificate chain file |
| 1006 | for the SSL connection. context also optional, can contain a |
| 1007 | SSLContext, and is an alternative to keyfile and certfile; If it is |
| 1008 | specified both keyfile and certfile must be None. |
| 1009 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1010 | """ |
Antoine Pitrou | c1d5206 | 2011-05-07 19:39:37 +0200 | [diff] [blame] | 1011 | |
| 1012 | default_port = SMTP_SSL_PORT |
| 1013 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1014 | def __init__(self, host='', port=0, local_hostname=None, |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 1015 | keyfile=None, certfile=None, |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 1016 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 1017 | source_address=None, context=None): |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 1018 | if context is not None and keyfile is not None: |
| 1019 | raise ValueError("context and keyfile arguments are mutually " |
| 1020 | "exclusive") |
| 1021 | if context is not None and certfile is not None: |
| 1022 | raise ValueError("context and certfile arguments are mutually " |
| 1023 | "exclusive") |
Christian Heimes | d048637 | 2016-09-10 23:23:33 +0200 | [diff] [blame] | 1024 | if keyfile is not None or certfile is not None: |
| 1025 | import warnings |
Pablo Aguiar | 4b5e62d | 2018-11-01 11:33:35 +0100 | [diff] [blame] | 1026 | warnings.warn("keyfile and certfile are deprecated, use a " |
Christian Heimes | d048637 | 2016-09-10 23:23:33 +0200 | [diff] [blame] | 1027 | "custom context instead", DeprecationWarning, 2) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1028 | self.keyfile = keyfile |
| 1029 | self.certfile = certfile |
Christian Heimes | 67986f9 | 2013-11-23 22:43:47 +0100 | [diff] [blame] | 1030 | if context is None: |
| 1031 | context = ssl._create_stdlib_context(certfile=certfile, |
| 1032 | keyfile=keyfile) |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 1033 | self.context = context |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 1034 | SMTP.__init__(self, host, port, local_hostname, timeout, |
Dong-hee Na | 62e3973 | 2020-01-14 16:49:59 +0900 | [diff] [blame] | 1035 | source_address) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1036 | |
| 1037 | def _get_socket(self, host, port, timeout): |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 1038 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 1039 | self._print_debug('connect:', (host, port)) |
Dong-hee Na | 62e3973 | 2020-01-14 16:49:59 +0900 | [diff] [blame] | 1040 | new_socket = super()._get_socket(host, port, timeout) |
Christian Heimes | a5768f7 | 2013-12-02 20:44:17 +0100 | [diff] [blame] | 1041 | new_socket = self.context.wrap_socket(new_socket, |
Benjamin Peterson | 7243b57 | 2014-11-23 17:04:34 -0600 | [diff] [blame] | 1042 | server_hostname=self._host) |
R. David Murray | 87e2074 | 2009-05-23 01:30:26 +0000 | [diff] [blame] | 1043 | return new_socket |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 1044 | |
| 1045 | __all__.append("SMTP_SSL") |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 1046 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1047 | # |
| 1048 | # LMTP extension |
| 1049 | # |
| 1050 | LMTP_PORT = 2003 |
| 1051 | |
| 1052 | class LMTP(SMTP): |
| 1053 | """LMTP - Local Mail Transfer Protocol |
| 1054 | |
| 1055 | The LMTP protocol, which is very similar to ESMTP, is heavily based |
R David Murray | 021362d | 2013-06-23 16:05:44 -0400 | [diff] [blame] | 1056 | on the standard SMTP client. It's common to use Unix sockets for |
| 1057 | LMTP, so our connect() method must support that as well as a regular |
R David Murray | 36beb66 | 2013-06-23 15:47:50 -0400 | [diff] [blame] | 1058 | host:port server. local_hostname and source_address have the same |
R David Murray | 021362d | 2013-06-23 16:05:44 -0400 | [diff] [blame] | 1059 | meaning as they do in the SMTP class. To specify a Unix socket, |
| 1060 | you must use an absolute path as the host, starting with a '/'. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1061 | |
| 1062 | Authentication is supported, using the regular SMTP mechanism. When |
| 1063 | using a Unix socket, LMTP generally don't support or require any |
| 1064 | authentication, but your mileage might vary.""" |
| 1065 | |
| 1066 | ehlo_msg = "lhlo" |
| 1067 | |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 1068 | def __init__(self, host='', port=LMTP_PORT, local_hostname=None, |
Dong-hee Na | 65a5ce2 | 2020-01-15 06:42:09 +0900 | [diff] [blame] | 1069 | source_address=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1070 | """Initialize a new instance.""" |
Dong-hee Na | 62e3973 | 2020-01-14 16:49:59 +0900 | [diff] [blame] | 1071 | super().__init__(host, port, local_hostname=local_hostname, |
Dong-hee Na | 65a5ce2 | 2020-01-15 06:42:09 +0900 | [diff] [blame] | 1072 | source_address=source_address, timeout=timeout) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1073 | |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 1074 | def connect(self, host='localhost', port=0, source_address=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1075 | """Connect to the LMTP daemon, on either a Unix or a TCP socket.""" |
| 1076 | if host[0] != '/': |
Dong-hee Na | 62e3973 | 2020-01-14 16:49:59 +0900 | [diff] [blame] | 1077 | return super().connect(host, port, source_address=source_address) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1078 | |
Dong-hee Na | 65a5ce2 | 2020-01-15 06:42:09 +0900 | [diff] [blame] | 1079 | if self.timeout is not None and not self.timeout: |
| 1080 | raise ValueError('Non-blocking socket (timeout=0) is not supported') |
| 1081 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1082 | # Handle Unix-domain sockets. |
| 1083 | try: |
| 1084 | self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) |
Dong-hee Na | 65a5ce2 | 2020-01-15 06:42:09 +0900 | [diff] [blame] | 1085 | self.sock.settimeout(self.timeout) |
Antoine Pitrou | f068ab8 | 2011-06-06 19:17:09 +0200 | [diff] [blame] | 1086 | self.file = None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1087 | self.sock.connect(host) |
Andrew Svetlov | 2ade6f2 | 2012-12-17 18:57:16 +0200 | [diff] [blame] | 1088 | except OSError: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 1089 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 1090 | self._print_debug('connect fail:', host) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1091 | if self.sock: |
| 1092 | self.sock.close() |
| 1093 | self.sock = None |
Andrew Svetlov | b6693c4 | 2012-12-17 18:54:53 +0200 | [diff] [blame] | 1094 | raise |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1095 | (code, msg) = self.getreply() |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 1096 | if self.debuglevel > 0: |
R David Murray | 0c49b89 | 2015-04-16 17:14:42 -0400 | [diff] [blame] | 1097 | self._print_debug('connect:', msg) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1098 | return (code, msg) |
| 1099 | |
| 1100 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 1101 | # Test the sendmail method, which tests most of the others. |
| 1102 | # Note: This always sends to localhost. |
| 1103 | if __name__ == '__main__': |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 1104 | def prompt(prompt): |
| 1105 | sys.stdout.write(prompt + ": ") |
Ezio Melotti | 6bfecd1 | 2011-10-18 13:20:07 +0300 | [diff] [blame] | 1106 | sys.stdout.flush() |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 1107 | return sys.stdin.readline().strip() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 1108 | |
| 1109 | fromaddr = prompt("From") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 1110 | toaddrs = prompt("To").split(',') |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1111 | print("Enter message, end with ^D:") |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 1112 | msg = '' |
| 1113 | while 1: |
| 1114 | line = sys.stdin.readline() |
| 1115 | if not line: |
| 1116 | break |
| 1117 | msg = msg + line |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1118 | print("Message length is %d" % len(msg)) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 1119 | |
| 1120 | server = SMTP('localhost') |
| 1121 | server.set_debuglevel(1) |
| 1122 | server.sendmail(fromaddr, toaddrs, msg) |
| 1123 | server.quit() |