Skip to main content

Using the email address plugin (IDSYNCH USERS EMAIL PLUGIN)

The users’ email address plugin receives all information about a user, including all attributes and accounts. It can return an email address according to any rule you specify. For example, you may want it to append the domain name to users’ profile IDs:

profile ID@example.com

To set the users’ email plugin, type the name of the executable or PSLang script in the IDSYNCH USERS EMAIL PLUGIN field on the Workflow > Options > Plugins page.

There are no shipped plugins for use with the plugin point.

Write a custom email address plugin

Requirements

See Writing plugins for general requirements.

Execution points

When configured, the plugin is run by the user notification system and by the Workflow Manager Service, if installed.

Input

The email address plugin is sent all data about the user whose email address is required.

Input passed to the plugin is as follows:

"" "" = { 
  "authorizer" = "<profile ID>" 
         
  "viewer" "user" = { ...} 
      # The viewer's data. 
}

For example:

# KVGROUP-V1.0 
"" "" = { 
  "authorizer" = "marliese.capek" 
  "viewer" "user" = { 
    "id" = "marliese.capek" 
    "name" = "Marliese Capek" 
  } 
}

Output

Output passed from the plugin is as follows:

"" "" = { 
  "errmsg" = "<error message>" # Error messaged by the plugin 
  "retval" = "0" # Mandatory; zero is success and non-zero is failure 
  "authorizer" "<profile ID>" = { 
    "email" = "<email address>" 
      # The email address to use for the authorizer 
  } 
}

Following is an example of the output:

"" "" = { 
     "errmsg" = "" 
     "retval" = "0" 
     "authorizer" "marliese.capek" = { 
       "email" = "marliese.capek@norse.bravurasecurity.com" 
     } 
   }
In this section: