Skip to content

Email

Component Available in version
World, Organization v1.0

Both a World Server and an Organization Server can send email. This is an optional plugin, configured independently on each component, using the same mailservice.* properties and mailservice-credentials.properties file on both.

  • On an Organization, email is used to send login credentials to newly created users. If disabled, the user who creates an account is responsible for handing the credentials to its owner directly.
  • On a World, email is used to send monitoring notifications about the Organizations registered with it.

Both components also support a startup confirmation email and monitoring notification emails to your own team.

Prerequisites

  • An SMTP server reachable from the server (World or Organization) being configured.
  • A username and password for that SMTP server.

Configuration

  1. Configure the mail service. In server.config, set mailservice=true and fill in the required mailservice.* properties: at minimum the SMTP host and port, the domain mail is sent from, and a bounce and reply address. See main/server.config or world/server.config for the full property list.
  2. Add SMTP credentials. Add the SMTP username and password to mailservice-credentials.properties. See main/mailservice-credentials.properties or world/mailservice-credentials.properties.
  3. (Optional) Enable notification emails. Set mailservice.startup and mailservice.monitoring to receive startup confirmation and monitoring notification emails.
  4. (Optional) Configure DKIM signing. Set mailservice.dkim.selector and mailservice.dkim.privatekey.path.
  5. Restart the component (main or world) for the configuration to take effect.

Example configuration

mailservice=true
mailservice.domain=example.com
mailservice.bounce=bounce@example.com
mailservice.reply=noreply@example.com
mailservice.sender=Synkzone
mailservice.smtp.host=mail.example.com
mailservice.smtp.port=587
mailservice.smtp.credentials=/config/mailservice-credentials.properties
mailservice.startup=admin@example.com
mailservice.monitoring=monitoring@example.com

username=smtp-user@example.com
password=ExAmPlEsMtPpAsSwOrD123