npm 包 @peterpme/parse-server-mailgun 使用教程

阅读时长 6 分钟读完

在 Parse Server 上,通过邮件发送通知是一个非常常见的需求。如果你想在 Parse Server 上使用邮件通知功能,那么 @peterpme/parse-server-mailgun 是一个非常好的选择。

该 npm 包是一个 Parse Server 插件,它将所有邮件发送请求发送到 Mailgun。它还提供了一个简单的、易于使用的配置选项,以帮助您轻松地配置 Parse Server 发送邮件。

本文将介绍如何在 Parse Server 上使用 @peterpme/parse-server-mailgun。

安装

在使用 @peterpme/parse-server-mailgun 之前,您需要安装 Parse Server。您可以按照 Parse Server 的官方文档 来安装 Parse Server。

安装完 Parse Server 后,在你的项目中执行以下命令来安装 @peterpme/parse-server-mailgun:

配置

在使用 @peterpme/parse-server-mailgun 之前,您需要设置 Mailgun API 密钥。

如果您还没有 Mailgun API 密钥,请访问 Mailgun 官网 去注册一个 Mailgun 账号。然后,您可以在 Mailgun 控制台中生成一个 API 密钥。

在您的 Parse Server 项目中,您需要将以下代码添加到 Parse Server 配置文件中的 verifyUserEmails 部分:

在这里,您需要将 YOUR_MAILGUN_API_KEYYOUR_APP_NAMEYOUR_DOMAIN.COM 替换为您的 Mailgun API 密钥、应用程序名称和域名。

例如,您的 Parse Server 配置文件可能如下所示:

-- -------------------- ---- -------
-
  -------- --------------
  ------------ ------------------
  -------------- --------------------------------
  -------- ------------------
  ------------ ------------------------------
  ------------------ ------------------------------
  ------------------- -----
  --------------- -
    --------- ---------------------------------
    ---------- -
      --------- -----------------------
      -------------- -------------- ---------------------------
      --------- -----------------
    -
  -
-

使用

现在,您已经成功地配置了 @peterpme/parse-server-mailgun。您可以使用 Parse Server REST API 或 Parse SDK 中的 .sendEmail() 来发送邮件。

例如,您可以这样使用:

-- -------------------- ---- -------
-------------------------------------- ----- --------- -- -
  ----- ---- - ----- --- ---------------------------------------------
  ----- ------------ - ------------------
  ----- --------------------------------------------------

  ----- -----------------------
    --- -------------
    -------- -------- -- -- ------
    ----- ------ --- --- ------- -- ------
  -- - ------------- ---- ---

  ------ -------- ----- --- ---- --------------
---

在这里,我们使用 Parse Cloud Code 内的 Parse.Cloud.sendEmail() 来发送一封欢迎邮件。

示例代码

您可以使用以下示例代码来测试您的 Parse Server 是否已正确配置:

执行完上述代码后,在 Parse Server 控制台的 Cloud Code 中,您可以调用 sendTestEmail 方法以发送测试邮件。

例如,在 Cloud Code 控制台中,您可以这样调用 sendTestEmail

如果您在发送邮件时遇到任何问题,可以检查控制台输出来查看邮件发送状态。

总结

在本文中,我们介绍了如何使用 @peterpme/parse-server-mailgun 在 Parse Server 上发送邮件。首先,我们安装了 @peterpme/parse-server-mailgun,然后配置了 Mailgun API 密钥和邮件配置选项。最后,我们展示了如何使用 Parse Cloud Code 内置的 .sendEmail() 方法来发送邮件。

希望这篇文章对您在 Parse Server 上使用邮件通知功能有所帮助!

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005557281e8991b448d29f9

纠错
反馈