Email - Send message
Ensure that the SMTP server is defined when creating Email actions. If you have upgraded from older versions of Advanced Workflows , you will have to define the SMTP server in those Event Rules that use the Advanced Workflows Email actions.
Declaration
<AMSENDEMAIL FROM="text" TO="text" SUBJECT="text" BODYFILE="text" HTML="yes/no" PROTOCOLTYPE="text (options)" <AUTODISCOVERURL="yes/no" ALLOWREDIRECTION="yes/no" IGNOREINVALIDCERTIFICATE="yes/no" DOMAINNAME="text" USERNAME="text" PASSWORD="text (encrypted)" />
Description: Sends an e-mail message with or without attachments to the specified recipient via SMTP, Exchange 2003 (WebDav), Exchange 2007 (EWS) or Exchange 2010 (EWS) protocol. This action supports Explicit and Implicit Transport Layer Security (TLS) and Secure Sockets Layer (SSL) security. It also supports the sending of plain text or HTML formatted e-mail, the use of file contents as the e-mail body, requesting of delivery reports and read receipts (if the recipient's e-mail program supports delivery reports and/or read receipts).
Practical Usage
Used to send an e-mail message plain text or HTML formatted, with or without attachments, using SMTP or Exchange Server Protocol. System administrators frequently use this action to perform system notifications or conveniently package data retrieved from any other source such as databases or web sites.
Connection Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
© |
--- |
--- |
--- |
--- |
Indicates where user credentials, server settings and other preferences required to establish a connection to the email server should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markups. The available options are:
|
Session |
Text |
Yes if Connection set to Session |
EmailSession1 |
SESSION="emailSess1" |
The name of the session. The default value is EmailSession1. This parameter is available only if the Connection parameter is set to Session. |
Protocol |
Text (options) |
Yes if Connection set to Host |
SMTP |
|
The type of email protocol to connect to. This parameter is available only if the Connection parameter is set to Host. Different parameters become available depending on which option is chosen. The available options are:
|
Server |
Text |
Yes |
(Empty) |
SERVER="mail.server.com" |
The SMTP server that should be used to send the message. This parameter is available only if the Protocol parameter is set to POP3 or IMAP. |
Port |
Number |
No |
110 |
PORT="3333" |
The port that should be used when connecting to the SMTP server. Most SMTP servers run on port 110 (default port number) however, this parameter can be customized to connect to another port. This parameter is available only if the Protocol parameter is set to POP3 or IMAP. |
Security |
Text (options) |
Yes |
No security |
|
The type of security that this action should use. This parameter is available only if the Protocol parameter is set to POP3 or IMAP. The available options are:
|
Authentication Type |
Text (options) |
Yes if Authentication is enabled |
(Empty) |
|
Specifies the authentication type to administer. The following options are:
|
Username |
Text |
Yes if Authentication is enabled |
(Empty) |
USERNAME="theuser" |
The user name to use to logon to the mail server and authenticate the mail transaction. NOTE: The From address entered should belong to the authenticated user. |
Password |
Text |
Yes if Authentication is enabled |
(Empty) |
PASSWORD="encrypted" |
The password used to logon to the mail server and authenticate the mail transaction. |
Domain name |
Text |
Yes if Use Authentication is set to YES |
(Empty) |
DOMAINNAME="my.domain.com" |
The domain name to authenticate with. This parameter is available only if the Use Authentication parameter is selected. |
Certificate |
Text |
Yes if Security set to Explicit TLS/SSL or Implicit TLS/SSL |
(Empty) |
CERTIFICATE= "c:\folder\certname.pfx" |
The full path and filename of the certificate (.cer or .pfx extension) used to authenticate with. This parameter is available only if the Security parameter is set to Explicit TLS/SSL or Implicit TLS/SSL. |
Passphrase |
Text |
Yes if Security set to Explicit TLS/SSL or Implicit TLS/SSL |
(Empty) |
CERTIFICATEPASSPHRASE= "encrypted" |
The certificate passphrase. This parameter is available only if the Security parameter is set to Explicit TLS/SSL or Implicit TLS/SSL. |
Current folder |
Text |
No |
Inbox |
CURRENTFOLDER="inbox" |
Specifies the current mailbox folder that this activity should be performed on. The default value is Inbox. To denote other Exchange well-known folders (e.g., Calendar, Drafts, Tasks, etc.) enter the Exchange property name for that folder. To specify subfolders, use a "/" (e.g., Inbox/SubFolderName). For more details regarding Exchange "well-known" folders, see the Additional Notes section below. |
Timeout |
Number |
No |
60 |
TIMEOUT="120" |
The specified period of time that will be allowed to elapse (in seconds) before the server will close a client connection. This ensures that connections do not persist forever, if the client crashes or the network goes down. Open connections consume resources, and may prevent other clients from accessing the same mailbox. The default value is 60 seconds. |
If the Protocol parameter is set to WebDAV (Exchange 2003, 2007) or EWS (Exchange 2007 & newer, Online), the following parameters become available. |
|||||
Email address |
Text |
Yes |
(Empty) |
EMAILADDRESS="guy@domain.com" |
The email address to communicate with. |
Exchange Server |
Text |
Yes |
(Empty) |
SERVER= "https://www.server.com" |
The Exchange server to communicate with. This parameter is available only if the Protocol Type parameter is set to Exchange 2003 (WebDav), Exchange 2007 (EWS) or Exchange 2010 (EWS). |
Autodiscover service URL |
Yes/No |
No |
No |
AUTODISCOVERURL="yes" |
The Autodiscover service configures and maintains server settings for client computers that are running Microsoft Office Outlook 2007 and supported mobile devices. It provides access to Microsoft Exchange features for Outlook 2007 clients that are connected to your Microsoft Exchange messaging environment. If this parameter is set to YES, specifies that Autodiscover service requests will be performed. This parameter is set to NO by default and is only available if the Protocol Type parameter is set to Exchange 2007 (EWS) or Exchange 2010 (EWS). |
Allow redirection |
Yes/No |
No |
No |
AUTODISCOVERURL="yes" |
If set to YES, redirection (or mail forwarding) to another server will be allowed. This parameter is set to NO by default and is only available if the Protocol Type parameter is set to Exchange 2007 (EWS) or Exchange 2010 (EWS). |
Impersonate |
Yes/No |
No |
No |
IMPERSONATE="YES" |
If set to YES, Impersonation is enabled. Impersonation allows an account on an Exchange server to perform actions by using the permissions that are associated with another account, instead of the permissions that are associated with the caller's account. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online). NOTE: With Exchange Impersonation, one account is acting as another account. When an account is impersonated, the system logs the access as if the account that is specified in the header were acting on the system. The calling account must have the appropriate permissions to perform impersonation. |
Ignore invalid server certificates |
Yes/No |
No |
No |
IGNOREINVALIDCERTIFICATE= "yes" |
If set to YES, invalid or expired SSL server certificates that are detected will be ignored. If set to NO and an invalid server certificate is found, this step will throw an error stating that the security certificate on the server is not valid. This parameter is set to NO by default and is only available if the Protocol Type parameter is set to Exchange 2007 (EWS) or Exchange 2010 (EWS). |
Authentication Type |
Text (options) |
No |
(Empty) |
|
Specifies the authentication type to administer. The following options are:
|
Username |
Text |
Yes if Use Authentication is set to YES. |
(Empty) |
USERNAME="theUser" |
A valid user name used to logon to the mail server and authenticate the mail transaction. This parameter is available only if the Use Authentication parameter is set to YES. NOTE: The From address entered should belong to the authenticated user. |
Password |
Text |
Yes if Use Authentication is set to YES. |
(Empty) |
PASSWORD="EncryptedText" |
A valid password used to logon to the mail server and authenticate the mail transaction. This parameter is available only if the Use Authentication parameter is set to YES. NOTE: The From address entered should belong to the authenticated user. |
Proxy type |
Text (options) |
No |
System default |
|
The proxy protocol that should be used. If you are unsure of the value to use in this parameter, contact your network administrator. The available options are:
|
Proxy server |
Text |
No |
(Empty) |
PROXYSERVER="proxy.host.com" |
The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. |
Proxy port |
Number |
No |
1028 |
PROXYPORT="3000" |
The port that should be used to connect to the proxy server. Most proxy servers operate on port 1028 (the default) however the proxy server can be customized to operate on other ports |
Proxy username |
Text |
No |
(Empty) |
PROXYUSERNAME="username" |
The username that should be used to authenticate when connecting through the proxy server. This option is only valid if the Use authentication parameter is enabled. |
Proxy password |
Text |
No |
(Empty) |
PROXYPASSWORD="encrypted" |
The password that should be used to authenticate when connecting through the proxy server. This option is only valid if the Use authentication parameter is enabled. |
Message Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
From |
Text |
Yes |
(Empty) |
|
The e-mail address information about who the mail should be sent from. Available formats are illustrated under Markup. NOTE: This parameter is empty by default but usually required by most servers. |
To |
Text |
Yes |
(Empty) |
|
The recipient(s) in which to send the message to. Multiple recipients can be specified by separating each entry with a semi-colon (;). Available formats are illustrated under Markup. |
Subject |
Text |
No |
(Empty) |
SUBJECT="Weekly Report" |
The subject of the message. |
Body |
Text |
No |
(Empty) |
This is the body</AMSENDEMAIL> |
The body of the message. If the Is HTML parameter is set to YES, this section should be properly formatted HTML, otherwise this parameter should contain a plain text version of the message. |
Is HTML |
Yes/No |
No |
No |
HTML="YES" |
If set to YES, specifies that the body of the message is formatted HTML and should be displayed by the recipient's mail client as such (if supported). Also causes the following mail header data to be inserted: Content-Type: multipart; boundary="xxxxx". If set to NO (default), the message is formatted in plain text. |
Use file contents as body |
Text |
No |
Disabled |
BODYFILE="c:\foldername\body.txt" |
If enabled, indicates that the body of the message should be obtained from the specified text file. You may enter the path and file name of the desired file manually or click the folder button to navigate to the desired file. This parameter is disabled by default. NOTE: This parameter only accepts contents of a single file. It does not support multiple file contents. |
Attachments Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Attachment |
Text |
Yes |
(Empty) |
|
Specifies file(s) to attach to the e-mail message. Files will be MIME encoded automatically. In Markup mode, multiple file attachments must be separated by semi-colons (;), in visual mode simply add the files to the list by clicking the Folder icon to select the appropriate file to attach then click Add to add the attachment selected. Added attachments will be shown under Current Attachments. To edit or remove an attachment from the Current Attachments list, select the attachment and click Edit or Remove. |
Options Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
CC |
Text |
No |
(Empty) |
CC="admin@mycompany.com" |
The addresses that the message should be sent "carbon-copies" to. Multiple recipients must be separated by semi-colons (;). This parameter will accept the following formats:
|
Reply to |
Text |
No |
(Empty) |
REPLYTO="me@mycompany.com |
The address information about who the mail should be from. |
BCC |
Text |
No |
(Empty)
|
BCC="sales@mycompany.com" |
The addresses that the message should be sent "blind-carbon-copies" to. Use of the "blind-carbon-copies" hides the addresses from the target users. Multiple recipients must be separated by semi-colons (;). This parameter will accept the following formats:
|
XMailer |
Text |
No |
AutoMate |
XMAILER="AM8" |
The X-Mailer header identifies the software that created the e-mail message. By default, this parameter is set to AutoMate. |
Priority |
Text (options) |
No |
Normal |
PRIORITY="high" |
The level of importance that the message being sent should be marked as. The recipient's e-mail client might in some way indicate the importance you assigned to a message. For example, messages carrying highest importance may be bolded in the Inbox or marked red, while less important messages can be grayed out or moved down the list. The available options are:
|
Sensitivity |
Text (options) |
No |
Normal |
SENSITIVITY="personal" |
The level of sensitivity that the message being sent should be marked as. For each of the sensitivity settings, the recipient will see specific text in the InfoBar of the message. The available options are:
NOTE: Each of these sensitivity settings is only an advisory. Recipients can take any action on the message that they want to, such as forwarding a confidential message to another person. |
Request delivery report |
Yes/No |
No |
No |
REQUESTDELIVERYREPORT="YES" |
If set to YES, specifies that a delivery receipt will be received upon delivery of the e-mail message to the recipient's mailbox. This option is set to NO by default. NOTE: A delivery receipt may not be received if the recipient's e-mail program does not support delivery receipts. |
Read receipt |
Yes/No |
No |
No |
READRECEIPT="YES" |
If set to YES, specifies that a read receipt will be received when the e-mail message has been opened. This option is set to NO by default. NOTE: In Microsoft Office Outlook, the message recipient has the option to decline to send read receipts. Additionally, read receipts are not sent if the recipient's e-mail program does not support read receipts. |
Custom Headers |
Text |
No |
(Empty) |
CUSTOMHEADERS="Description;Daily Report" |
Specifies one or more custom headers to send, which can be a useful way to exchange information using a standardized approach. To specify a custom header, click the Click here to add new item link and enter the desired header name and value in the Name and Value field. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Send e-mail message "report" to "you@yourcompany.com"
<AMSENDEMAIL FROM="me@mycompany.com" TO="you@yourcompany.com" SUBJECT="report" ATTACH="C:\Temp\Folder10\report.txt" PROTOCOLTYPE="ews2007" AUTODISCOVERURL="yes" ALLOWREDIRECTION="yes" IGNOREINVALIDCERTIFICATE="yes" DOMAINNAME="my.domain.com" USERNAME="me" PASSWORD="AM2SEnddJUXr7JfScp05hfctg==aME"> This is the body of the email.</AMSENDEMAIL>