. . .

Emailing

ApiOmat sends eMails automatically during several events. By default, all emails are sent as plain text, whereas the used SMTP server and some static content can be configured in detail.

Plaintext Emailing

ApiOmat supports sending emails internally using an arbitray SMTP server. First of all, a valid SMTP server has to be configured in apiomat.yaml file using the following settings:

apiomat.yaml
common:
emails:
# the email's sender address ("from") used to send admin emails
admin: admin@apiomat.com
# the support-email address (e.g. used as sender for "forgot password"-requests)
support: support@apiomat.com
# the noreply-email address
noreply: noreply@apiomat.com
# the message footer for emails if not sent over mandrill
footer:
# debug option to print verbose information during email sending
debug: true
# Hostname of the SMTP server
host: localhost
# Username if authentication on SMTP server is necessary
#user:
# Password if authentication on SMTP server is necessary
#password:
# Port of the SMTP server
port: 25
# TRUE if authentication is needed in SMTP server
useAuth: false
# TRUE if SSL connection should be used
useSsl: false
# TRUE if STARTTLS should be used
useStarttls: false

The admin, support and noreply keys are related to the sender displayed in the receivers email. A footer can be set as a plain text string which will be attached to every email sent.

If the debug option is set to true, the ApiOmat logs will contain much information about the sending process and eventual failure data.

All other settings are related to the SMTP server itself and may be queried from its administrator. An example to use an Office365 mail account may look like follows:

Office365 example
Host=smtp.office365.com
user=<OFFICE365_ACCOUNT_EMAIL>
password=<OFFICE365_ACCOUNT_PASSWOIRD>
port=587
useAuth=true
useStarttls=true