Email

From email

The "From:" email address must be configured to use the SMTP relay.

settings.inivalues.yaml

[settings]
NYAN_DEFAULT_FROM_EMAIL = [email protected]

settings:
  email:
    defaultFromEmail: [email protected]

Email provider

Options: console (default), smtp

By default, email messages are written to the application log. Change to smtp to configure an SMTP relay.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_PROVIDER = smtp

settings:
  email:
    provider: smtp

Console

No configuration required for console logging.

SMTP

Send emails through an SMTP relay.

Hostname

Set the hostname for the SMTP relay.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_HOSTNAME = mail.example.com

settings:
  email:
    smtp:
      hostname: mail.example.com

Password

Set the password for the SMTP relay.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_PASSWORD = XXXXXX

settings:
  email:
    smtp:
      password: XXXXXX

Port

Set the port for the SMTP relay.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_PORT = 587

settings:
  email:
    smtp:
      port: 587

SSL

Use SSL for the SMTP relay. Enabled by default.

Enable either SSL or TLS, not both.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_SSL = false

settings:
  email:
    smtp:
      ssl: false

Timeout

Time to wait in seconds for email to send before aborting. Defaults to 180.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_TIMEOUT = 300

settings:
  email:
    smtp:
      timeout: 300

TLS

Use TLS for the SMTP relay. Disabled by default.

Enable either SSL or TLS, not both.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_TLS = true

settings:
  email:
    smtp:
      tls: true

Username

Set the username for the SMTP relay.

settings.inivalues.yaml

[settings]
NYAN_EMAIL_SMTP_USERNAME = [email protected]

settings:
  email:
    smtp:
      username: [email protected]