Class: Aws::SES::Types::CreateCustomVerificationEmailTemplateRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass CreateCustomVerificationEmailTemplateRequest data as a hash:

{
  template_name: "TemplateName", # required
  from_email_address: "FromAddress", # required
  template_subject: "Subject", # required
  template_content: "TemplateContent", # required
  success_redirection_url: "SuccessRedirectionURL", # required
  failure_redirection_url: "FailureRedirectionURL", # required
}

Represents a request to create a custom verification email template.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#failure_redirection_url ⇒ String

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Returns:

  • (String) 


764
765
766
767
768
769
770
771
772
 
# File 'lib/aws-sdk-ses/types.rb', line 764

class CreateCustomVerificationEmailTemplateRequest < Struct.new(
  :template_name,
  :from_email_address,
  :template_subject,
  :template_content,
  :success_redirection_url,
  :failure_redirection_url)
  include Aws::Structure
end

#from_email_address ⇒ String

The email address that the custom verification email is sent from.

Returns:

  • (String) 


764
765
766
767
768
769
770
771
772
 
# File 'lib/aws-sdk-ses/types.rb', line 764

class CreateCustomVerificationEmailTemplateRequest < Struct.new(
  :template_name,
  :from_email_address,
  :template_subject,
  :template_content,
  :success_redirection_url,
  :failure_redirection_url)
  include Aws::Structure
end

#success_redirection_url ⇒ String

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

Returns:

  • (String) 


764
765
766
767
768
769
770
771
772
 
# File 'lib/aws-sdk-ses/types.rb', line 764

class CreateCustomVerificationEmailTemplateRequest < Struct.new(
  :template_name,
  :from_email_address,
  :template_subject,
  :template_content,
  :success_redirection_url,
  :failure_redirection_url)
  include Aws::Structure
end

#template_content ⇒ String

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see [Custom Verification Email Frequently Asked Questions] in the *Amazon SES Developer Guide*.

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq

Returns:

  • (String) 


764
765
766
767
768
769
770
771
772
 
# File 'lib/aws-sdk-ses/types.rb', line 764

class CreateCustomVerificationEmailTemplateRequest < Struct.new(
  :template_name,
  :from_email_address,
  :template_subject,
  :template_content,
  :success_redirection_url,
  :failure_redirection_url)
  include Aws::Structure
end

#template_name ⇒ String

The name of the custom verification email template.

Returns:

  • (String) 


764
765
766
767
768
769
770
771
772
 
# File 'lib/aws-sdk-ses/types.rb', line 764

class CreateCustomVerificationEmailTemplateRequest < Struct.new(
  :template_name,
  :from_email_address,
  :template_subject,
  :template_content,
  :success_redirection_url,
  :failure_redirection_url)
  include Aws::Structure
end

#template_subject ⇒ String

The subject line of the custom verification email.

Returns:

  • (String) 


764
765
766
767
768
769
770
771
772
 
# File 'lib/aws-sdk-ses/types.rb', line 764

class CreateCustomVerificationEmailTemplateRequest < Struct.new(
  :template_name,
  :from_email_address,
  :template_subject,
  :template_content,
  :success_redirection_url,
  :failure_redirection_url)
  include Aws::Structure
end