|
Amazon SES - Send email |
Declaration
<AMAWSSES PROVIDER="session_based" SESSION="text" ACCESSKEY="text" SECRETKEY="text (encrypted)" USERAGENT="text" MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" PROXYUSER="text" PROXYPWD="text (encrypted)" SIGNMETHOD="text" SIGNVERSION="number" FROM="text" TO="text" SUBJECT="text" BODY="text" BODYFILE="text" HTML="YES/NO" CC="text" BCC="text" REPLYTO="text" XMAILER="text" ATTACH="text" IMPORTANCE="text (options)" SENSITIVITY="text (options)" READRECEIPT="YES/NO" CUSTOMHEADERS="text;text" RESULTVARIABLE="text" />
Description
Composes an email message based on input data, and then immediately queues the message for sending.
Practical Usage
Can be used to send a batch of emails.
Parameters
Connection
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Connection | --- | --- | --- | --- | Indicates
where Amazon Web Service user credentials and preferences should
originate from. This is a design mode parameter used only during
task construction and configuration, thus, comprises no markup.
The available options are:
|
Session | Text | Yes, if Connection is set to Session | SESSession1 | SESSION="SESSession1" | The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. The default session name is SESSession1. |
Access key | Text | Yes, if Connection is set to Host | (Empty) | ACCESSKEY="022QF06E7MXBSH9DHM02" | A 20-character alphanumeric string that uniquely identifies the owner of the AWS service account, similar to a username. This key along with a corresponding secret access key forms a secure information set that AWS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host. |
Secret access key | Text | Yes, if Connection is set to Host | (Empty) | SECRETKEY="text (encrypted)" | A 40-character string that serves the role as password to access the AWS service account. This along with an associated access key forms a secure information set that EC2 uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host. |
User agent | Text | No | Automate | USERAGENT="Automate" | The name of the client or application initiating requests to AWS. The default value is Automate. |
Maximum number of retries on error | Number | No | (Empty) | MAXERRORRETRY="4" | The total amount of times this activity should retry its request to the server before returning an error. Network components can generate errors anytime in the life of a request, thus, implementing retries can increase reliability. |
Service URL | Text | No | (Empty) | SERVICEURL="email.us-east-1.amazonaws.com" | The URL that provides the service endpoint. A complete list of EC2 regions, accompanying endpoints and valid protocols can be found below under Amazon SES Endpoints and Regions |
Proxy host | Text | No | (Empty) | PROXYHOST="proxy.host.com" | The host name (for example, server.domain.com) or IP address (for example, xxx.xxx.xxx.xxx) of the proxy server to use when connecting to AWS. |
Proxy port | Number | No | (Empty) | PROXYPORT="1028" | The port to use to connect to the proxy server. |
Proxy username | Text | No | (Empty) | PROXYUSER="username" | The username to authenticate the connection with the proxy server (if required). |
Proxy password | Text | No | (Empty) | PROXYPWD="text (encrypted)" | The password that should be used to authenticate connection with the proxy server (if required). |
Signature method | Text | No | (Empty) | SIGNMETHOD="HmacSHA256" | The signature method to use for signing the request. This provides a valid hashing algorithm for signature calculation. Valid AWS signature methods are HmacSHA1 and HmacSHA256. |
Signature version | Number | No | (Empty) | SIGNVERSION="2" | The signature version for signing the request. Valid AWS signature versions are 2 and 4. The difference with version 4 is that it allows you to sign your message using a key that is derived from your secret access key rather than using the secret access key itself. |
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
From | Text | Yes | (Empty) | FROM="me@mycompany.com" | The email address to use to send email messages. |
To | Text | Yes | (Empty) |
|
The email address of the recipients in which to send the message to. Multiple email addresses can be specified by separating each entry with a semi-colon (for example, kim@kimsemail.com;jim@jimsemail.com; tim@timsemail.com). |
Subject | Text | No | (Empty) | SUBJECT="Weekly Report" | The subject of the email message. |
Body | Text | No | (Empty) | The body</AMSENDEMAIL> | The body of the message. If the Is HTML parameter is set to Yes, this section should be in HTML format, 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 HTML formatted and should be displayed by the recipient's mail client as such (if supported). If set to No, the message is formatted in plain text. Set to No by default. |
Use file contents as body | Text | No | Disabled | BODYFILE="c:\temp\body.txt" | If enabled, indicates that the body
of the message should be obtained from the specified text file.
Click the folder icon to navigate to the desired file or enter
the path and file name manually. This parameter is disabled by
default. NOTE: This parameter only accepts contents of a single file. It does
not support multiple file contents. |
Populate variable with email message ID | Text | No | (Empty) | RESULTVARIABLE="ID" | The name of an existing variable to populate with the email message ID. |
Attachments
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Attachment | Text | No | (Empty) |
|
The files to attach to the email message. In visual mode add an attachment by selecting Click here to add new row then click the folder icon and navigate to the file you wish to attach. To remove an attachment click the red 'X'. In AML mode, multiple file attachments must be separated by a semi-colons (;) (for example, c:\file1.zip;c:\file2.txt;c:\file3.jpg). |
Advanced
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
CC | Text | No | (Empty) |
|
The email addresses in which to send a carbon-copy of the original message. Multiple addresses must be separated by a semi-colons (for example, kim@kimsemail.com;jim@jimsemail.com;tim@timsemail.com). |
Reply to | Text | No | (Empty) | REPLYTO="me@mycompany.com | The address information about who the mail should be from. |
BCC | Text | No | (Empty) |
|
The email addresses in which to send a blind carbon-copy of the original message. Multiple addresses must be separated by a semi-colons (for example, kim@kimsemail.com;jim@jimsemail.com;tim@timsemail.com). |
XMailer | Text | No | Automate | XMAILER="AM8" | The X-Mailer header. This is used to identify the program or application that created the email message. This parameter is set to Automate by default. |
Priority | Text (options) | No | Normal |
|
The level of importance that the message should
be marked as. The available options are:
|
Sensitivity | Text (options) | No | Normal |
|
The level of sensitivity that the message should
be marked as. The available options are:
|
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 email message to the recipient's mailbox. This parameter
is set to No by default.
NOTE: A delivery receipt may not be received if the recipient's email
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 email message has been opened (if the recipient's email program supports this feature). This parameter is set to No by default. |
Custom Headers | Text | No | (Empty) | CUSTOMHEADERS="Description;DailyReport" | Specifies one or more custom headers to send, which can be a useful way to exchange information using a standardized approach. In visual mode, add a custom header by selecting Click here to add new rowand enter the header name and value in the Name and Value fields. |
Additional Notes
Amazon SES Endpoints and Regions
This table contains a complete list of Amazon SES endpoints, along with their corresponding regions and supported protocols.
Endpoint | Region | Protocol |
---|---|---|
email.us-east-1.amazonaws.com | US East (Northern Virginia) Region | HTTPS |
email-smtp.us-east-1.amazonaws.com, port 465 | US East (Northern Virginia) Region | SMTP |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This sample task sends an email and populates a variable with the message ID to display it at the end of the task.
<AMVARIABLE NAME="messageID" />
<AMAWSSES ACTIVITY="create_session" SESSION="AWS_SES" ACCESSKEY="AKIAJ25JAKOPAC7GSQ7A" SECRETKEY="AM3T7rtr64B3HWdyXXdgodoX75MKeJ9sYb2WB/jrVp42eS4SBaLJw447IC9fw/BulRAaME" />
<AMAWSSES PROVIDER="session_based" SESSION="AWS_SES" FROM="test.exchange@netauto.com" TO="mm@netauto.com" SUBJECT="Hello" BODY="Isn't this fun?" RESULTVARIABLE="messageID" />
<AMAWSSES ACTIVITY="end_session" SESSION="AWS_SES" />
<AMSHOWDIALOG WINDOWTITLE="The Message ID" BUTTONS="ok_cancel" ONSECONDBUTTONCLICK="continue" ICON="information">The message ID returned is:%messageID%</AMSHOWDIALOG>