Configure the SMTP Server
Overview
Before email templates and other email features may be utilized, you must first enable and configure an SMTP server.
To enable and configure the SMTP server navigate to Tenants -> Email.
Enable email by clicking on the Enabled toggle, and save your settings once you have completed your configuration.
SMTP Settings
The hostname of the SMTP server. This will be provided by your SMTP provider.
The port of the SMTP server. This will be provided by your SMTP provider. Ports 25, 465 and 587 are the well known ports used by SMTP, it is possible your provider will utilize a different port.
In most cases you will be using TLS to connect to your SMTP server, and the port will generally be 587 or 465.
The username used to authenticate to the SMTP server. This will be provided by your SMTP provider.
When enabled, you may modify the SMTP password, when the Password field is not displayed the current password will not be modified.
The new password to use for the outgoing SMTP mail server authentication. This field is only required when Change password is checked.
The security type when using an SSL connection to the SMTP server. This value should be provided by your SMTP provider.
Generally speaking, if using port 25 you will select None, if using port of 465 you will select SSL and if using port 587 you will select TLS. It is possible your provider will be different, follow your providers instruction.
NoneSSLTLS
The default From Address used in sending emails when a from address is not provided for an individual email template. This is an email address (i.e. jared@piedpiper.com).
The default From Name used in sending emails when a from name is not provided on an individual email template. This is the display name part of the email address (i.e. Jared Dunn <jared@piedpiper.com>).
One or more line separated SMTP headers to be added to each outgoing email. The header name and value should be separated by an equals sign. (i.e. X-SES-CONFIGURATION-SET=Value).
When enabled, SMTP and JavaMail debug information will be output to the Event Log.
SMTP Providers
This information is for starting guidance only - FusionAuth connects seamlessly with many different email providers. A deep exploration of email best practices and providers is outside the scope of this section.
SendGrid
SendGrid is a commonly used SMTP provider and integrates well with FusionAuth. To setup SendGrid, follow these instructions.
Other resources related to SendGrid are linked below:
- https://docs.sendgrid.com/for-developers/sending-email/getting-started-with-transactional-emails
- https://docs.sendgrid.com/for-developers/sending-email/sender-identity
- https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-domain-authentication
Using dedicated IP addresses for any SendGrid account will build email reputation over time (improving email deliverability). And lastly, to control spoofing, phishing, and spam, it is recommended to set up SPF and DKIM records for the primary email domain (such as example-company.com). Emails should also be sent from an address such as no-reply@example-company.com.
Gmail
Gmail is a commonly used SMTP service. Gmail is not recommended for production use, since it has a number of limits. However, it can be useful to test email functionality.
For Gmail, use application passwords, otherwise you may get a generic Unable to send email via JavaMail / Prime Messaging Exception error.