Configuring the Email Sending Module¶

This document explains the steps to configure WSO2 Identity Server to send emails during multiple email related identity and access management tasks such as email OTP, email notifications, account recovery.

1. Shut down the server if it is running.

2. Add the following properties to the deployment.toml file in the <IS_HOME>/repository/conf folder to configure the email server.

   [output_adapter.email]
   from_address= "[email protected]"
   username= "wso2iamtest"
   password= "Wso2@iam70"
   hostname= "smtp.gmail.com"
   port= 587
   enable_start_tls= true
   enable_authentication= true
   signature = "ABC.com"

   from_address	The mail address from where you want to send the notification. It can be any working mail address.
   username	Provide the username of the SMTP account. Username of the mail you have provided in from_address
   password	Provide the password of the SMTP account. Password of the mail you have provided in from_address
   host	The SMTP server to connect to.
   port	The SMTP server port to connect to, if the connect() method does not explicitly specify one. Defaults to 25.
   enable_start_tls	If true, enables the use of the STARTTLS` command (if supported by the before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to true.
   enable_authentication	If true, attempt to authenticate the user using the AUTH command. Defaults to true.
   signature	Specifies the display name for the "From" email address. For example, "ABC Company" results in "ABC Company" <[email protected]>). If you don't set this property, the display name becomes null and the system falls back to your SMTP server settings. For example, some servers use the username as the display name. To send an email with no display name and show only the email address, set this value to an empty string: signature = "".

   Tip

   For information about the SMTP, see here.

3. Re-start the server once configurations are in place.