关于本页

本页介绍更夫所基于的开源内核 Keep 的通用能力。更夫在其上提供国内化增强：钉钉/企业微信/飞书通知、国产大模型接入、LDAP 认证与值班管理。部署与上手请看快速上手。

概述

SMTP Provider 允许您从 Keep 发送电子邮件。大多数电子邮件服务如 Gmail、Yahoo、Mailgun 等都提供 SMTP 服务器来发送电子邮件。您可以使用这些 SMTP 服务器从 Keep 发送电子邮件。

SMTP provider 支持纯文本和 HTML 格式的电子邮件，允许您创建丰富的样式化电子邮件通知。

认证

此提供商需要身份验证。

• smtp_server: SMTP 服务器地址（必需：True，敏感：False）
• smtp_port: SMTP 端口（必需：True，敏感：False）
• encryption: SMTP 加密（必需：True，敏感：False）
• smtp_username: SMTP 用户名（必需：False，敏感：False）
• smtp_password: SMTP 密码（必需：False，敏感：True）

某些范围可能需要才能通过提供商执行特定操作或查询。以下是相关范围及其用例的摘要：

• send_email: 使用 SMTP 协议发送电子邮件（强制）

在工作流中

此提供商可用于工作流。

作为"操作"来进行更改或更新数据，示例：

actions:
    - name: Query smtp
      provider: smtp
      config: "{{ provider.my_provider_name }}"
      with:
        from_email: {value}
        from_name: {value}
        to_email: {value}
        subject: {value}
        body: {value}
        html: {value}

请查看以下工作流示例：

• send_smtp_email.yml
• send_smtp_html_email.yml

连接 SMTP Provider

1. 从您的电子邮件服务提供商获取 SMTP 凭据。例如：Gmail、Yahoo、Mailgun 等。
2. 在 Keep 中添加具有获取凭据的 SMTP Provider。
3. 使用 Keep 连接 SMTP Provider。

电子邮件格式支持

SMTP provider 支持两种电子邮件格式：

纯文本电子邮件

使用 body 参数发送纯文本电子邮件：

with:
  from_email: "sender@example.com"
  from_name: "Keep Alerts"
  to_email: "recipient@example.com"
  subject: "Alert Notification"
  body: "This is a plain text email notification."

HTML 电子邮件

使用 html 参数发送 HTML 格式的电子邮件：

with:
  from_email: "sender@example.com"
  from_name: "Keep Alerts"
  to_email: "recipient@example.com"
  subject: "Alert Notification"
  html: "<h1>Alert</h1><p>This is an <strong>HTML</strong> email notification.</p>"

当同时提供 body 和 html 时，HTML 内容优先。

多个收件人

您可以通过提供电子邮件地址列表来向多个收件人发送电子邮件：

with:
  to_email:
    - "recipient1@example.com"
    - "recipient2@example.com"
    - "recipient3@example.com"