To send an email on error, the default mail server must be defined in the registry. Refer to Sending E-Mails with Workflows for details.
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). The Send E-Mail action is 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.
Example
<AMSMTPMAIL SUBJECT="This is a test of the email action of AutoMate 5" TO="webmaster@networkautomation.com" SERVER="mail.server.com" FROM="me@networkautomation.com">Hello this is the body of my message
</AMSMTPMAIL>
See Also: Get Email, Twitter, HTTP, MSMQ
|
|
To send an email on error, the default mail server must be defined in the registry. Refer to Sending E-Mails with Workflows for details. |
To set Send E-mail properties
In the Available Actions pane, open the Network folder and double-click the Send E-mail action or drag it into the Steps pane.
Specify the properties that appear, depending on the activity selected.
To set the Description tab properties, refer to Description Tab Options.
To set the Error Causes and On Error tab properties, refer to Step Error Handling.
When finished, click OK to save settings and close the properties dialog box.
Email Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
From |
Text |
Yes |
(Empty) |
a)FROM="me@netauto.com" b)Network Automation Webmaster <webmaster@netauto.com> (Exchange protocol only) |
The e-mail address information about who the mail should be sent from. This parameter can be in any of the following formats: a. me@netauto.com b. Network Automation Webmaster <webmaster@netauto.com> (Exchange protocol only) NOTE: This parameter is empty by default but usually required by most servers. |
|
To |
Text |
Yes |
(Empty) |
a)you@netauto.com b)bob@netauto.com;amy@netauto.com c)Network Automation Webmaster <webmaster@netauto.com> (Exchange protocol only) |
The recipient(s) in which to send the message to. Multiple recipients can be specified by separating each entry with a semi-colon (;). This parameter accepts the following formats: a. me@mycompany.com b. bob@companyname.com;amy@companyname.com;sue@companyname.com c. MyCompany Webmaster <webmaster@mycompany.com> (Exchange protocol only) |
|
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 icon 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. |
Server Properties
These properties provide the option to enter custom mail server settings or attempt to use the default mail server settings as specified in the system properties. Different parameters become available depending on the option selected. The available options are:
Default server settings - Specifies that the AWE will attempt to use the default mail server settings as specified in SMTP options.
Custom server settings - Specifies that custom mail server settings will be entered manually for this action.
NOTE: This parameter only supports SMTP mail servers.
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Protocol |
Text (options) |
Yes |
SMTP |
PROTOCOLTYPE="IMAP" |
The protocol type to use. This parameter is available only if the Custom server settings parameter is enabled. 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 SMTP. |
|
Exchange Server |
Text |
Yes if Protocol is set to Exchange |
(Empty) |
SERVER="mail.server.com" |
The Exchange server that should be used to send the message. This parameter is available only if the Protocol Type parameter is set to Exchange 2003 (WebDav), Exchange 2007 (EWS) or Exchange 2010 (EWS). |
|
Port |
Number |
No |
25 |
PORT="3333" |
The port that should be used when connecting to the SMTP server. Most SMTP servers run on port 25 (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 SMTP. |
|
Security |
Text (options) |
Yes if Protocol is set to SMTP |
No security |
SECURITY="EXPLICIT" |
The type of security that this action should use. This parameter is available only if the Protocol parameter is set to SMTP. The available options are:
|
|
Disable chunking and pipelining |
Yes/No |
No |
No |
DISABLECHUNKING="YES" |
If set to YES, chunking and pipelining will be disabled (set to NO NO by default). This parameter is available only if the Protocol Type parameter is set to SMTP. Chunking refers to the ability to allow inconveniently large messages to be broken into conveniently-sized smaller "chunks." Pipelining reduces the time it takes to send multiple messages. A sending server would use pipelining to send all the messages it has to a receiver in one go. It sends all the commands "down the pipe" without waiting for a response from the remote server. Once all the commands have been received, only then will the remote server issue all its responses at once. Chunking and pipelining can possibly speed up transmissions. NOTE: Some anti-virus programs may cause e-mail transmission issues when chunking and pipelining is enabled. |
|
Use authentication |
Yes/No |
No |
No |
AUTHENTICATION="YES" |
If set to YES, indicates that a username/password is used to authenticate with the server. Other parameters become available if this parameter is set to YES. Set to NO by default. |
|
Authentication Type |
Text (options) |
No |
(Empty) |
AUTHTYPE="DigestMD5" |
Specifies the authentication type to administer. If the Protocol Type selected is SMTP, the following options are available:
|
|
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. |
|
Certificate |
Text |
Yes if Security is set to Explicit 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. |
|
Password |
Text |
Yes if Security is set to Explicit or Implicit TLS/SSL |
(Empty) |
CERTIFICATEPASSPHRASE= "encrypted" |
The password or passphrase which corresponds to the certificate entered (certificates with.pfx extensions may include a password/passphrase). This parameter is available only if the Security parameter is set to Explicit TLS/SSL or Implicit TLS/SSL. |
|
Ignore invalid server certificates |
Yes/No |
No |
No |
IGNOREINVALIDCERTIFICATE= "YES" |
If set to YES, AWE will automatically ignore any invalid server certificate it detects. If set to NO (default) a server SSL certificate issued by unknown or invalid certificate authority may cause this step to generate an error. This parameter is available only if the Security parameter is set to Explicit TLS/SSL or Implicit TLS/SSL. |
|
|
|
|
|
|
If the Protocol Type selected is Exchange 2003/2007/2010, the following options are available:
|
|
Domain Name |
Text |
Yes if Use Authentication is set to YES. |
(Empty) |
DOMAINNAME="domain.com" |
The domain name to authenticate with. This parameter is available only if the Use Authentication parameter is selected. |
|
Username |
Text |
Yes if Use Authentication is set to YES. |
(Empty) |
USERNAME="text" |
The user name to use to logon to the mail server and authenticate the mail transaction. This parameter is available only if the Use Authentication parameter is selected. NOTE: The From address entered should belong to the authenticated user. |
|
Password |
Text |
Yes if Use Authentication is set to YES. |
(Empty) |
PASSWORD="encryptedtext" |
The password which corresponds to the certificate entered (certificates with.pfx extensions may include a password/passphrase). This parameter is available only if the protocol selected in the Server tab under the Security parameter is Explicit TLS/SSL or Implicit TLS/SSL.This parameter is available only if the Use Authentication parameter is selected. |
|
Ignore invalid certificates |
Yes/No |
No |
No |
IGNOREINVALIDCERTIFICATE="yes" |
If a server SSL certificate is issued by unknown or invalid certificate authority, AWE may generate an error. If this parameter is set to YES, AWE will automatically ignore any invalid server certificate it detects. This parameter is available only if:
|
Attachments Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Attachment |
Text |
Yes |
(Empty) |
a)ATTACH= "c:\folder\file.zip b)ATTACH= "c:\file1zip;c:\file2.zip" |
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 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. |
Advanced Properties
|
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 AWE. |
|
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 |
|
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. |
Proxy Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Proxy Type |
Text (options) |
No |
(Empty) |
PROXYTYPE="Socks5" |
Specifies 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: System Default (default, recommended) None: Explicitly instructs the action not to use a proxy server regardless of the system default Socks 4: Instructs the action to go through a Socks 4 compliant server Socks 4a: Instructs the action to go through a Socks 4a compliant server Socks 5: Instructs the action to go through a Socks 5 compliant 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 Host |
Text |
No |
(Empty) |
PROXYSERVER="proxy.host.com" |
The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. |
|
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 when Socks 5 is specified in the Proxy type as it is the only version that supports authentication. |
|
Password |
Text |
No |
NULL |
PROXYPASSWORD="encrypted" |
The password that should be used to authenticate when connecting through the proxy server. When the step is created using the Task Builder it is written to the task encrypted. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.
|
This action includes the Description tab for entering a custom step description.
More on setting custom step description
This action also includes the standard Error Causes and On Error failure handling options/tabs.
More on Error Handling Options
All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, % Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.