Mailer micro-service for vandeas
To run this project, you will need to add the following environment variables
CONTACT_FORM_CONFIGS_FOLDER: An existing folder in your file system where the contact form configs will be stored.MAIL_CONFIGS_FOLDER: An existing folder in your file system where the email configs will be stored.TEMPLATES_FOLDER: An existing folder in your file system where the email templates will be stored.GOOGLE_RECAPTCHA_SECRET: A Google ReCaptcha secret (required only when using forms).
SendgridRemoved due to lack of support for batch emails requests- Resend
- Custom SMTP server, that can be configured in the email & contact form configs
Resend-based config
{
"id": "UUID",
"dailyLimit": 10,
"destination": "[email protected]",
"sender": "[email protected]",
"threshold": 0.5, // Recapthca score thresold
"lang": "fr", // ISO 639-1
"subjectTemplate": "New mail from {{form.firstName}}",
"provider": "RESEND",
"apiKey": "<YOUR_RESEND_API_KEY>"
}SMTP-based config
{
"id": "UUID",
"dailyLimit": 10,
"destination": "[email protected]",
"sender": "[email protected]",
"threshold": 0.5, // Recapthca score thresold
"lang": "fr", // ISO 639-1
"subjectTemplate": "New mail from {{form.firstName}}",
"provider": "SMTP",
"username": "<SMTP_USERNAME>",
"password": "<SMTP_PASSWORD>",
"smtpHost": "<SMTP_SERVER_IP>",
"smtpPort": "<SMTP_SERVER_PORT>"
}Filename does not have to respect any convention.
Resend-based config
{
"id": "UUID",
"sender": "[email protected]",
"subjectTemplate": "New mail from {{form.firstName}}",
"provider": "RESEND",
"apiKey": "<YOUR_RESEND_API_KEY>"
}SMTP-based config
{
"id": "UUID",
"sender": "[email protected]",
"subjectTemplate": "New mail from {{form.firstName}}",
"provider": "SMTP",
"username": "<SMTP_USERNAME>",
"password": "<SMTP_PASSWORD>",
"smtpHost": "<SMTP_SERVER_IP>",
"smtpPort": "<SMTP_SERVER_PORT>"
}Filename should be {{UUID}}.hbs (same UUID as the id field in the Contact Form or Mail config)
POST /v1/mail/contact
| Attribute | Type | Description |
|---|---|---|
id |
string |
Required. Your contact form config id |
fullName |
string |
Required Full name of the person that sent the form |
email |
string |
Required Email of the person that sent the form |
content |
string |
Required Content of the message |
recaptchaToken |
string |
Required Result token/secret of recaptcha |
POST /v1/mail
| Attribute | Type | Description |
|---|---|---|
id |
string |
Required. Your mail config id |
email |
string |
Required Email of the person to sent the mail to |
attributes |
Map<string, string> / JSON Object |
Required Attributes to hydrate the mail template |
POST /v1/mail/batch
| Attribute | Type | Description |
|---|---|---|
mails |
Array<Mail> |
Required. Array of mails to send |
[
{
"id": "UUID", // Mail config id
"email": "[email protected]",
"attributes": {
"firstName": "John",
"lastName": "Doe"
}
}
]- Better templating system (currently stored in /resources/templates)
- Endpoint to send email
- Watch and reload configuration files and templates
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent