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 (Gmail) Yes (Custom SMTP) | |
| to_emailTest destination for | List of all | email sendthe email addresses that will be recipients of the emails sent. | - | stringlist | 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
| Table of Contents | ||
|---|---|---|
|
Example
| Code Block | ||
|---|---|---|
| ||
POST /es/api/v1/mailer/send
Content-Type: application/json
{
"from_email": "[email protected]",
"to_email": "user@example["[email protected]", "recipient2@mail.com"],
"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"
}
]
} |
Gmail extra configuration
If you intend to use Gmail as the SMTP server for this mailer, be sure to have the email (and Google) account ready for it.
Because if you configure the Mailer section with an email and it's correct password, this issue is going to appear:
This is because Google enforces the usage of Application passwords when allowing access to an account instead of the Account Password.
To enable this Application password you need to follow these steps:
- Enable the Two-Factor Authentication (if not enabled).
- Go to Security settings in your account.
- On the Section "Signing in to Google" there is the option to enable the 2-step authentication.
- Follow the steps and enable the authentication.
- Create an Application Password.
- Go to the Application Passwords section.
- Generate a new "Other (Custom name)" password.
- Enter a name for the new app password.
- Click on "Generate"
- This will generate a 16 characters password that is the one you need to use in the GAIA API configuration file.
- NOTE: This password is only shown once, so, save it somewhere safe!
- Add the new application password to the configuration of SearchAPI.
Overview
Content Tools