AWSSESSendBulkTemplatedEmailRequest

Objective-C

@interface AWSSESSendBulkTemplatedEmailRequest

Swift

class AWSSESSendBulkTemplatedEmailRequest

Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

Required parameters: [Source, Template, Destinations]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable configurationSetName;

    Swift

    var configurationSetName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSSESMessageTag *> *_Nullable defaultTags;

    Swift

    var defaultTags: [AWSSESMessageTag]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable defaultTemplateData;

    Swift

    var defaultTemplateData: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSSESBulkEmailDestination *> *_Nullable destinations;

    Swift

    var destinations: [AWSSESBulkEmailDestination]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable replyToAddresses;

    Swift

    var replyToAddresses: [String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable returnPath;

    Swift

    var returnPath: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable returnPathArn;

    Swift

    var returnPathArn: String? { get set }

  • 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?=.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable source;

    Swift

    var source: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceArn;

    Swift

    var sourceArn: String? { get set }

  • The template to use when sending this email.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable template;

    Swift

    var template: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable templateArn;

    Swift

    var templateArn: String? { get set }