asyncio SMTP client
aiosmtplib is an SMTP client for use with asyncio.
import asyncio import aiosmtplib loop = asyncio.get_event_loop() smtp = aiosmtplib.SMTP(hostname='localhost', port=1025, loop=loop) loop.run_until_complete(smtp.connect()) async def send_a_message(): sender = 'root@localhost' recipient = 'somebody@localhost' message = "Hello World" await smtp.sendmail(sender, [recipient], message) loop.run_until_complete(send_a_message())
Python 3.5+, compiled with SSL support, is required.
Initialize a new aiosmtplib.SMTP instance, then run its connect coroutine. Unlike in smtplib, initializing an instance does not automatically connect to the server, as that is a blocking operation.
Allowed arguments to initialize the client (or the connect method):
Use SMTP.sendmail to send raw messages. Allowed arguments are:
Use SMTP.send_message to send email.message.Message objects.
All commands accept a timeout keyword argument of a numerical value in seconds. This value is used for all socket operations, and will raise STMPTimeoutError if exceeded. Timeout values passed to init or connect will be used as the default value for commands executed on the connection.
The default timeout is 60 seconds.
Many SMTP servers support the STARTTLS extension over port 587. To connect to one of these, set use_tls to False, and call starttls on the client.
loop = asyncio.get_event_loop() smtp = aiosmtplib.SMTP( hostname='smtp.gmail.com', port=587, loop=loop, use_tls=False) loop.run_until_complete(smtp.connect()) loop.run_until_complete(smtp.starttls())
SMTP is a sequential protocol. Multiple commands must be sent to send an email, and they must be sent in the correct sequence. As a consequence of this, executing multiple sendmail tasks in parallell (i.e. with asyncio.gather) is not any more efficient than executing in sequence, as the client must wait until one mail is sent before beginning the next.
If you have a lot of emails to send, consider creating multiple connections (SMTP instances) and splitting the work between them.
aiosmtplib is now feature complete, however test coverage and documentation need a lot of work. Feature requests and bug reports are welcome via Github issues.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|aiosmtplib-1.0.1-py3-none-any.whl (24.9 kB) Copy SHA256 Checksum SHA256||py3||Wheel||Apr 7, 2017|
|aiosmtplib-1.0.1.tar.gz (19.4 kB) Copy SHA256 Checksum SHA256||–||Source||Apr 7, 2017|