Email settings resources
Get email settings
GET /settings/email
Response
{
"enabled": true,
"fix_sender": "holmes@example.com",
"sender_domain": "example.com",
"sender_name": "Sherlock Holmes",
"reply_to": "watson@example.com",
"reply_to_name": "John Watson",
"tech_support": "techsupport@example.com",
"feedback_to": "feedback@example.com",
"footer_reply_to": "reply_to@example.com"
}
Update email settings
PUT /settings/email
Note:
If a setting key is omitted the setting is ignored. If the value for a setting is set to null
the respective setting is reset to its default value.
Parameter | Type | Default | Description |
---|---|---|---|
enabled |
boolean |
false | |
fix_sender |
email |
- | If setting is set all emails are sent from this email address |
sender_domain |
domain |
starmind.mail.defaultSenderDomain from application.conf | If fix_sender is not set all emails are sent from this domain. |
sender_name |
string |
starmind.mail.defaultSenderName from application.conf | Email sender name |
reply_to |
email |
starmind.mail.defaultReplyTo from application.conf | Email address for the email reply-to header |
reply_to_name |
string |
starmind.mail.defaultReplyToName from application.conf | Name for the email reply-to header |
tech_support |
string |
support@starmind.com | Email contact for technical support. Displayed on error pages. |
feedback_to |
string |
starmind.mail.defaultReplyTo from application.conf | Recipient of feedback emails |
footer_reply_to |
string |
support@starmind.com | Email address which is displayed in email footer. |
Response
{
"enabled": true,
"fix_sender": "holmes@example.com",
"sender_domain": "example.com",
"sender_name": "Sherlock Holmes",
"reply_to": "watson@example.com",
"reply_to_name": "John Watson",
"tech_support": "techsupport@example.com",
"feedback_to": "feedback@example.com",
"footer_reply_to": "reply_to@example.com"
}