Skip to main content

Email connectors

An email connector integrates your email delivery service with Logto to enable secure user verification through email. Once configured, you can send one-time passwords (OTPs) for user sign-up, sign-in, password reset, account linking, member invitations and high-risk operation validation.

Choose your email connector​

Logto offers three types of email connector options:

Free Logto Email Service (Cloud only)​

This built-in email service option is ideal for getting started quickly for both testing and production. It eliminates the need for third-party integrations; and offers free, reliable email delivery. Simply customize your basic branding for the pre-designed email templates.

The Logto Email Service connector now offers branded customization capabilities, including logo, company information, and sender name.

However, while convenient, there are some limitations to be aware of — you cannot customize the sender's email address, domain, or the specific email content.

Connect with your preferred email service provider (ESP) using Logto's step-by-step guides.

These options allow you to fully customize your email template, sender name, etc., to best serve your branding.

We provide out-of-the-box support for the following email service providers:

Customize your email connector​

If none of the above solutions meet your needs, you can also choose to connect to your desired email service using Simple Mail Transfer Protocol (SMTP).

If you already have your own email service and are not eligible for using an SMTP connection, we also provide a "HTTP email connector".

When it needs to send an email, it sends an API call to the configured endpoint to complete the email-dependent auth flow. Note that to prevent auth flow errors, the configured endpoint needs to return a 200 response after receiving the WebHook to inform Logto that it has received the notification to send the email. In this case, you need to monitor your own email service to ensure successful delivery.

If our standard connectors don't meet your specific requirements, don't hesitate to contact us. For OSS users, you can implement your connector (OSS) if the requirement is in urgent. We always welcome contributions; your effort could very well help other community members with the same needs.

Configure steps​

Follow the steps below to add an email connector:

  1. Navigate to Console > Connectors > Email and SMS connectors .
  2. To add a new email connector, click the "Set up" button and select your desired email provider.
  3. Review the README documentation and configure for your chosen provider step-by-step.
  4. Click "Save and Done" to finish.

Change email connector​

You may notice that only one email connector can be added.

When you already have an email connector, you can only select "Change email connector". When performing this operation in the console, it takes effect immediately once saved, so please be sure to test your configuration before saving.

To ensure the stability of your service, Cloud users can create a dev tenant for the development environment. After testing the configuration in the development environment, "migrate" the configuration to production, and then save the setup.

Enable email sign-up or sign-in​

Once you successfully add the email connector and complete the configuration, you can enable sign-in and sign-up configurations that rely on email + verification code, according to your business needs.

  1. Navigate to: Console > Sign-in experience > Sign-up and sign-in
  2. Set sign-up methods: Choose "Email address" or "Email address or phone number" as the sign-up identifier. Note: email verification is currently mandatory during sign-up.
  3. Set sign-in methods: The chosen sign-up identifier automatically becomes a sign-in method. Click "Add another" for additional sign-in options.
  4. Save Changes and Test: Click "Save changes" to implement the new sign-in experience. Remember to use the "Live preview" to test the functionality.
warning:

Because our configurations take effect immediately, deleting existing email connector can affect end-users' normal login and registration processes.

For example, if the sign-in identifier includes "email + verification code" combination, deleting the existing email connector will prevent users from receiving verification codes via email and will result in an error in the sign-in flow.

Please be aware of the potential risks when operating on connectors.

FAQs​

How to customize the email sender name?​

We're still working on more connectors. If you require further options, just let us know your needs in Discord and file a Feature Request on GitHub. If you need further assistance, you can also contact us via email.

For contributors, we provide an easy-to-extend connector creation method, allowing you to customize your own connector based on your specific scenarios. You are always welcomed to submit a pull request to Logto, so that others in the community may also benefit from your work.

How can I restrict IP addresses for email requests in Logto email connectors?​

One workaround is to use the Logto HTTP email connector.

Implement an API endpoint on your server that calls the relevant email service, and trigger this API endpoint through the Logto HTTP email connector. In this way, you will have complete control over the IP address of your API endpoint and can add the corresponding IP addresses to the whitelist in the email service provider's configuration.