You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/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.

Instance Attribute Summary collapse

Instance Attribute Details

#failure_redirection_urlString

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

Returns:

  • (String)


839
840
841
842
843
844
845
846
847
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 839

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_addressString

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

Returns:

  • (String)


839
840
841
842
843
844
845
846
847
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 839

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_urlString

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

Returns:

  • (String)


839
840
841
842
843
844
845
846
847
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 839

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

#template_contentString

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.

Returns:

  • (String)


839
840
841
842
843
844
845
846
847
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 839

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

#template_nameString

The name of the custom verification email template.

Returns:

  • (String)


839
840
841
842
843
844
845
846
847
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 839

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

#template_subjectString

The subject line of the custom verification email.

Returns:

  • (String)


839
840
841
842
843
844
845
846
847
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 839

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