Page History
If configure, mailer allows to send emails through an Mail Server, its configuration can be found on the config.py file.
| Warning |
|---|
Only available when mailer is set |
The mail body request is represented by the following model
| Property | Description | Default | Type | Required |
|---|---|---|---|---|
| from_email | From to display in the email | [email protected] | string | No |
| to_email | Test destination for all email send | - | string | Yes |
| subject | Subject, if none is defined in configuration | Email Subject | string | No |
| data_url | URL to be added to the message | http://example.com/ | string | No |
| username | Username used in the mail body | - | string | Yes |
| Tip |
|---|
The body of the mail can be modified here models/api/mailer.py |
Send Email
Use this endpoint to send an email through the Mail Server. It requires authentication and expects a JSON request body with specific parameters.
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string |
| Table of Contents | ||
|---|---|---|
|
Example
| Code Block | ||
|---|---|---|
| ||
POST /es/api/v1/mailer/send
Content-Type: application/json
{
"from_email": "[email protected]",
"to_email": "[email protected]",
"subject": "Hello",
"data_url": "http://example.com/",
"username": "John"
} |
Response
Successful Response [200]
| Code Block |
|---|
"Email sent successfully" |
Validation Error [422]
| Code Block |
|---|
{
"detail": [
{
"loc": ["body", "to_email"],
"msg": "Field required",
"type": "value_error.missing"
}
]
} |
Overview
Content Tools