Skip to main content

asyncio SMTP client

Project description

"aiosmtplib TravisCI build status" codecov "aiosmtplib on the Python Package Index" pypi-python-versions pypi-status pypi-license "Code style: black"


aiosmtplib is an asynchronous SMTP client for use with asyncio.

For documentation, see Read The Docs.

Quickstart

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"] = "somebody@example.com"
message["Subject"] = "Hello World!"

loop.run_until_complete(smtp.send_message(message))

Requirements

Python 3.5.2+, compiled with SSL support, is required.

Connecting to an SMTP Server

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))

Connecting over TLS/SSL

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())

STARTTLS connections

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())

Sending messages

SMTP.send_message

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"] = "somebody@example.com"
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.

SMTP.sendmail

Use sendmail to send raw messages.

sender = "root@localhost"
recipients = ["somebody@example.com"]
message = """To: somebody@example.com
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 reporting

Bug reports (and feature requests) are welcome via Github issues.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aiosmtplib, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size aiosmtplib-1.0.4-py3-none-any.whl (23.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aiosmtplib-1.0.4.tar.gz (44.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page