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

Class: Aws::CognitoIdentityProvider::Types::EmailConfigurationType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

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

{
  source_arn: "ArnType",
  reply_to_email_address: "EmailAddressType",
  email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
  from: "StringType",
  configuration_set: "SESConfigurationSet",
}

The email configuration type.

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_setString

The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

  • Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as SNS and CloudWatch.

  • IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

Returns:

  • (String)


4339
4340
4341
4342
4343
4344
4345
4346
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4339

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  include Aws::Structure
end

#email_sending_accountString

Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values:

COGNITO_DEFAULT

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide.

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account.

If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

Returns:

  • (String)


4339
4340
4341
4342
4343
4344
4345
4346
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4339

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  include Aws::Structure
end

#fromString

Identifies either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address will appear before the body of the email.

Returns:

  • (String)


4339
4340
4341
4342
4343
4344
4345
4346
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4339

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  include Aws::Structure
end

#reply_to_email_addressString

The destination to which the receiver of the email should reply to.

Returns:

  • (String)


4339
4340
4341
4342
4343
4344
4345
4346
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4339

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  include Aws::Structure
end

#source_arnString

The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

  • If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account.

  • If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

Returns:

  • (String)


4339
4340
4341
4342
4343
4344
4345
4346
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4339

class EmailConfigurationType < Struct.new(
  :source_arn,
  :reply_to_email_address,
  :email_sending_account,
  :from,
  :configuration_set)
  include Aws::Structure
end