mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
61781062c1
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
src | ||
CHANGELOG.md | ||
logo-dark.svg | ||
logo.svg | ||
package.json | ||
README.md |
AWS direct mail connector
The official Logto connector for AWS connector for direct mail service.
Get started
Amazon SES is a cloud email service provider that can integrate into any application for bulk email sending.
Logto team to call the Amazon Simple Email Service APIs, with the help of which Logto end-users can register and sign in to their Logto account via mail verification code.
Configure a mail service in the AWS service console
💡 Tip
You can skip some sections if you have already finished.
Register AWS account
Go to AWS and register an account.
Create a identity
- Go to
Amazon Simple Email Service
Console - Create an identity, choose one of the following options
- Create an domain
- Create an email address
Configuration of the connector
- Click your username in the upper right corner of the Amazon console to enter
Security Credentials
. If you don't have one, create anAccessKey
and save it carefully. - Complete the settings of the
Amazon Simple Email Service
connector:- Use the
AccessKey ID
andAccessKey Secret
obtained in step 1 to fill inaccessKeyId
andaccessKeySecret
respectively. region
: Fill in theregion
field with the region of the identity you use to send mail.emailAddress
: The email address you use to send mail, in the format ofLogto<noreply@logto.io>
or<noreply@logto.io>
- Use the
the following parameters are optional; parameters description can be found in the AWS SES API documentation.
feedbackForwardingEmailAddress
feedbackForwardingEmailAddressIdentityArn
configurationSetName
Test the Amazon SES connector
You can type in an email address and click on "Send" to see whether the settings work before "Save and Done".
That's it. Don't forget to Enable connector in sign-in experience.
Configure types
Name | Type |
---|---|
accessKeyId | string |
accessKeySecret | string |
region | string |
emailAddress | string (OPTIONAL) |
emailAddressIdentityArn | string (OPTIONAL) |
feedbackForwardingEmailAddress | string (OPTIONAL) |
feedbackForwardingEmailAddressIdentityArn | string (OPTIONAL) |
configurationSetName | string (OPTIONAL) |
templates | Template[] |
Template Properties | Type | Enum values |
---|---|---|
subject | string | N/A |
content | string | N/A |
usageType | enum string | 'Register' | 'SignIn' | 'ForgotPassword' | 'Generic' |