AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SendBulkTemplatedEmail operation. Composes an email message to multiple destinations. The message body is created using an email template.

In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleEmail.AmazonSimpleEmailServiceRequest
      Amazon.SimpleEmail.Model.SendBulkTemplatedEmailRequest

Namespace: Amazon.SimpleEmail.Model
Assembly: AWSSDK.SimpleEmail.dll
Version: 3.x.y.z

Syntax

C#
public class SendBulkTemplatedEmailRequest : AmazonSimpleEmailServiceRequest
         IAmazonWebServiceRequest

The SendBulkTemplatedEmailRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ConfigurationSetName System.String

Gets and sets the property ConfigurationSetName.

The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.

Public Property DefaultTags System.Collections.Generic.List<Amazon.SimpleEmail.Model.MessageTag>

Gets and sets the property DefaultTags.

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Public Property DefaultTemplateData System.String

Gets and sets the property DefaultTemplateData.

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Public Property Destinations System.Collections.Generic.List<Amazon.SimpleEmail.Model.BulkEmailDestination>

Gets and sets the property Destinations.

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

Public Property ReplyToAddresses System.Collections.Generic.List<System.String>

Gets and sets the property ReplyToAddresses.

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Public Property ReturnPath System.String

Gets and sets the property ReturnPath.

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.

Public Property ReturnPathArn System.String

Gets and sets the property ReturnPathArn.

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.

Public Property Source System.String

Gets and sets the property Source.

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 in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Public Property SourceArn System.String

Gets and sets the property SourceArn.

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.

Public Property Template System.String

Gets and sets the property Template.

The template to use when sending this email.

Public Property TemplateArn System.String

Gets and sets the property TemplateArn.

The ARN of the template to use when sending this email.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone