Procedure 17.1. To Set Up Outbound Email

The outbound email service relies on a configuration object to identify the email account used to send messages.

1. Shut down OpenIDM.

2. Copy the sample configuration to openidm/conf.

   $ cd /path/to/openidm/
   $ cp samples/misc/external.email.json conf/

3. Edit external.email.json to reflect the account used to send messages.

   {
           "host" : "smtp.example.com",
           "port" : "25",
           "username" : "openidm",
           "password" : "secret12",
           "mail.smtp.auth" : "true",
           "mail.smtp.starttls.enable" : "true"
   }

   OpenIDM encrypts the password you provide.

   Follow these hints when editing the configuration.

   "host"

   SMTP server host name or IP address. This can be "localhost" if the server is on the same system as OpenIDM.

   "port"

   SMTP server port number such as 25, or 587

   "username"

   Mail account user name needed when "mail.smtp.auth" : "true"

   "password"

   Mail account user password needed when "mail.smtp.auth" : "true"

   "mail.smtp.auth"

   If "true", use SMTP authentication

   "mail.smtp.starttls.enable"

   If "true", use TLS

   "from"

   Optional default From: address

4. Start up OpenIDM.

5. Check that the email service is active.

   -> scr list
   ...
   [   6] [active       ] org.forgerock.openidm.external.email
   ...