The configuration file goobi_mail.xml is used to configure mail dispatch for Goobi. The file is usually located here:
For example, this configuration file looks as follows:
| Field | Description |
|---|---|
To deactivate the global sending of emails, it is sufficient to delete the goobi_mail.xml file or set the enabled attribute to false.
Additionally, the content of the emails can be configured. The following keys are available in the messages files for this purpose:
In addition to normal text or HTML elements, variables can also be used in the subject or body. The following variables are available for this purpose:
For example, an email text could be configured as follows:
| Field | Description |
|---|---|
| Variable | Description |
|---|---|
smtpServer
SMTP server for mail dispatch
smtpPort
Port for the SMTP server to use, in case it is not the default port
smtpUser
Username for authentication on the SMTP server
smtpPassword
Password for authentication on the SMTP server
smtpUseStartTls
Activation of the StartTLS encryption type
smtpUseSsl
Activation of the SSL encryption type
smtpSenderAddress
The sender address to be displayed to the recipient.
apiUrl
URL at which a user can deactivate mail reception
mail_notification_openTaskSubject
Subject of the email that is sent when a task is opened.
mail_notification_openTaskBody
Content of the email that is sent when a task is opened
mail_notification_inWorkTaskSubject
Subject of the email that is sent when a task is being processed
mail_notification_inWorkTaskBody
Content of the email that is sent as soon as a task is processed
mail_notification_doneTaskSubject
Subject of the email that is sent when a task is completed
mail_notification_doneTaskBody
Content of the email that is sent when a task is completed
mail_notification_errorTaskSubject
Subject of the email that is sent when a task changes to an error status
mail_notification_errorTaskBody
Content of the email that is sent when a task changes to an error status
${user}
Name of the user to whom the e-mail will be sent
${projectname}
Name of the project to which the task belongs
${processtitle}
Name of the operation to which the task belongs
${stepname}
Name of the current task
${url_cancelStep}
URL to unsubscribe from notifications for this type of task
${url_cancelProject}
URL to unsubscribe notifications for all tasks of the project
${url_cancelAll}
URL to unsubscribe from all notifications