Customizing the global mail plugin

Execution points

This plugin is run by the idwfm service and by the psupdate and iddiscover programs. The plugin must be located in the \<instance>\plugin\ directory on the Bravura Security Fabric server.

Input

The following is an example of input sent to the plugin:

"" "" = {
     "content" = "\nouadmin,\n \n  A request for account resources has been received, and is pending\nyour approval.\n\n\n\n\nTo accept, update, or deny the requested resources, please click on\nthe following link:\n\n  -->  http://w2k3archive2/51-5142/?LANG=en-us&userid=ouadmin&BATCH=2064&JUMPTOCGI=IDP\n\nAlternatively, visit\n\n  -->  http://w2k3archive2/51-5142/?LANG=en-us\n\nLog in, click the link for 'Authorize requests', and\nenter batch ID 2064.\n\n\n\nThis request's details:\n\n   Batch ID: 2064\n   Request Created at: \n   Requested By: test_request\n   Through delegate: \n   Requested User ID: test_recipient\n\n\n   Other Attributes:\n     \n\n     \n     \n     View managed password requests\n\n\n      AD, 7777\n\n\n\n     \n\n   Requester Notes:\n     \n\n   Reasons:\n     \n\n\n\n-- Identify Manager.\n\n\n-----------------------------------------------------------------\n\n"
               
      # The body of the message
     "fromemail" = "idmsuite_replies@YourEmailDomain.com"
      # The value of SENDER EMAIL.
     "fromname" = "ID Management Suite"
      # This is always ID Management Suite, and is not configurable.
     "frompass" = "mypass123"
      # The value of SENDER PASSWORD.
     "lockdir" = "E:\\Program Files\\Bravura Security\\Bravura Security Fabric\\Locks\\"
      # The lock file directory.
     "maildir" = "E:\\Program Files\\Bravura Security\\Bravura Security Fabric\\Logs\\default\\mail"
      # The value of GLOBAL MAIL PLUGIN MAILDIR
     "mailheader" = "From: $FROMNAME$ <$FROMEMAIL$>\nTo: $TONAME$ <$TOEMAIL$>\nSubject: $SUBJECT$\n\n$CONTENT$\n\n"
     "mailserver" = "smtp.example.local"
      # The value of MAIL SERVER.
     "mailserverport" = "25"
      # The value of MAIL SERVER PORT.
     "primaryID" = "ouadmin"
      # The profile ID of the primary authorizer,
               
      # in case this is a delegated email.
     "profileID" = "ouadmin"
      # The profile ID of the user receiving the mail.
     "subject" = "Access access request needs authorization"
        # The subject of the email.
     "toemail" = "ouadmin@"
      # The email address to which the message is sent.
      # If global mail plugin is run by psupdate or loaddb, this is the value
      # of RECIPIENT EMAIL.
     "toname" = "ouadmin"
      # The full name of the recipient of the email message.
               
     "content-type" = "1"
      # Indicate the content type of the email, 1 = HTML
     "triggeringEvent" = "EVENT_AUTH_EMAIL_INITIAL"
      # The idwfm event that is triggering the mail.
     "request" "" = {
        # Standard request data.
         }
     "extraHeaders" "" = {
         "In-Reply-To" = "<request ID>"
         "References" = "<request ID>"
         "X-Hitachi-ID-purposeTag" = "EM_WORKFLOW_REQ_INITIAL_AUTHORIZER_NEEDAUTH_CONTENT_PRIMARY"
     }
      # Provide extra email headers
}

Request data is optional. It is empty if not supplied. The input can be used to change how email is sent based on the situation; for example, only sending email if certain request information is included.

Output

This plugin returns a success or failure message, using the errmsg key.

For example, the output for a successful email is:

       "" "" = {
          "errmsg" = "success "
          "retval" = "0"
        }
The output for a failed email would be:
        "" "" = {
          "errmsg" = "There was a problem because ..."
          "retval" = "1"
        }

To configure Bravura Security Fabric to use plugin-email-domino:

Configure the global mail settings as follows: