Sending EmailConfigurationEmailSending mailThis chapter shows you how to configure the outbound email service, so
that you can send email through OpenIDM either by script or through the REST
API.To Set Up Outbound EmailThe outbound email service relies on a configuration object to identify
the email account used to send messages.Shut down OpenIDM.Copy the sample configuration to
openidm/conf.$ cd /path/to/openidm/
$ cp samples/misc/external.email.json conf/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: addressStart up OpenIDM.Check that the email service is active.-> scr list
...
[ 6] [active ] org.forgerock.openidm.external.email
...Sending Mail Over RESTAlthough you are more likely to send mail from a script in production,
you can send email using the REST API by sending an HTTP POST to
/openam/external/email in order to test that your
configuration works. You pass the message parameters as POST parameters,
URL encoding the content as necessary.The following example sends a test email using the REST API.$ curl
--header "X-OpenIDM-Username: openidm-admin"
--header "X-OpenIDM-Password: openidm-admin"
--request POST
"http://localhost:8080/openidm/external/email?
_from=openidm@example.com&_to=admin@example.com&
_subject=Test&_body=Test"Sending Mail From a ScriptYou can send email from using the resource API functions with
the external/email context, as in the following
example, where params is an object containing the
POST parameters.
var params = new Object();
params._from = "openidm@example.com";
params._to = "admin@example.com";
params._cc = "wally@example.com,dilbert@example.com";
params._subject = "OpenIDM recon report";
params._type = "text/html";
params._body = "<html><body><p>Recon report follows...</p></body></html>";
openidm.action("external/email", params);OpenIDM supports the following POST parameters._fromSender mail address_toComma-separated list of recipient mail addresses_ccOptional comma-separated list of copy recipient mail addresses_bccOptional comma-separated list of blind copy recipient mail
addresses_subjectEmail subject_bodyEmail body text_typeOptional MIME type. One of "text/plain",
"text/html", or "text/xml".