评论通知

大约 6 分钟...

当网站有用户发布评论或者用户回复评论时,Waline 支持对博主和回复评论作者进行通知。

博主通知支持多种方式,包括 QQ、微信、邮件等,回复评论作者仅支持邮件通知。

邮件通知

邮件通知需要配置以下环境变量:

  • SMTP_SERVICE: SMTP 邮件发送服务提供商。

    提示

    你可以在 这里open in new window 查看所有支持的运营商。

    如果你的运营商不受支持,你必须填写 SMTP_HOSTSMTP_PORT

    • SMTP_HOST: SMTP 服务器地址,一般可以在邮箱的设置中找到。
    • SMTP_PORT: SMTP 服务器端口,一般可以在邮箱的设置中找到。
  • SMTP_USER: SMTP 邮件发送服务的用户名,一般为登录邮箱。

  • SMTP_PASS: SMTP 邮件发送服务的密码,一般为邮箱登录密码,部分邮箱(例如 163)是单独的 SMTP 密码。

  • SITE_NAME: 网站名称,用于在消息中显示。

  • SITE_URL: 网站地址,用于在消息中显示。

  • AUTHOR_EMAIL: 博主邮箱,用来接收新评论通知。如果是博主发布的评论则不进行提醒通知。

以下是选填的环境变量:

  • SENDER_NAME: 自定义发送邮件的发件人
  • SENDER_EMAIL: 自定义发送邮件的发件地址
  • MAIL_SUBJECT: 自定义评论回复邮件标题
  • MAIL_TEMPLATE: 自定义评论回复邮件内容
  • MAIL_SUBJECT_ADMIN: 自定义新评论通知邮件标题
  • MAIL_TEMPLATE_ADMIN: 自定义新评论通知邮件内容

微信通知

微信通知使用了 Server 酱open in new window 提供的服务,需要在环境变量中配置在 Server 酱中申请的 SC_KEY

  • SC_KEY: Server 酱提供的 Token,必填。
  • AUTHOR_EMAIL: 博主邮箱,用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
  • SITE_NAME: 网站名称,用于在消息中显示。
  • SITE_URL: 网站地址,用于在消息中显示。

企业微信应用通知

由于 Server 酱open in new window 提供的推送服务对发送消息数量有限制,如果消息数量较多时,建议使用企业微信应用通知。

要使用企业微信应用通知,需要配置环境变量 QYWX_AM

第一个值是企业 id,第二个值是应用 secret,第三个值@all(或者成员 id),第四个值是 AgentID,第五个值是图片 id,中间以逗号隔开。最终格式例:

ww479cadfqfe8c151f,MPKN9gX97w4e4b4h4u7u4i4i4i4iO6mN_dDedBFzqC5c,@all,1000002,2S8H-JWEdsadFDSFSDDijbrtkldfhjslafhs5zEU1GyUkU

参考文档 1open in new window | 参考文档 2open in new window

  • QYWX_AM: 用于发送企业应用消息的变量,必填。
  • AUTHOR_EMAIL: 博主邮箱,用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
  • SITE_NAME: 网站名称,用于在消息中显示。
  • SITE_URL: 网站地址,用于在消息中显示。
  • WX_TEMPLATE: QYWX_AM 使用的通知模板,变量与具体格式可参见下文 QQ 的通知模板。未配置则使用默认模板。

QQ 通知

QQ 通知使用了 Qmsg 酱open in new window 提供的服务,需要在环境变量中配置在 Qmsg 酱中申请的 QMSG_KEY

  • QMSG_KEY: Qmsg 酱提供的 KEY,必填。
  • QQ_ID: 接收消息的 QQ 号 (不支持 QQ 群),可以添加多个,以半角逗号分割,如: 1244453393,2952937634 (必须均在您的 Qmsg 酱 QQ 号列表中)。
  • AUTHOR_EMAIL: 博主邮箱,用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
  • SITE_NAME: 网站名称,用于在消息中显示。
  • SITE_URL: 网站地址,用于在消息中显示。
  • QQ_TEMPLATE: QQ 使用的通知模板,变量与具体格式可参见下文的通知模板。未配置则使用默认模板。

Telegram 通知

Telegram 通知通过 Telegram bot 机器人实现,需要配置以下几个环境变量:

  • TG_BOT_TOKEN: Telegram 机器人用于访问 HTTP API 的 token,通过 @BotFatheropen in new window 创建机器人获取,必填。
  • TG_CHAT_ID: 接收消息对象的 chat_id,可以是单一用户、频道、群组,通过 @userinfobotopen in new window 获取,必填。
  • AUTHOR_EMAIL: 博主邮箱,用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
  • SITE_NAME: 网站名称,用于在消息中显示。
  • SITE_URL: 网站地址,用于在消息中显示。
  • TG_TEMPLATE: Telegram 使用的通知模板,变量与具体格式可参见下文的通知模板。未配置则使用默认模板。

PushPlus 通知

pushplusopen in new window 集成了微信、企业微信、钉钉、短信、邮件等渠道的信息推送平台。需要配置以下几个环境变量,具体的参数格式见 pushplus 文档open in new window

  • PUSH_PLUS_KEY: 用户令牌,即 token,必填。
  • PUSH_PLUS_TOPIC:群组编码,不填仅发送给自己;channel 为 webhook 时无效
  • PUSH_PLUS_TEMPLATE:发送模板
  • PUSH_PLUS_CHANNEL:发送渠道
  • PLUSH_PLUS_WEBHOOK:webhook 编码,仅在 channel 使用 webhook 渠道和 CP 渠道时需要填写
  • PUSH_PLUS_CALLBACKURL:发送结果回调地址
  • AUTHOR_EMAIL: 博主邮箱,用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
  • SITE_NAME: 网站名称,用于在消息中显示。
  • SITE_URL: 网站地址,用于在消息中显示。

Discord 通知

Discord 通知通过 Discord Webhook 实现,需要配置以下几个环境变量:

  • DISCORD_WEBHOOK:Discord Webhook 地址,如何创建 Discord Webhookopen in new window
  • DISCORD_TEMPLATE:发送模板
  • AUTHOR_EMAIL: 博主邮箱,用来区分发布的评论是否是博主本身发布的。如果是博主发布的则不进行提醒通知。
  • SITE_NAME: 网站名称,用于在消息中显示。
  • SITE_URL: 网站地址,用于在消息中显示。

通知模板

Waline 支持为每个平台分别配置您自定义的通知模板,从而实现更强大的自定义能力与多语言兼容性。

支持的变量

模板通过 selfparentsite 对象传递参数,其中分别包含以下变量:

  • self: 该条评论本身

    变量备注
    nick评论者名
    mail评论者邮箱
    link评论者网址
    url文章地址
    comment评论内容
    commentLink*评论中的链接

    *: commentLink 仅在 Telegram 通知中提供,会自动封装成 Markdown 的格式

  • parent: 该条评论的回复对象(父评论)

    变量备注
    nick评论者名
    mail评论者邮箱
    link评论者网址
    type评论者类型
    comment评论内容
  • site: 网站配置

    变量备注
    name站点名
    url站点网址
    postUrl评论完整地址

默认模板

此处附上默认的模板,方便您参考:

  • QQ_TEMPLATE:

    💬 {{site.name|safe}} 有新评论啦
    {{self.nick}} 评论道:
    {{self.comment}}
    邮箱: {{self.mail}}
    状态: {{self.status}}
    仅供评论预览,查看完整內容:
    {{site.postUrl}}
    
  • TG_TEMPLATE:

    💬 _[{{site.name}}]({{site.url}}) 有新评论啦_
    
    _{{self.nick}}_ 回复说:
    
    ```
    {{self.comment-}}
    ```
    
    {{-self.commentLink}}
    _邮箱_: `{{self.mail}}`
    _审核_: {{self.status}}
    
    仅供评论预览,点击 [查看完整內容]({{site.postUrl}})
    

附加说明

  1. Vercel 的环境变量大小限制为 4KB ,所以如果您的模板很长,请使用代码配置,参见 issue#106open in new window
  2. 变量具体信息在开发过程中可能会发生变化,此处的变量说明仅供参考,具体的内容请以具体的代码示例为准。
友情提示:评论区仅作评论展示,如有问题咨询请去 Github Discussion 中提问。
评论
Powered by Waline v2.6.1