pub struct EmailConfigurationType {
pub configuration_set: Option<String>,
pub email_sending_account: Option<String>,
pub from: Option<String>,
pub reply_to_email_address: Option<String>,
pub source_arn: Option<String>,
}
Expand description
The email configuration type.
Amazon Cognito has specific regions for use with Amazon SES. For more information on the supported regions, see Email Settings for Amazon Cognito User Pools.
Fields
configuration_set: Option<String>
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.
email_sending_account: Option<String>
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:
- COGNITODEFAULT
-
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.If EmailSendingAccount is COGNITODEFAULT, the following parameters aren't allowed:
-
EmailVerificationMessage
-
EmailVerificationSubject
-
InviteMessageTemplate.EmailMessage
-
InviteMessageTemplate.EmailSubject
-
VerificationMessageTemplate.EmailMessage
-
VerificationMessageTemplate.EmailMessageByLink
-
VerificationMessageTemplate.EmailSubject,
-
VerificationMessageTemplate.EmailSubjectByLink
DEVELOPER EmailSendingAccount is required.
-
- 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.
from: Option<String>
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.
reply_to_email_address: Option<String>
The destination to which the receiver of the email should reply to.
source_arn: Option<String>
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.
Trait Implementations
sourceimpl Clone for EmailConfigurationType
impl Clone for EmailConfigurationType
sourcefn clone(&self) -> EmailConfigurationType
fn clone(&self) -> EmailConfigurationType
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for EmailConfigurationType
impl Debug for EmailConfigurationType
sourceimpl Default for EmailConfigurationType
impl Default for EmailConfigurationType
sourcefn default() -> EmailConfigurationType
fn default() -> EmailConfigurationType
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for EmailConfigurationType
impl<'de> Deserialize<'de> for EmailConfigurationType
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<EmailConfigurationType> for EmailConfigurationType
impl PartialEq<EmailConfigurationType> for EmailConfigurationType
sourcefn eq(&self, other: &EmailConfigurationType) -> bool
fn eq(&self, other: &EmailConfigurationType) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &EmailConfigurationType) -> bool
fn ne(&self, other: &EmailConfigurationType) -> bool
This method tests for !=
.
sourceimpl Serialize for EmailConfigurationType
impl Serialize for EmailConfigurationType
impl StructuralPartialEq for EmailConfigurationType
Auto Trait Implementations
impl RefUnwindSafe for EmailConfigurationType
impl Send for EmailConfigurationType
impl Sync for EmailConfigurationType
impl Unpin for EmailConfigurationType
impl UnwindSafe for EmailConfigurationType
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more