Email Trigger

Overview

Including this trigger will send an email regarding the following step in the workflow. By default, the type of email and recipient will depend on the Email trigger's mode and type of step that follows the Email trigger:

  • If the Email trigger's mode is notify (or not specified), and the step immediately following the trigger is a Transition or Edit step, the trigger will send a notification email to the step owner(s). If the following step is a System step, the trigger will notify the owner of the workflow, because a System step doesn't provide User/Group information to the trigger.
  • If the Email trigger's mode is completed, a completion email will be sent to the workflow owner regardless of step type.

Declaration


            <trigger class="com.cms.workflow.function.EmailProvider" name="Email"/>
            

Usage


            <trigger name="Email">  
   <parameter>  
      <name>mode</name>  
      <value>notify</value>  
   </parameter>  
   <parameter>  
      <name>recipients-email</name>  
      <value>a@b.com,b@c.com, d@e.com, f@g.com</value>  
   </parameter>  
</trigger>
            

Parameters

Although not required, four optional parameters may be used which will change the default behavior described above.

Mode Parameter

            <parameter>  
   <name>mode</name>  
   <value>completed</value>  
</parameter>
            

This parameter determines what type of notification should be sent. If the value is notify, the recipient will receive a notification email. If the value is completed, the recipient will receive a completion email.

Tip - The default Email trigger mode is notify, so this parameter can be omitted for notification emails.
Recipients-Email Parameter

            <parameter>  
   <name>recipients-email</name>  
   <value>a@b.com,b@c.com, d@e.com, f@g.com</value>  
</parameter>
            

This parameter allows you to specify external email addresses to be notified. To specify who should receive notifications, the parameter should be added to the email trigger with the comma-delimited list of email addresses.

Recipient-Users Parameter

            <parameter>  
   <name>recipient-users</name>  
   <value>user1,user2,user3</value>  
</parameter>
            

This trigger allows you to specify system users to be notified. To specify who should receive notifications, the parameter should be added to the email trigger with the comma-delimited list of usernames.

Recipient-Groups Parameter

            <parameter>  
   <name>recipient-groups</name>  
   <value>group1,group2,group3</value>  
</parameter>
            

This trigger allows you to specify system groups to be notified. To specify who should receive notifications, the parameter should be added to the email trigger with the comma-delimited list of groups.