转发邮件提供者

概述

转发邮件提供者使用电子邮件发送“魔术链接”，其中包含包含验证令牌的 URL，可用于登录。

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

转发邮件提供者可以与一个或多个 OAuth 提供者结合使用（或替代使用）。

工作原理

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

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

⚠️

转发邮件提供者可以与 BasicAuth 和数据库管理的会话一起使用，但必须配置数据库才能使用它。无法在不使用数据库的情况下启用电子邮件登录。

配置

首先，您需要将您的域添加到您的转发邮件帐户。这是转发邮件的要求，也是您在from提供者选项中使用的地址的域。
接下来，您需要在我的帐户 → 安全中生成一个 API 密钥。您可以将此 API 密钥保存为AUTH_FORWARDEMAIL_KEY环境变量。

AUTH_FORWARDEMAIL_KEY=abc

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

./auth.ts

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

/src/routes/[email protected]

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

./src/auth.ts

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

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

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

自定义

电子邮件正文

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

./auth.ts

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

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

./lib/authSendRequest.ts

export async function sendVerificationRequest(params) {
  const { identifier: to, provider, url, theme } = params
  const { host } = new URL(url)
  const res = await fetch("https://api.forwardemail.net/v1/emails", {
    method: "POST",
    headers: {
      Authorization: `Basic ${btoa(provider.apiKey + ":")}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      from: provider.from,
      to,
      subject: `Sign in to ${host}`,
      html: html({ url, host, theme }),
      text: text({ url, host }),
    }),
  })
 
  if (!res.ok)
    throw new Error("Forward Email error: " + JSON.stringify(await res.json()))
}
 
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 ForwardEmail from "next-auth/providers/forwardemail"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    ForwardEmail({
      async generateVerificationToken() {
        return crypto.randomUUID()
      },
    }),
  ],
})

规范化电子邮件地址

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

./auth.ts

import NextAuth from "next-auth"
import ForwardEmail from "next-auth/providers/forwardemail"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    ForwardEmail({
      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")
        // }
      },
    }),
  ],
})

⚠️

始终确保这返回一个电子邮件地址，即使传入多个地址。

Faceit Foursquare

转发邮件提供者

概述

工作原理

配置

自定义

电子邮件正文

验证令牌

规范化电子邮件地址

关于 Auth.js

下载

鸣谢