SMTP 模块 ¶

At the heart of this module is the SMTP 类在 aiosmtpd.smtp module. This class implements the RFC 5321 Simple Mail Transport Protocol. Often you won’t run an SMTP instance directly, but instead will use a Controller instance to run the server in a subthread.

>>> from aiosmtpd.controller import Controller

SMTP class is itself a subclass of StreamReaderProtocol

子类化 ¶

While behavior for common SMTP commands can be specified using handlers , more complex specializations such as adding custom SMTP commands require subclassing the SMTP 类。

For example, let’s say you wanted to add a new SMTP command called PING . All methods implementing SMTP commands are prefixed with smtp_ ; they must also be coroutines. Here’s how you could implement this use case:

>>> import asyncio
>>> from aiosmtpd.smtp import SMTP as Server, syntax
>>> class MyServer(Server):
...     @syntax('PING [ignored]')
...     async def smtp_PING(self, arg):
...         await self.push('259 Pong')

Now let’s run this server in a controller:

>>> from aiosmtpd.handlers import Sink
>>> class MyController(Controller):
...     def factory(self):
...         return MyServer(self.handler)
>>> controller = MyController(Sink())
>>> controller.start()

We can now connect to this server with an SMTP client.

>>> from smtplib import SMTP as Client
>>> client = Client(controller.hostname, controller.port)

Let’s ping the server. Since the PING command isn’t an official SMTP command, we have to use the lower level interface to talk to it.

>>> code, message = client.docmd('PING')
>>> code
259
>>> message
b'Pong'

Because we prefixed the smtp_PING() method with the @syntax() decorator, the command shows up in the HELP output.

>>> print(client.help().decode('utf-8'))
Supported commands: AUTH DATA EHLO HELO HELP MAIL NOOP PING QUIT RCPT RSET VRFY

And we can get more detailed help on the new command.

>>> print(client.help('PING').decode('utf-8'))
Syntax: PING [ignored]

Don’t forget to stop() the controller when you’re done.

>>> controller.stop()

服务器挂钩 ¶

警告

These methods are deprecated. See handler hooks 代替。

SMTP server class also implements some hooks which your subclass can override to provide additional responses.

ehlo_hook()
rset_hook()

aiosmtpd.smtp ¶

aiosmtpd.smtp. AuthenticatorType = Callable[[SMTP, Session, Envelope, str, Any], AuthResult] ¶

@ aiosmtpd.smtp. auth_mechanism ( actual_name ) ¶
参数

This decorator specifies the actual name of the AUTH Mechanism implemented by the method being decorated, regardless of the method’s name.

重要

The decorated method’s name MUST still start with auth_

class aiosmtpd.smtp. AuthResult ¶

class aiosmtpd.smtp. LoginPassword ( login : bytes , password : bytes ) ¶

class aiosmtpd.smtp. SMTP ( handler , * , data_size_limit = 33554432 , enable_SMTPUTF8 = False , decode_data = False , hostname = None , ident = None , tls_context = None , require_starttls = False , timeout = 300 , auth_required = False , auth_require_tls = True , auth_exclude_mechanism = None , auth_callback = None , authenticator = None , command_call_limit = None , proxy_protocol_timeout = None , loop = None ) ¶: 参数

handler ¶
data_size_limit : int = 33554432

enable_SMTPUTF8 : bool = False

decode_data : bool = False ¶

line_length_limit ¶

SMTP 模块 ¶

子类化 ¶

服务器挂钩 ¶

aiosmtpd.smtp ¶

启用 STARTTLS ¶