Actions YAML Reference
Properties | List of all members
SendEmailAction Class Reference

Sends an email message. More...

Inherits IntegrationAction.

Properties

string To [get, set]
 Specifies one or more email recipients, separated by semicolons.
More...
 
string From [get, set]
 Specifies the authors of the message. For more information, see http://datatracker.ietf.org/doc/rfc4021#section-2.1.2. More...
 
string Sender [get, set]
 Specifies the email address of the sender, who is responsible for the actual transmission of the message. For more information, see http://datatracker.ietf.org/doc/rfc4021#section-2.1.3. More...
 
string CC [get, set]
 Specifies one or more CC email recipients, separated by semicolons. More...
 
string BCC [get, set]
 Specifies one or more BCC email recipients, separated by semicolons. More...
 
DataTarget Body [get, set]
 Specifies the source of the email message body. For more information, see DataTarget. Example: More...
 
ActionTextEncoding BodyEncoding [get, set]
 Specifies the text encoding scheme of the message body. The default value is UnicodeUTF8. More...
 
MailMessageFormat MailMessageFormat [get, set]
 Specifies the mail message format. The following options are available: More...
 
string Subject [get, set]
 Specifies the subject of the email message. More...
 
bool EnableSSL [get, set]
 Enables SSL for the email client. Obsolete. More...
 
MailPriority Priority [get, set]
 Specifies the priority of the email message, as follows: More...
 
SmtpSetup AccountSetup [get, set]
 Specifies the email server credentials and settings. For more information, see SmtpSetup. Example: More...
 
MailAttachmentSourceList Attachments [get, set]
 Specifies a list of attachments. This property can be either a DataTarget source (by specifying a Source property) or a FolderTarget source (by specifying a Folder property).
For more information, see DataTarget and FolderTarget. More...
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...
 

Detailed Description

Sends an email message.

For common action properties, see IntegrationAction.
Example:

Actions:
- SendEmailAction:
From: user@mockemailserver.com
Body: '%EventData%'
MailServer: mockemailserver.com
RequireAuthentication: true
UserName: user
Password: mypassword1234
EnableSSL: true
- Source: '%EventData%'
ContentType: TextPlain
Name: Attachment 1
- Source:
File: C:\MySecretFolder\MyPicture.jpg
Encoding: Binary
ContentType: ImageJpeg
Name: Attachment 2
ContentEncoding: Binary
- Source: Embedded variable like %EventData% in the template.
ContentType: TextPlain
Name: Attachment 3
- Folder: lib://MySecretFolder
Name: Attachment 4
ContentEncoding: Binary
Name: Send Email
# And more common action properties
...
MailAttachmentSourceList Attachments
Specifies a list of attachments. This property can be either a DataTarget source (by specifying a Sou...
Definition: SendEmailAction.Properties.cs:286
DataTarget Body
Specifies the source of the email message body. For more information, see DataTarget....
Definition: SendEmailAction.Properties.cs:189
SmtpSetup AccountSetup
Specifies the email server credentials and settings. For more information, see SmtpSetup....
Definition: SendEmailAction.Properties.cs:251
string From
Specifies the authors of the message. For more information, see http://datatracker....
Definition: SendEmailAction.Properties.cs:143
bool EnableSSL
Enables SSL for the email client. Obsolete.
Definition: SendEmailAction.Properties.cs:224
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87

Example of using OAuth (Outlook):

Actions:
- SendEmailAction:
To: somebody@seagullscientific.com
From: user@outlook.com
Body: '%EventData%'
Subject: Send Email
Priority: High
MailServer: smtp.office365.com
RequireAuthentication: true
UserName: user@outlook.com
OutgoingPort: 587
EnableSSL: true
OAuthRefreshToken:
Encrypted: ***********
OAuthRefreshTokenExpiredTime: 2/27/2023 7:20:41 AM
- Source: '%EventData%'
ContentType: TextPlain
Name: Attachment 1
- Source:
File: C:\MySecretFolder\MyPicture.jpg
Encoding: Binary
ContentType: ImageJpeg
Name: Attachment 2
ContentEncoding: Binary
- Source: Embedded variable like %EventData% in the template.
ContentType: TextPlain
Name: Attachment 3
- Folder: lib://MySecretFolder
Name: Attachment 4
ContentEncoding: Binary
Name: Send Email
# And more common action properties
...
string Subject
Specifies the subject of the email message.
Definition: SendEmailAction.Properties.cs:217
string To
Specifies one or more email recipients, separated by semicolons.
Definition: SendEmailAction.Properties.cs:136
MailPriority Priority
Specifies the priority of the email message, as follows:
Definition: SendEmailAction.Properties.cs:234

Property Documentation

◆ To

string To
getset

Specifies one or more email recipients, separated by semicolons.

◆ From

string From
getset

Specifies the authors of the message. For more information, see http://datatracker.ietf.org/doc/rfc4021#section-2.1.2.

◆ Sender

string Sender
getset

Specifies the email address of the sender, who is responsible for the actual transmission of the message. For more information, see http://datatracker.ietf.org/doc/rfc4021#section-2.1.3.

◆ CC

string CC
getset

Specifies one or more CC email recipients, separated by semicolons.

◆ BCC

string BCC
getset

Specifies one or more BCC email recipients, separated by semicolons.

◆ Body

DataTarget Body
getset

Specifies the source of the email message body. For more information, see DataTarget. Example:

Body: >-
This is a very long sentence
that spans several lines in the YAML
but that will be rendered as a string
that has NO carriage returns.

Example in which the source is an integration variable:

Body: %EventData%

Example in which the source is a file:

File: 'C:\MySecretFolder\emailbody.txt'

◆ BodyEncoding

ActionTextEncoding BodyEncoding
getset

Specifies the text encoding scheme of the message body. The default value is UnicodeUTF8.

◆ MailMessageFormat

MailMessageFormat MailMessageFormat
getset

Specifies the mail message format. The following options are available:

  • Auto
  • Text (default)
  • Html

◆ Subject

string Subject
getset

Specifies the subject of the email message.

◆ EnableSSL

bool EnableSSL
getset

Enables SSL for the email client. Obsolete.

◆ Priority

MailPriority Priority
getset

Specifies the priority of the email message, as follows:

  • Normal
  • Low
  • High

◆ AccountSetup

SmtpSetup AccountSetup
getset

Specifies the email server credentials and settings. For more information, see SmtpSetup. Example:

MailServer: mockemailserver.com
RequireAuthentication: true
UserName: user
Password: mypassword1234
EnableSSL: true

◆ Attachments

MailAttachmentSourceList Attachments
getset

Specifies a list of attachments. This property can be either a DataTarget source (by specifying a Source property) or a FolderTarget source (by specifying a Folder property).
For more information, see DataTarget and FolderTarget.

Example:

# Integration variable as the source of the attachment:
- Source: '%EventData%'
ContentType: TextPlain
Name: Attachment 1
# File as the source of the attachment:
- Source:
File: C:\MySecretFolder\MyPicture.jpg
Encoding: Binary
ContentType: ImageJpeg
Name: Attachment 2
ContentEncoding: Binary
# Embedded text with variables as the source of the attachment:
- Source: Embedded variable like %EventData% in the template.
ContentType: TextPlain
Name: Attachment 3
# Files in a Librarian folder as the source of the attachment:
- Folder: lib://MySecretFolder
Name: Attachment 4
ContentEncoding: Binary

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.


The documentation for this class was generated from the following file: