0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
logto/packages/connectors/connector-postmark/README.md
2024-07-31 14:22:21 +08:00

2 KiB

Postmark connector

Logto connector for Postmark email service.

Get started

Postmark is a mail platform for transactional and marketing email. We can use its email sending function to send a verification code.

Register Postmark account

Create a new account at Postmark website. You may skip this step if you've already got an account.

Configure your connector

Fill out the serverToken field with the Server Token you find under settings for your server in Postmark.

Fill out the fromEmail field with the senders' From Address.

In order to enable full user flows, templates with usageType Register, SignIn, ForgotPassword and Generic are required

Here is an example of Postmark connector template JSON.

[
    {
        "usageType": "Register",
        "templateAlias": "logto-register"
    },
    {
        "usageType": "SignIn",
        "templateAlias": "logto-sign-in"
    },
    {
        "usageType": "ForgotPassword",
        "templateAlias": "logto-forgot-password"
    },
    {
        "usageType": "Generic",
        "templateAlias": "logto-generic"
    },
]

Test Postmark email connector

You can type in an email address and click on "Send" to see whether the settings can work before "Save and Done".

That's it. Don't forget to Enable connector in sign-in experience

Config types

Name Type
serverToken string
fromEmail string
Template Properties Type Enum values
usageType enum string 'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
templateAlias string N/A