Skip to content

devatherock/email-sender

Repository files navigation

CircleCI Version Docker Pulls Docker Image Size License: MIT

email-sender

REST API to send emails. Sends the email using the configured SMTP server or an embedded aspirin server

API Reference

Refer the swagger spec or the swagger UI

Sample YAML request payload

to:
 - email: [email protected]
subject: Test email
html: |
  <!DOCTYPE html>
  <html>
    <body>
       <h3>Hello, World!</h3>
    </body>
  </html>
text: This is a test email

Configurable properties

Name Type Default Description
emailsender.smtp.embedded boolean false Indicates if an embedded SMTP server should be used. Turned off by default
emailsender.smtp.username String (None) The SMTP username
emailsender.smtp.password String (None) The SMTP password
emailsender.smtp.host String (None) The SMTP server name
emailsender.smtp.port int 587 The SMTP port. Defaults to 587
emailsender.smtp.from-address.name String (None) The from name to use in outbound emails
emailsender.smtp.from-address.email String (None) The from email address to use in outbound emails