Send Email activity

An orchestration that contains the Send Email activity is acting as an email client during run time.

The Send Email activity connects to the SMTP server, and sends a message to the server as shown in the following figure.
Figure 1.
The steps for adding and configuring a Send Email activity are described in the following procedures.

Adding a Send Email activity to the orchestration

  1. Create or open an orchestration. A graphical representation of the orchestration is displayed.
  2. Select the Activities tab and expand the Email folder.
  3. Drag the Send Email activity onto the orchestration.
  4. Select the activity. The Checklist is displayed.

Creating, selecting, or editing an email endpoint

  1. Click Pick Endpoint task from the Checklist and choose from one of the following actions:
    • Select an existing endpoint:
      1. Select Browse. The Project Explorer is displayed.
      2. Select an existing endpoint and click OK. Complete the Configuring the activity steps.
    • Select an existing endpoint and edit the endpoint:
      1. Select Browse. The Project Explorer is displayed.
      2. Select an existing endpoint and click OK.
      3. Click Edit. The Edit Endpoint pane is displayed.
    • Create a new endpoint: Select New. The Create Endpoint pane is displayed.
  2. Create or edit an email endpoint. For more information, see Creating or editing an email endpoint.

Configuring the activity

  1. Select the Configure task from the Checklist. The Configure pane is displayed.
  2. Configure all the fields in this pane as described in the following table:
    Table 1.
    Field Description
    From Address Specifies the sender address for the email message. You must specify the email address using the standard email format: email@domain.extension. This field is required.
    To Specifies the recipient's addresses for the email message. You must specify the email addresses using the standard email format: email@domain.extension. One or more addresses can be specified. Separate the addresses with commas or semicolons. You must specify at least one address. This field is required.
    CC Specifies the carbon copy's addresses for the email message. You must specify the email addresses using the standard email format: email@domain.extension. One or more addresses can be specified. Separate the addresses with commas or semicolons. This field is optional.
    Subject Specifies the subject of the email message.

Specifying the retry options

  1. Select the Retry task from the Checklist. The Retry pane is displayed.
  2. Configure the retry options for connecting to an SMTP Server. The following table describes the retry options for connecting to an SMTP Server:
    Table 2.
    Field Description
    Retry  
    1) Wait ___ second(s) between each retry. Specifies the number of seconds that the Integration Appliance waits before trying to establish a connection to the SMTP Server.
    2) Try to connect ___ times before failing. Specifies the retry count - the maximum number of times the Integration Appliance attempts to establish a connection to the SMTP Server before issuing an error and stopping the processing of the current orchestration job.

    If you deploy an orchestration that contains an Send Email activity and the Integration Appliance cannot connect to the specified SMTP Server, the Integration Appliance logs the connections errors as warnings in the system and orchestration logs until the retry count value is reached. When the retry count is reached, the Integration Appliance logs an error in the system and orchestration logs and the stops processing the current orchestration job.

    For example, you set the retry count to 3. The first, second, and third connection errors appear in the system log as warnings. The Integration Appliance logs the fourth connection error as an error and stops processing the current orchestration job.

     

Mapping the input of the activity

  1. Select the Map Inputs task in the Checklist. The input parameters of the activity are displayed in the To Activity pane.
  2. In this task, you map variables to the following input parameters of the activity:
    • The body input parameter contains the body of the email message and associated attachments. The body input parameter is of type string. You must map a variable or assign a default value to the body input parameter.
    • The optional mailheader input parameter contains meta information about the email message, for example the email addresses that the message is being sent to and the mimeHeader of the message itself. The mailheader input parameter is optional, you do not have to map a variable or assign default values to the mailheader input parameter.

      If the optional mailheader input parameter is not listed in the To Activity pane of the Map Inputs pane, select Map > Show Optional Parameters from the toolbar menu or right-click in the To Activity pane and select the Show Optional Parameters option. If the Map > Show Optional Parameters option is not selectable in the toolbar menu, click on a node in the Map Inputs pane to make this option active.

      You can optionally override the settings you specified in the Configure task of the Checklist dynamically during run time by passing in values from variables into the nodes specified in the following table. For example during run time, you can override the setting for the From Address field by mapping a variable to the from node of the mailheader input parameter. During run time, the value of the variable is the from address in the sent email message.

      Table 3.
      Nodes of the mailheader Input Parameter Description Overrides what settings in the Configuring task?  
      from Specifies the sender address for the email message. You must specify the email address using the standard email format: email@domain.extension. The from node of the mailheader input parameter overrides the From Address field specified in the Configure task.
      to Specifies the recipient addresses for the email message. You must specify the email addresses using the standard email format: email@domain.extension. One or more addresses can be specified. Separate the addresses with commas or semicolons. The to node of the mailheader input parameter overrides the To field specified in the Configure task.
      cc Specifies the carbon copy addresses for the email message. You must specify the email addresses using the standard email format: email@domain.extension. One or more addresses can be specified. Separate the addresses with commas or semicolons. The cc node of the mailheader input parameter overrides the CC field specified in the Configure task.
      subject Specifies the subject of the email message. The subject node of the mailheader input parameter overrides the Subject field specified in the Configure task.
      mimeHeader Specifies the MIME header of the email message. None.
      otherHeaders Specifies an element that contains a set of MIME headers as name/value pairs not already specified in the mimeHeader node. For example the MIME header: Content-Location is not specified in the MIME header, so the following headerItem node could be equal to the following values: otherheaders/headerItem/name is equal to Content-Location otherHeaders/headerItem/value is equal to the value of the Content-Location MIME header, for example the string: RN-Preamble Multiple MIME headers can be specified, so this is a recurring node. None.
      Note: You can use the Write MIME activity to build the contents of the mimeHeader node of the optional mailheader input parameter. For example, you could add a Write MIME activity to the orchestration before the Send Email activity and have the Write MIME activity populate the contents of the mimeHeader XML variable and then passes the mimeHeader variable to the Send Email activity.

      See Creating a map for more information

      Note: When using a non-English payload, the mailheader, mimeHeader and otherheaders need to be mapped into the orchestration in the getEmail activity, and mapped from the orchestration back into the sendMail activity.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/email_send_activity.html