Nuxeo Server

Set Up Email Notification

Updated: November 13, 2017 Page Information Edit on GitHub

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
nuxeo.notification.eMailSubjectPrefix
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
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
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
mail.store.host
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.store.port
Mail server port to receive and store emails. Default value is 110.
Username for Store
mail.store.user
Type the username that will be used if you set the authentication for SMTP parameter to "true".
Password for Store
mail.store.password
Type the password that will be used if you set the authentication for SMTP parameter to "true".
Debug mode
mail.debug
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.transport.host
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.transport.port
Mail server port for outgoing emails. Default value is 25.
Use Authentication for Transport
mail.transport.auth
Indicate if authentication is needed for the mail server to send emails.
Sender Address Mail
mail.from
Email address that will displayed as the sender's address.
Transport Connection using TLS
mail.transport.usetls
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.
4 days ago manonlumeau Added content-review-lts2017 label
a month ago manonlumeau NXDOC-1346-FT review screenshot
a year ago Solen Guitter 4
a year ago Alain Escaffre 3
a year ago Alain Escaffre 2
a year ago Alain Escaffre 1
History: Created by Alain Escaffre