Send Email
Component definition
This component allows a process to send an email message to one or more recipients using an external SMTP server.
Component icon
[Insert component icon Image file here.]
Definition of component input value or values
| Input Value Name | Input Value Data Type | Req'd | Example Format | Explanation |
|---|---|---|---|---|
| From Address | String | Yes | user@domain.com | The email address from which the email message will be sent |
| Reply To Address | String | No | user@domain.com | An optional email address that replies to this email message should be sent to |
| To Addresses | String[] | Yes | user@domain.com | A list of one or more email addresses that this email message should be sent to |
| CC Addresses | String[] | No | user@domain.com | A list of zero or more email addresses that this email message should be carbon copied to |
| BCC Addresses | String[] | No | user@domain.com | A list of zero or more email addresses that this email message should be bline carbon copied to |
| Send Confirmation To | String | No | user@domain.com | An optional email address to send confirmation messages to when this email is read |
| Subject | AsciiMergeDataType | Yes | The subject line for this email message | |
| Send Html Content | Boolean | * | Indicates that the message should contain HTML encoded text. Either this or "Send Text Content" must be selected. You may also select both, in which both will be included in the message. | |
| Html Content | HTMLMergeDataType | * | HTML encoded content to include in this email message. If "Send Html Content" is set to true then this field is required. | |
| Send Text Content | Boolean | * | Indicates that the message should contain plain text content. Either this or "Send Html Content" must be selected. You may also select both, in which both will be included in the message. | |
| Text Content | AsciiMergeDataType | * | Plain text content to include in this email message. If "Send Text Content" is set to true then this field is required. | |
| File Attachements | FileDataType | No | A list of zero or more files to attach to the email message. |
*When the field is required is described in the "Explanation" column.
| Input Value Name | Input Value Data Type | Req'd | Example Format | Explanation |
|---|---|---|---|---|
| SMTP Server Name | String | Yes | smtp.domain.com or 123.123.123.123 | The IP address or DNS name of the SMTP server to use to send this email message. |
| SMTP Server Port | Int32 | Yes | 25 | The IP port number to use when communicating with the SMTP server. By default this is usually 25. |
| Priority | EmailPriority | No | Normal | The priority of this email message (low, normal, urgent). |
| Save Content | Boolean | No | Indicates that the email message should be saved to a file in addition to being sent through the SMTP server | |
| Save Content File | FileDataType | No | The file to which this email message should be saved. |
Definition of component output value or values
None
Connection information
This component requires two pieces of information to connect to an external SMTP server.
- IP Address/DNS Name: Either the IP address or the DNS name of the SMTP server to use. Typically, an application property should be setup in Process Manager so that all processes that need to send emails can reference the same SMTP server. This would allow the address of the server to be changed in just one place should that ever be necessary.
- Port Number: The port number on which the SMTP server is listening. By default, this is port 25. Unfortunately, this parameter cannot be set using a process variable or application property so it must be hard coded.
The SMTP server will send the email message defined in this component.
Component settings
None
Use case
Notify Primary Contact
A common use case would be to notify the primary contact on a workflow that some event has occurred. In this case, the primary contact information would be retrieved from the process, the primary contact would be filtered from the collection of contacts and the Reference Name of the primary contact would be used in the To Addresses field of this component:
In this case, the From Address would likely be set to a workflow administrator email account or a dummy email inbox, if replies are not desired.
[Example 2]
[Describe the use case. Insert screen shots or package files. Insert a description of how the settings are configured. Insert additional information about the use case that you are submitting.]