Skip to content

Configuring email

Awesign sends automated email notifications. This is configured in the email section of awesign.yaml. An example configuration looks like this:

email:
  enabled: true
  host: smtp.example.com
  port: 587
  tls: true
  username: user
  password: password
  from_address: awesign@example.com
  from_name: Awesign
  pending_slides_reminder_time: "07:30"
  • enabled is a boolean that enables sending emails. If set to false, no emails will be sent. Defaults to false
  • host is the SMTP server to send emails through
  • port is the port to connect to the SMTP server on
  • tls is a boolean that enables TLS encryption when connecting to the SMTP server
  • username and password are optional credentials to authenticate to the SMTP server
  • from_address is the email address that emails will be sent from
  • from_name is the friendly name that emails will be sent from. Defaults to "Awesign"
  • pending_slides_reminder_time is the optional time of day that the pending slides reminder email will be sent. This is in the format "HH:MM" in 24-hour time. It must be exactly in that format: two digits, a colon, two digits. If not specified, no reminder emails will be sent.

Pending slides reminder email

The pending slides reminder email is sent to content managers who have pending slide requests in the galleries they manage. This email is sent daily at the time specified in pending_slides_reminder_time in the local timezone. The email contains a list of galleries with pending slide requests, a preview of each slide, and a link to the management page.

It is customized for each content manager, and will only be sent to content managers who have pending slide requests.