Set Up Email Notification

Updated: January 2, 2020

This page is scheduled for review and update. Check back soon for updated content!

JSF UI Deprecation
This requires to have the JSF UI addon installed on your server that is deprecated since Nuxeo Platform LTS 2019.
Please refer to the Web UI documentation.

The default Nuxeo Platform email configuration is filled in with neutral values that you need to edit to make the platform work with your mail server. Unless you do that, alerts emails won't be sent to users.

To enable notifications:

  1. In the Admin tab, click on the Setup tab of System Information section.
  2. Edit and fill in the values of the Email information section (see below for expected parameters).
    To enable alerts, filling in the SMTP parameters should be sufficient for most mail server configurations.
  3. Click the button Save. As indicated on top of the page, you need to restart your server so the new configuration is taken into account.

Properties and values can also be entered directly in your nuxeo.conf file. Please refer to the table below for the keys to add or fill in.

Email information configuration

Field / Property Description
Email notifications subject prefix
Text displayed in the "Object" before the object of the alerts email to help users identify that the emails are coming from the application. Default value is "[Nuxeo]". You can change is to whatever value you like.
Mail store protocol
Name of the protocol used to store emails on the server. Default value is "pop3". You may need to change it to "IMAP".
Mail transport protocol
Name of the protocol used to send emails. Default value is "smtp". This should work in most cases.
Host Name for Store
Name of the mail server host used to receive and store emails. Default value is "localhost". You need to change it.
Port Number for Store
Mail server port to receive and store emails. Default value is 110.
Username for Store
Type the username that will be used if you set the authentication for SMTP parameter to "true".
Password for Store
Type the password that will be used if you set the authentication for SMTP parameter to "true".
Debug mode
Default value is set to "false". Change it to "true" if you want to have the details of what the server is doing in the logs.
Host Name for Transport
Mail server host name for outgoing mails. Default value is "localhost". You need to change it so emails can be sent from the server.
Port Number for Transport
Mail server port for outgoing emails. Default value is 25.
Use Authentication for Transport
Indicate if authentication is needed for the mail server to send emails.
Sender Address Mail
Email address that will displayed as the sender's address.
Transport Connection using TLS
Indicate if TLS is needed for the mail server. Default value is "false". You should change it to "true" if your SMTP requires TLS
If you have complex mail server configurations, you may want to check the Javamail API FAQ for more information.
Related Documentation

We'd love to hear your thoughts!

All fields required