Send Email Plug-in

«Back to Plug-ins Table

Related Topic

The Send Email plug-in enables you to send an email at a specified point within a workflow – at a point such as when an item requires approval or is approved.

Properties

Name Description
connectionname The connection name used to connect to the database. It includes a drop-down list with the connections defined at the global or current app level.

senddelay

The numbers of days to wait before sending the email.

Example:

Direct value: 1 (or any number defining number of days)

Value from form field: [/my:myFields/my:field2]

Value from solution field: [field1]
to

The list of email addresses to which the email message will be sent. Use semicolons as email separators. 

Example:

Direct value: abc@xyz.com; def@xyz.com

Value from form field: [/my:myFields/my:field2]

Value from solution field: [field1]
subject The subject of the email message. If an email template is used in the body parameter, this subject will be selected from the email template and the contents of this parameter will be ignored.
body

The contents of the email message. The contents can be selected directly from this parameter or the user can provide the name of an email template defined at global or app level. If an email template is defined, both the subject and the body will be selected from the defined email template.

Example:

Direct Value (Email content from this parameter): Test Email Content

Direct value (Email contents from an email template): <p>$EmailTemplate.MyEmailTemplate here

MyEmailTemplate is the email template nameValue from form field: [/my:myFields/my:field2]

Value from solution field: [field1]
query

The query to run (on the database defined in connectioname parameter) to determine recipients. A connectionname must be configured for this option to work. It should return the email ID of the users to whom an email must be sent.

Example:

Direct value: Select User from dbo.TestUsers Where ID = 2
includeitem This flag indicates if the form should be included as an attachment. If set to True, the formview and the format property must be specified.
formview The name of the form the recipient receives in the email. This works only if includeitem is set to True. 
includedatafile

Specifies how the recipients will receive the Excel document (the data file) in the email.

None – Excel document (data file) will not be sent in the emailLinkToDataFile – Link to Excel document (data file) will be included in the emailDataFileAsAttachment – Excel document (data file) will be included as attachment in the email.

BothLinkAndAttachment – Excel document (data file) will be included as attachment in the email and a link to the Excel document (data file) will also be included in the email.
format The snapshot format of the form view attached to the email.

Note: The email is sent using the SMTP details (Outbound SMTP Server, From Address, Use SSL, Do not use SSL, and SMTP port, etc.) which are added at the Administration app level.

Example

Use the Send Email plug-in to keep participants in a workflow notified of tasks and events, such as when a task is overdue or when something requires approval.