Mailgun 提供商

资源

Mailgun 文档

概述

Mailgun 提供商使用电子邮件发送包含带有验证令牌的 URL 的“魔法链接”，这些令牌可用于登录。

除了一个或多个 OAuth 服务之外，添加对通过电子邮件登录的支持，为用户提供了一种在丢失对 OAuth 帐户的访问权限时登录的方法（例如，如果帐户被锁定或删除）。

Mailgun 提供商可以与一个或多个 OAuth 提供商一起使用（或代替）。

工作原理

在最初登录时，会将一个验证令牌发送到提供的电子邮件地址。默认情况下，此令牌有效期为 24 小时。如果在该时间段内使用了验证令牌（即，通过单击电子邮件中的链接），则会为用户创建一个帐户，并且他们将登录。

如果有人在登录时提供现有帐户的电子邮件地址，则会发送一封电子邮件，并且他们在单击电子邮件中的链接并使用验证令牌时，会登录到与该电子邮件地址关联的帐户。

⚠️

Mailgun 提供商可以与 JSON Web 令牌和数据库管理的会话一起使用，但是您必须配置一个数据库才能使用它。如果没有使用数据库，则无法启用电子邮件登录。

配置

首先，您需要将您的域添加到您的 Mailgun 帐户。这是 Mailgun 所要求的，也是您在from 提供商选项中使用的地址的域。
接下来，您必须在Mailgun 设置中生成一个 API 密钥。您可以将此 API 密钥保存为AUTH_MAILGUN_KEY环境变量。

AUTH_MAILGUN_KEY=abc

如果您将环境变量命名为AUTH_MAILGUN_KEY，则提供商将自动获取它，您的 Auth.js 配置对象可以更简单。但是，如果您想将其重命名为其他名称，则必须在 Auth.js 配置中手动将其传递到提供商中。

./auth.ts

import NextAuth from "next-auth"
import Mailgun from "next-auth/providers/mailgun"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  adapter: ...,
  providers: [
    Mailgun({
      // If your environment variable is named differently than default
      apiKey: import.meta.env.AUTH_MAILGUN_KEY,
      from: "[email protected]"
    }),
  ],
})

/src/routes/[email protected]

import { QwikAuth$ } from "@auth/qwik"
import Mailgun from "@auth/qwik/providers/mailgun"
 
export const { onRequest, useSession, useSignIn, useSignOut } = QwikAuth$(
  () => ({
    providers: [
      Mailgun({
        // If your environment variable is named differently than default
        apiKey: import.meta.env.AUTH_MAILGUN_KEY,
        from: "[email protected]",
      }),
    ],
  })
)

./src/auth.ts

import { SvelteKitAuth } from "@auth/sveltekit"
import Mailgun from "@auth/sveltekit/providers/mailgun"
import { env } from "$env/dynamic/prviate"
 
export const { handle, signIn, signOut } = SvelteKitAuth({
  adapter: ...,
  providers: [
    Mailgun({
      // If your environment variable is named differently than default
      apiKey: env.AUTH_MAILGUN_KEY,
      from: "[email protected]",
    }),
  ],
})

不要忘记为存储电子邮件验证令牌设置一个数据库适配器。
您现在可以使用电子邮件地址在/api/auth/signin处启动登录过程。

在用户第一次验证其电子邮件地址之前，不会为用户创建用户帐户（即Users表中的条目）。如果电子邮件地址已与帐户关联，则用户在单击魔法链接电子邮件中的链接并使用验证令牌时，会登录到该帐户。

自定义

电子邮件正文

您可以通过将自定义函数作为sendVerificationRequest选项传递给Mailgun()来完全自定义发送的登录电子邮件。

./auth.ts

import NextAuth from "next-auth"
import Mailgun from "next-auth/providers/mailgun"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    Mailgun({
      server: process.env.EMAIL_SERVER,
      from: process.env.EMAIL_FROM,
      sendVerificationRequest({
        identifier: email,
        url,
        provider: { server, from },
      }) {
        // your function
      },
    }),
  ],
})

例如，以下显示了我们内置的sendVerificationRequest()方法的源代码。请注意，我们正在渲染 HTML (html()) 并进行网络调用 (fetch()) 到 Mailgun，以便在此方法中实际执行发送操作。

./lib/authSendRequest.ts

export async function sendVerificationRequest(params) {
  const { identifier: to, provider, url, theme } = params
  const { host } = new URL(url)
  const domain = provider.from.split("@").at(1)
 
  if (!domain) throw new Error("malformed Mailgun domain")
 
  const form = new FormData()
  form.append("from", `${provider.name} <${provider.from}>`)
  form.append("to", to)
  form.append("subject", `Sign in to ${host}`)
  form.append("html", html({ host, url, theme }))
  form.append("text", text({ host, url }))
 
  const res = await fetch(`https://api.mailgun.net/v3/${domain}/messages`, {
    method: "POST",
    headers: {
      Authorization: `Basic ${btoa(`api:${provider.apiKey}`)}`,
    },
    body: form,
  })
 
  if (!res.ok) throw new Error("Mailgun error: " + (await res.text()))
}
 
function html(params: { url: string; host: string; theme: Theme }) {
  const { url, host, theme } = params
 
  const escapedHost = host.replace(/\./g, "&#8203;.")
 
  const brandColor = theme.brandColor || "#346df1"
  const color = {
    background: "#f9f9f9",
    text: "#444",
    mainBackground: "#fff",
    buttonBackground: brandColor,
    buttonBorder: brandColor,
    buttonText: theme.buttonText || "#fff",
  }
 
  return `
<body style="background: ${color.background};">
  <table width="100%" border="0" cellspacing="20" cellpadding="0"
    style="background: ${color.mainBackground}; max-width: 600px; margin: auto; border-radius: 10px;">
    <tr>
      <td align="center"
        style="padding: 10px 0px; font-size: 22px; font-family: Helvetica, Arial, sans-serif; color: ${color.text};">
        Sign in to <strong>${escapedHost}</strong>
      </td>
    </tr>
    <tr>
      <td align="center" style="padding: 20px 0;">
        <table border="0" cellspacing="0" cellpadding="0">
          <tr>
            <td align="center" style="border-radius: 5px;" bgcolor="${color.buttonBackground}"><a href="${url}"
                target="_blank"
                style="font-size: 18px; font-family: Helvetica, Arial, sans-serif; color: ${color.buttonText}; text-decoration: none; border-radius: 5px; padding: 10px 20px; border: 1px solid ${color.buttonBorder}; display: inline-block; font-weight: bold;">Sign
                in</a></td>
          </tr>
        </table>
      </td>
    </tr>
    <tr>
      <td align="center"
        style="padding: 0px 0px 10px 0px; font-size: 16px; line-height: 22px; font-family: Helvetica, Arial, sans-serif; color: ${color.text};">
        If you did not request this email you can safely ignore it.
      </td>
    </tr>
  </table>
</body>
`
}
 
// Email Text body (fallback for email clients that don't render HTML, e.g. feature phones)
function text({ url, host }: { url: string; host: string }) {
  return `Sign in to ${host}\n${url}\n\n`
}

如果您想使用 React 生成与许多电子邮件客户端兼容的外观出色的电子邮件，请查看mjml 或react-email

验证令牌

默认情况下，我们正在生成一个随机的验证令牌。如果您想覆盖它，可以在提供商选项中定义一个generateVerificationToken方法。

./auth.ts

import NextAuth from "next-auth"
import Mailgun from "next-auth/providers/mailgun"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    Mailgun({
      async generateVerificationToken() {
        return crypto.randomUUID()
      },
    }),
  ],
})

规范化电子邮件地址

默认情况下，Auth.js 会规范化电子邮件地址。它将地址视为不区分大小写（这在技术上不符合RFC 2821 规范，但在实践中，这会导致更多问题，例如，从数据库中按电子邮件查找用户时。）还会删除可能作为逗号分隔列表传递的任何辅助电子邮件地址。您可以通过Mailgun提供商上的normalizeIdentifier方法应用您自己的规范化。以下示例显示了默认行为。

./auth.ts

import NextAuth from "next-auth"
import Mailgun from "next-auth/providers/mailgun"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    Mailgun({
      normalizeIdentifier(identifier: string): string {
        // Get the first two elements only,
        // separated by `@` from user input.
        let [local, domain] = identifier.toLowerCase().trim().split("@")
        // The part before "@" can contain a ","
        // but we remove it on the domain part
        domain = domain.split(",")[0]
        return `${local}@${domain}`
 
        // You can also throw an error, which will redirect the user
        // to the sign-in page with error=EmailSignin in the URL
        // if (identifier.split("@").length > 2) {
        //   throw new Error("Only one email allowed")
        // }
      },
    }),
  ],
})

⚠️

始终确保这会返回一个电子邮件地址，即使传递了多个地址也是如此。

Mailchimp Mail.ru

Mailgun 提供商

资源

概述

工作原理

配置

自定义

电子邮件正文

验证令牌

规范化电子邮件地址

关于 Auth.js

下载

鸣谢