An easy way to send templated emails using an HTTP interface
Project description
Petit Mail
This app provides an easy way to send templated mails.
It implements and handles classic SMTP handlers and google-oauth2 handlers.
Using Jinja2 and premailer it can easily template an email and it's subject.
This lib aims to provide a solid base to build more complex service out of it.
The make_server function will return a prepared instance of FastAPI for later user. It is advised to run this app with uvicorn or gunicorn.
Endpoints
POST /send_mail/<_type: Literal['plain', 'html']>
Cet endpoint permet d'envoyer un mail :
{
"data"?:{},
"template_name"?:"",
"content"?:"mail content",
"subject"?:"mail subject",
"from":"sender adress",
"addresses":[]
}
if _type == 'html' then the mail will be templated with the data contained under the data key.
if _type == 'plain' then the mail won't be templated and the content under the content key will be used
GET /reload
Reloads all the template of the server without restarting the server.
How to write a template
This lib uses the Jinja2 template engine, so you can refer to the Jinja2 documentation for the syntax.
There is however, one diffence, in an effort to be concise the subject and the body of each template are in the same file.
So you have to put the subject of the email between this two balises: '' and ''
The body of the email should then be between this two balises: '<mail_content>' and '</mail_content>'
example :
<subject>
Docker | Backup Failed
</subject>
<mail_content>
<body>
{% from "common/centered_button.html" import centered_button %} {% from "common/card.html" import card %} {% call card("La sauvegarde a échouée") %}
<div style="white-space: pre-wrap">
The backup failed at {{data.operation_date}}, if the problem persists, contact an administrator
</div>
<br /> {{ centered_button("Example Incorporation", "https://example.com") }}
<br> Sysadmins {% endcall %}
</body>
</mail_content>
How to reuse components
In order to make a component reusable, you have to place it into the common directory, and you don't have to use the special and <mail_content> balises.
Configuration
Most of the configuration is held in the conf.yaml file.
There are 2 things to configure, the template_provider and the emails senders:
The infos for the template provider are located under the templates key.
Two providers are provided with the library, an S3 provider and a local provider.
They can be used by using the string values 's3' or 'local'. You can see below an example of settings for both types.
exemple :
templates:
# minio doesn't support the last options
s3:
host: documents.staging.example.com
pass_key: password
access_key: key
bucket_name: mail-templates
local:
folder: templates
exemple :
creds:
example:
type: gmail
email: example@example.com
refresh_token: <>
client_id: <>
client_secret: <>
info:
type: gmail
email: info@example.com
refresh_token: <>
client_id: <>
client_secret: <>
# note that here with smtp support it's not the same keys
info2:
type: smtp
email: info@example.com
password: <>
server: <>
server_port: <>
How to get your tokens ?
- Activate your Gmail API keys in the Gmail console
- Get the
credentials.jsonfrom the Gmail console - use the
make_token.pyscript from thegoogle_token_utilsfolder
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file petit_mail-0.1.3.tar.gz.
File metadata
- Download URL: petit_mail-0.1.3.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 692ab38eaa6024a281b50c35b339cbd22b1de896e5f3e2ac16889501314a47d5 |
|
| MD5 | 63cfc6aa3fc34e3064542cf83c1e364c |
|
| BLAKE2b-256 | 2124afcb462daf2445335dad0b4fa1bea5ae78a501f4b731cacee698fd3b050b |
File details
Details for the file petit_mail-0.1.3-py2.py3-none-any.whl.
File metadata
- Download URL: petit_mail-0.1.3-py2.py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4fcf94afe846f43e26797756ce3d4b8ca8379f34de455e342e2c234f000fe801 |
|
| MD5 | b7c0bf72eef56ee832275a1b6a856172 |
|
| BLAKE2b-256 | 8dd182bb52c0410b42c17580a7556804dbb10da7dbfeb3a71259b216f8ab9575 |
