aiosmtplib is an asynchronous SMTP client for use with asyncio.
For documentation, see Read The Docs.
import asyncio
from email.mime.text import MIMEText
import aiosmtplib
loop = asyncio.get_event_loop()
smtp = aiosmtplib.SMTP(hostname="127.0.0.1", port=1025, loop=loop)
loop.run_until_complete(smtp.connect())
message = MIMEText("Sent via aiosmtplib")
message["From"] = "root@localhost"
message["To"] = "[email protected]"
message["Subject"] = "Hello World!"
loop.run_until_complete(smtp.send_message(message))
Python 3.5.2+, compiled with SSL support, is required.
Initialize a new SMTP
instance, then await its connect
coroutine. Initializing an instance does not automatically connect to the server, as that is a blocking operation.
client = SMTP()
loop = asyncio.get_event_loop()
loop.run_until_complete(client.connect(hostname="localhost", port=25))
If an SMTP server supports direct connection via TLS/SSL, pass use_tls=True
when initializing the SMTP instance (or when calling connect
).
loop = asyncio.get_event_loop()
smtp = aiosmtplib.SMTP(hostname="smtp.gmail.com", port=465, loop=loop, use_tls=True)
loop.run_until_complete(smtp.connect())
Many SMTP servers support the STARTTLS extension over port 587. When using STARTTLS, the initial connection is made over plaintext, and after connecting a STARTTLS command is sent which initiates the upgrade to a secure connection. To connect to a server that uses STARTTLS, set use_tls
to False
when connecting, 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())
Use send_message
to send email.message.Message
objects.
from email.mime.text import MIMEText
message = MIMEText("Sent via aiosmtplib")
message["From"] = "root@localhost"
message["To"] = "[email protected]"
message["Subject"] = "Hello World!"
loop = asyncio.get_event_loop()
loop.run_until_complete(smtp.send_message(message))
This is the simplest API, and is the recommended way to send messages, as it makes it easy to set headers correctly and handle multi part messages. For details on creating email.message.Message
objects, see the stdlib documentation examples.
Use sendmail
to send raw messages.
sender = "root@localhost"
recipients = ["[email protected]"]
message = """To: [email protected]
From: root@localhost
Subject: Hello World!
Sent via aiosmtplib
"""
loop = asyncio.get_event_loop()
loop.run_until_complete(smtp.sendmail(sender, recipients, message))
Note that when using this method, you must format the message headers yourself.
Bug reports (and feature requests) are welcome via Github issues.