`smtplib` --- SMTP 協定用戶端¶

原始碼：Lib/smtplib.py

The smtplib module defines an SMTP client session object that can be used to send mail to any internet machine with an SMTP or ESMTP listener daemon. For details of SMTP and ESMTP operation, consult RFC 821 (Simple Mail Transfer Protocol) and RFC 1869 (SMTP Service Extensions).

可用性: not WASI.

此模組在 WebAssembly 平台上不起作用或無法使用。更多資訊請參閱 WebAssembly 平台。

class smtplib.SMTP(host='', port=0, local_hostname=None, [timeout, ]source_address=None)¶

An SMTP instance encapsulates an SMTP connection. It has methods that support a full repertoire of SMTP and ESMTP operations. If the optional host and port parameters are given, the SMTP connect() method is called with those parameters during initialization. If specified, local_hostname is used as the FQDN of the local host in the HELO/EHLO command. Otherwise, the local hostname is found using socket.getfqdn(). If the connect() call returns anything other than a success code, an SMTPConnectError is raised. The optional timeout parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). If the timeout expires, TimeoutError is raised. The optional source_address parameter allows binding to some specific source address in a machine with multiple network interfaces, and/or to some specific source TCP port. It takes a 2-tuple (host, port), for the socket to bind to as its source address before connecting. If omitted (or if host or port are '' and/or 0 respectively) the OS default behavior will be used.

For normal use, you should only require the initialization/connect, sendmail(), and SMTP.quit() methods. An example is included below.

The SMTP class supports the with statement. When used like this, the SMTP QUIT command is issued automatically when the with statement exits. E.g.:

>>> from smtplib import SMTP
>>> with SMTP("domain.org") as smtp:
...     smtp.noop()
...
(250, b'Ok')
>>>

所有指令都會引發一個附帶引數 self、data 的稽核事件 smtplib.SMTP.send，其中 data 為即將傳送至遠端的位元組。

在 3.3 版的變更: 新增對 with 陳述式的支援。

在 3.3 版的變更: 新增 source_address 引數。

在 3.5 版被加入: The SMTPUTF8 extension (RFC 6531) is now supported.

在 3.9 版的變更: If the timeout parameter is set to be zero, it will raise a ValueError to prevent the creation of a non-blocking socket.

class smtplib.SMTP_SSL(host='', port=0, local_hostname=None, *, [timeout, ]context=None, source_address=None)¶: An SMTP_SSL instance behaves exactly the same as instances of SMTP. SMTP_SSL should be used for situations where SSL is required from the beginning of the connection and using starttls() is not appropriate. If host is not specified, the local host is used. If port is zero, the standard SMTP-over-SSL port (465) is used. The optional arguments local_hostname, timeout and source_address have the same meaning as they do in the SMTP class. context, also optional, can contain a SSLContext and allows configuring various aspects of the secure connection. Please read Security considerations for best practices.

在 3.3 版的變更: 新增 context。

在 3.3 版的變更: 新增 source_address 引數。

在 3.4 版的變更: The class now supports hostname check with ssl.SSLContext.check_hostname and Server Name Indication (see ssl.HAS_SNI).

在 3.9 版的變更: If the timeout parameter is set to be zero, it will raise a ValueError to prevent the creation of a non-blocking socket

在 3.12 版的變更: The deprecated keyfile and certfile parameters have been removed.

class smtplib.LMTP(host='', port=LMTP_PORT, local_hostname=None, source_address=None[, timeout])¶

The LMTP protocol, which is very similar to ESMTP, is heavily based on the standard SMTP client. It's common to use Unix sockets for LMTP, so our connect() method must support that as well as a regular host:port server. The optional arguments local_hostname and source_address have the same meaning as they do in the SMTP class. To specify a Unix socket, you must use an absolute path for host, starting with a '/'.

Authentication is supported, using the regular SMTP mechanism. When using a Unix socket, LMTP generally don't support or require any authentication, but your mileage might vary.

在 3.9 版的變更: 新增 timeout 選用參數。

A nice selection of exceptions is defined as well:

exception smtplib.SMTPException¶: Subclass of OSError that is the base exception class for all the other exceptions provided by this module.

在 3.4 版的變更: SMTPException became subclass of OSError

exception smtplib.SMTPServerDisconnected¶: This exception is raised when the server unexpectedly disconnects, or when an attempt is made to use the SMTP instance before connecting it to a server.

exception smtplib.SMTPResponseException¶

Base class for all exceptions that include an SMTP error code. These exceptions are generated in some instances when the SMTP server returns an error code.

smtp_code¶: The error code.

smtp_error¶: The error message.

exception smtplib.SMTPSenderRefused¶: Sender address refused. In addition to the attributes set by on all SMTPResponseException exceptions, this sets 'sender' to the string that the SMTP server refused.

exception smtplib.SMTPRecipientsRefused¶

All recipient addresses refused.

recipients¶: A dictionary of exactly the same sort as returned by SMTP.sendmail() containing the errors for each recipient.

exception smtplib.SMTPDataError¶: The SMTP server refused to accept the message data.

exception smtplib.SMTPConnectError¶: Error occurred during establishment of a connection with the server.

exception smtplib.SMTPHeloError¶

smtplib --- SMTP 協定用戶端¶

`smtplib` --- SMTP 協定用戶端¶