nativeInstallerexo-platform-community

Configure SMTP for outbound emails

Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and MacOS) or by clicking the shortcut in the Start Menu under “Start -> Bitnami APPNAME Stack -> Application console” (Windows). On OS X VMs, the installation directory is /opt/bitnami and OS X VM users can click the “Open Terminal” button to run commands. Learn more about the Bitnami stack environment and about OS X VMs.

For eXo Platform 4.1 or newer

To send email using eXo Platform via SMTP, it is necessary to specify the SMTP settings in the installdir/apps/exoplatform/gatein/conf/exo.properties file.

Here is an example of the configuration parameters using a Gmail SMTP server. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

exo.email.smtp.from=USERNAME@gmail.com
exo.email.smtp.host=smtp.gmail.com
exo.email.smtp.port=465
exo.email.smtp.starttls.enable=true
exo.email.smtp.auth=true
exo.email.smtp.username=USERNAME@gmail.com
exo.email.smtp.password=PASSWORD
exo.email.smtp.socketFactory.port=465
exo.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

Find more information in this guide.

For eXo Platform 4.1.0 or older

To send email using eXo Platform via SMTP, it is necessary to specify the SMTP settings in the installdir/apps/exoplatform/scripts/setenv-customize.sh file.

Here is an example of the configuration parameters using a Gmail SMTP server. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

EXO_EMAIL_FROM="USERNAME@gmail.com"
EXO_EMAIL_SMTP_HOST="smtp.gmail.com"
EXO_EMAIL_SMTP_PORT="465"
EXO_EMAIL_SMTP_STARTTLS_ENABLE=true
EXO_EMAIL_SMTP_AUTH=true
EXO_EMAIL_SMTP_USERNAME="USERNAME@gmail.com"
EXO_EMAIL_SMTP_PASSWORD="PASSWORD"

Note that for UNIX-based or Mac OS X-based servers or native installers, you will need to also uncomment each line by deleting the hash (#) symbol at the start of each line, whereas for Windows native installers, you will need to uncomment each line by deleting the the REM string at the start of each line.

After saving the changes to the file, restart the Tomcat server:

$ sudo installdir/ctlscript.sh restart tomcat

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid, refer to the FAQ.

NOTE: If you are using Gmail as the outbound email server, your application’s attempts to send outgoing emails may be blocked by Gmail if it considers the authentication attempts to be suspicious. When this happens, you will receive a Gmail security alert at the corresponding Gmail address. To proceed, you will need to manually confirm the validity of the authentication attempt before Gmail will permit the application to send outbound emails. For more information on this and other Gmail issues related to outbound email from your application, refer to our Gmail SMTP troubleshooting page.

Last modification March 22, 2019