Some Avalon features system actions like collection creation or batch ingest or collection creation send emails. You will need to configure your notification emails, and outbound email must be configured for these to be delivered.
Avalon can be configured to use a SMTP server or AWS SES. The examples below assume SMTP. To use AWS SES, set the mailer
to :aws_sdk
and ignore the rest of the properties
For a full list of available configuration options see the ActionMailer configuration documentation.
Mailer Configuration
Using Environment Variables
...
Code Block |
---|
email: mailer: :smtp config: address: mail-relay.university.edu port: 25 enable_starttls_auto: false |
...
System Email Address Configuration
Avalon uses system email accounts to send email as well as display a support email address to users when certain problems are encountered. A single email address can be used or different email addresses can be configured to tie into existing infrastructure. The different configuration options are listed below including when they are used.
Comments
This email address receives comments submitted by users from the comments form.
Using Environment Variables
Code Block |
---|
SETTINGS__EMAIL__COMMENTS=avalon-comments@example.edu |
Using Settings.yml
Code Block |
---|
email: comments: 'avalon-comments@example.edu' |
Notifications
This email address is used as the from address for emails sent from Avalon including batch ingest emails and collection creation and modification emails sent to administrators. It also receives emails for stalled and unowned batch ingests.
Using Environment Variables
Code Block |
---|
SETTINGS__EMAIL__NOTIFICATION=avalon-notifications@example.edu |
Using Settings.yml
Code Block |
---|
email: notification: 'avalon-notifications@example.edu' |
Support
This email address appears in certain error messages presented to the user when a system administrator is needed to resolve a problem.
Using Environment Variables
Code Block |
---|
SETTINGS__EMAIL__SUPPORT=avalon-support@example.edu |
Using Settings.yml
Code Block |
---|
email: support: 'avalon-support@example.edu' |