mirror of
https://github.com/vinta/awesome-python.git
synced 2026-11-20 06:40:51 +00:00
docs: rewrite Email category intro
The intro predated the 2026-10-02 audit and did not mention the newly added aiosmtplib and django-anymail. Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
94ff7b202f
commit
0c0597c8d2
1 changed files with 9 additions and 6 deletions
|
|
@ -1,11 +1,14 @@
|
|||
One function call sends mail through Gmail or another SMTP server with yagmail. This Python email library aims to make sending mail painless.
|
||||
Sending from Django, you learn no new Python email library API: django-anymail runs send_mail(). aiosmtplib and yagmail handle async code and Gmail scripts.
|
||||
|
||||
How to choose:
|
||||
|
||||
- Gmail: yagmail, with an app password or OAuth2
|
||||
- Another SMTP server: yagmail, pointed at its host
|
||||
- An asyncio app: yagmail's async client
|
||||
- A Django app sending through Amazon SES, Mailgun, Postmark, or another email service: django-anymail
|
||||
- A Django app that tracks delivery or receives email through that service: django-anymail
|
||||
- Async code talking to an SMTP server: aiosmtplib
|
||||
- A script sending from Gmail, or any SMTP account, with attachments: yagmail
|
||||
|
||||
yagmail is a [wrapper around smtplib's SMTP connection](https://yagmail.readthedocs.io/en/latest/api.html#yagmail.Client) that connects to Gmail unless you pass another `host`. It builds the message for you: call `send()` with the recipients, a subject, and `contents`, a list whose strings it [reads as a local file, HTML, or text](https://yagmail.readthedocs.io/en/latest/usage.html#magical-contents). So one call sends text, HTML, and attachments. Wrap a string in `yagmail.raw` when it must stay plain text. In asyncio code, use its async client [as an async context manager](https://yagmail.readthedocs.io/en/latest/usage.html#starting-and-closing-connections).
|
||||
django-anymail extends Django's `django.core.mail` with features email services add, through [one API that doesn't lock your code to one service](https://anymail.dev/en/latest/). [Change Django's email backend to Anymail's backend for your service](https://anymail.dev/en/latest/installation/), and [`send_mail()`, `EmailMessage`, and even `mail_admins()`](https://anymail.dev/en/latest/sending/django_email/) send through it unchanged. Send from a background task, not the view: Anymail calls that a [best practice for sending email from Django](https://anymail.dev/en/latest/tips/transient_errors/), since your views respond faster. To track delivery or receive email, connect the service's webhooks to [Anymail's Django signals](https://anymail.dev/en/latest/sending/tracking/), and [protect them with https and a shared secret](https://anymail.dev/en/latest/tips/securing_webhooks/).
|
||||
|
||||
Keep your password out of your script. Install `yagmail[all]` to get keyring, then [register your credentials once](https://yagmail.readthedocs.io/en/latest/setup.html#configuring-credentials) with `yagmail.register()`, and yagmail reads them from your system keyring. For Gmail, that password is an app password. For credentials you can revoke, [use OAuth2](https://yagmail.readthedocs.io/en/latest/setup.html#using-oauth2): whoever gets its token file can send mail, but nothing else.
|
||||
aiosmtplib is an [async version of smtplib](https://aiosmtplib.readthedocs.io/en/latest/), with similar APIs. Build each message as the standard library's `EmailMessage`, which makes headers easier to work with. Then pass it to the [`send()` coroutine](https://aiosmtplib.readthedocs.io/en/latest/usage.html), which the docs recommend for most use cases.
|
||||
|
||||
yagmail aims to make sending email as simple as possible, with Gmail as its default server. Its [contents argument is guessed](https://yagmail.readthedocs.io/en/latest/usage.html#magical-contents) item by item: a path to a local file becomes an attachment, valid HTML becomes HTML, and anything else is text. For Gmail, sign in with an [app password or OAuth2](https://github.com/kootenpv/yagmail).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue