All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendBulkTemplatedEmailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  SendBulkTemplatedEmailRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  SendBulkTemplatedEmailRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getConfigurationSetName () The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
  List<MessageTag>	getDefaultTags () A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.
  String	getDefaultTemplateData () A list of replacement values to apply to the template when replacement data is not specified in a Destination object.
  List<BulkEmailDestination>	getDestinations () One or more Destination objects.
  List<String>	getReplyToAddresses () The reply-to email address(es) for the message.
  String	getReturnPath () The email address that bounces and complaints are forwarded to when feedback forwarding is enabled.
  String	getReturnPathArn () This parameter is used only for sending authorization.
  String	getSource () The email address that is sending the email.
  String	getSourceArn () This parameter is used only for sending authorization.
  String	getTemplate () The template to use when sending this email.
  String	getTemplateArn () The ARN of the template to use when sending this email.
  int	hashCode ()
  void	setConfigurationSetName (String configurationSetName) The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
  void	setDefaultTags (Collection<MessageTag> 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.
  void	setDefaultTemplateData (String defaultTemplateData) A list of replacement values to apply to the template when replacement data is not specified in a Destination object.
  void	setDestinations (Collection<BulkEmailDestination> destinations) One or more Destination objects.
  void	setReplyToAddresses (Collection<String> replyToAddresses) The reply-to email address(es) for the message.
  void	setReturnPath (String returnPath) The email address that bounces and complaints are forwarded to when feedback forwarding is enabled.
  void	setReturnPathArn (String returnPathArn) This parameter is used only for sending authorization.
  void	setSource (String source) The email address that is sending the email.
  void	setSourceArn (String sourceArn) This parameter is used only for sending authorization.
  void	setTemplate (String template) The template to use when sending this email.
  void	setTemplateArn (String templateArn) The ARN of the template to use when sending this email.
  String	toString () Returns a string representation of this object.
  SendBulkTemplatedEmailRequest	withConfigurationSetName (String configurationSetName) The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
  SendBulkTemplatedEmailRequest	withDefaultTags (Collection<MessageTag> 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.
  SendBulkTemplatedEmailRequest	withDefaultTags (MessageTag... 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.
  SendBulkTemplatedEmailRequest	withDefaultTemplateData (String defaultTemplateData) A list of replacement values to apply to the template when replacement data is not specified in a Destination object.
  SendBulkTemplatedEmailRequest	withDestinations (BulkEmailDestination... destinations) One or more Destination objects.
  SendBulkTemplatedEmailRequest	withDestinations (Collection<BulkEmailDestination> destinations) One or more Destination objects.
  SendBulkTemplatedEmailRequest	withReplyToAddresses (Collection<String> replyToAddresses) The reply-to email address(es) for the message.
  SendBulkTemplatedEmailRequest	withReplyToAddresses (String... replyToAddresses) The reply-to email address(es) for the message.
  SendBulkTemplatedEmailRequest	withReturnPath (String returnPath) The email address that bounces and complaints are forwarded to when feedback forwarding is enabled.
  SendBulkTemplatedEmailRequest	withReturnPathArn (String returnPathArn) This parameter is used only for sending authorization.
  SendBulkTemplatedEmailRequest	withSource (String source) The email address that is sending the email.
  SendBulkTemplatedEmailRequest	withSourceArn (String sourceArn) This parameter is used only for sending authorization.
  SendBulkTemplatedEmailRequest	withTemplate (String template) The template to use when sending this email.
  SendBulkTemplatedEmailRequest	withTemplateArn (String templateArn) The ARN of the template to use when sending this email.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • SendBulkTemplatedEmailRequest

    public SendBulkTemplatedEmailRequest()

• Method Detail

  • setSource

    public void setSource(String 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

    Parameters:

    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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

  • getSource

    public String getSource()

    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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

    Returns:

    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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

  • withSource

    public SendBulkTemplatedEmailRequest withSource(String 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

    Parameters:

    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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setSourceArn

    public void setSourceArn(String 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.

    Parameters:

    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.

  • getSourceArn

    public String getSourceArn()

    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.

    Returns:

    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.

  • withSourceArn

    public SendBulkTemplatedEmailRequest withSourceArn(String 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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getReplyToAddresses

    public List<String> getReplyToAddresses()

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

    Returns:

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

  • setReplyToAddresses

    public void setReplyToAddresses(Collection<String> replyToAddresses)

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

    Parameters:

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

  • withReplyToAddresses

    public SendBulkTemplatedEmailRequest withReplyToAddresses(String... replyToAddresses)

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

    NOTE: This method appends the values to the existing list (if any). Use setReplyToAddresses(java.util.Collection) or withReplyToAddresses(java.util.Collection) if you want to override the existing values.

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withReplyToAddresses

    public SendBulkTemplatedEmailRequest withReplyToAddresses(Collection<String> replyToAddresses)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setReturnPath

    public void setReturnPath(String returnPath)

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

    Parameters:

    returnPath - The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

  • getReturnPath

    public String getReturnPath()

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

    Returns:

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

  • withReturnPath

    public SendBulkTemplatedEmailRequest withReturnPath(String returnPath)

    The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

    Parameters:

    returnPath - The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is 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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setReturnPathArn

    public void setReturnPathArn(String 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.

    Parameters:

    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.

  • getReturnPathArn

    public String getReturnPathArn()

    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.

    Returns:

    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.

  • withReturnPathArn

    public SendBulkTemplatedEmailRequest withReturnPathArn(String 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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setConfigurationSetName

    public void setConfigurationSetName(String configurationSetName)

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

    Parameters:

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

  • getConfigurationSetName

    public String getConfigurationSetName()

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

    Returns:

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

  • withConfigurationSetName

    public SendBulkTemplatedEmailRequest withConfigurationSetName(String configurationSetName)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getDefaultTags

    public List<MessageTag> getDefaultTags()

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

    Returns:

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

  • setDefaultTags

    public void setDefaultTags(Collection<MessageTag> 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.

    Parameters:

    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.

  • withDefaultTags

    public SendBulkTemplatedEmailRequest withDefaultTags(MessageTag... 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.

    NOTE: This method appends the values to the existing list (if any). Use setDefaultTags(java.util.Collection) or withDefaultTags(java.util.Collection) if you want to override the existing values.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withDefaultTags

    public SendBulkTemplatedEmailRequest withDefaultTags(Collection<MessageTag> 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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setTemplate

    public void setTemplate(String template)

    The template to use when sending this email.

    Parameters:

    template - The template to use when sending this email.

  • getTemplate

    public String getTemplate()

    The template to use when sending this email.

    Returns:

    The template to use when sending this email.

  • withTemplate

    public SendBulkTemplatedEmailRequest withTemplate(String template)

    The template to use when sending this email.

    Parameters:

    template - The template to use when sending this email.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setTemplateArn

    public void setTemplateArn(String templateArn)

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

    Parameters:

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

  • getTemplateArn

    public String getTemplateArn()

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

    Returns:

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

  • withTemplateArn

    public SendBulkTemplatedEmailRequest withTemplateArn(String templateArn)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDefaultTemplateData

    public void setDefaultTemplateData(String 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.

    Parameters:

    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.

  • getDefaultTemplateData

    public String getDefaultTemplateData()

    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.

    Returns:

    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.

  • withDefaultTemplateData

    public SendBulkTemplatedEmailRequest withDefaultTemplateData(String 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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getDestinations

    public List<BulkEmailDestination> getDestinations()

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

    Returns:

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

  • setDestinations

    public void setDestinations(Collection<BulkEmailDestination> destinations)

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

    Parameters:

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

  • withDestinations

    public SendBulkTemplatedEmailRequest withDestinations(BulkEmailDestination... destinations)

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

    NOTE: This method appends the values to the existing list (if any). Use setDestinations(java.util.Collection) or withDestinations(java.util.Collection) if you want to override the existing values.

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withDestinations

    public SendBulkTemplatedEmailRequest withDestinations(Collection<BulkEmailDestination> destinations)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public String toString()

    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

    Overrides:

    toString in class Object

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public SendBulkTemplatedEmailRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()