Synopsis
Calls the Amazon Simple Email Service SendTemplatedEmail API operation.
Syntax
Send-SESTemplatedEmail-TemplateData <String>-Destination_BccAddress <String[]>-Destination_CcAddress <String[]>-ConfigurationSetName <String>-ReplyToAddress <String[]>-ReturnPath <String>-ReturnPathArn <String>-Source <String>-SourceArn <String>-Tag <MessageTag[]>-Template <String>-TemplateArn <String>-Destination_ToAddress <String[]>-Force <SwitchParameter>
Description
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the If your call to the For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
SendTemplatedEmail operation, your call to the API must meet the following requirements: - The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
- The message must be sent from a verified email address or domain.
- If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
- The maximum message size is 10 MB.
- Calls to the
SendTemplatedEmailoperation may only include oneDestinationparameter. A destination is a set of recipients who will receive the same version of the email. TheDestinationparameter can include up to 50 recipients, across the To:, CC: and BCC: fields. - The
Destinationparameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.
SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email. Parameters
-ConfigurationSetName <String>
The name of the configuration set to use when you send an email using
SendTemplatedEmail. | Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-Destination_BccAddress <String[]>
The BCC: field(s) of the message.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Destination_BccAddresses |
-Destination_CcAddress <String[]>
The CC: field(s) of the message.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Destination_CcAddresses |
-Destination_ToAddress <String[]>
The To: field(s) of the message.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Destination_ToAddresses |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ReplyToAddress <String[]>
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ReplyToAddresses |
-ReturnPath <String>
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the
ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ReturnPathArn <String>
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
ReturnPath parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.For more information about sending authorization, see the Amazon SES Developer Guide. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Source <String>
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the
SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SourceArn <String>
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the
Source parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.For more information about sending authorization, see the Amazon SES Developer Guide. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Tag <MessageTag[]>
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Tags |
-Template <String>
The template to use when sending this email.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-TemplateArn <String>
The ARN of the template to use when sending this email.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-TemplateData <String>
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the TemplateData parameter.
Outputs
This cmdlet returns a String object.
The service call response (type Amazon.SimpleEmail.Model.SendTemplatedEmailResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
