集成 SMTP

魔笔平台提供了强大的 SMTP 集成功能,允许用户通过简单的配置,实现对 SMTP 服务的无缝连接和数据交互。本文档将指导您如何创建和使用 SMTP 集成。

功能介绍

魔笔平台的 SMTP 集成功能支持以下特点:

  • 自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。

  • 回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。

  • 高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。

事件相关内容可参考:集成操作事件

使用 SMTP 集成

步骤 1:创建 SMTP 集成

  1. 登录魔笔平台,进入管控台。

  2. 导航至“资源”->“集成”,点击“创建集成”。

  3. 选择“SMTP 配置”,并填写集成名称及描述。

  4. 配置不同环境的 SMTP 集成信息,包括HostPort等。

  5. 点击“确定”以创建 SMTP 集成。

步骤 2:在应用内部创建集成操作

  1. 打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。

    image

  2. 选择之前创建的 SMTP 集成作为资源,选择 Method 并输入 path 后,根据需求,选择集成操作的触发方式和更加细节的配置内容。

image

  1. 点击“运行”预览查询效果。

配置面板详解

集成配置

  • Host:SMTP 邮件服务器的地址(如 smtp.qq.com)。

  • Port:SMTP 服务的端口号(常用25、465、587)。

  • 邮件地址(账号名):发送邮件的邮箱地址。

  • 授权码:邮箱服务商提供的应用专用密码,用于第三方客户端登录验证。注意不是邮箱密码。

  • 是否使用 SSL:是否启用 SSL 进行安全加密。

image

通用配置

  • 发送方:发送方的邮件地址,如果不填则使用集成资源配置的邮件地址,否则会使用该邮件地址进行校验。

  • 接收方:接收方的邮件地址。

  • 主题:邮件的主题。

  • 正文:邮件正文。

image

回调配置

  • 数据转化:对接口返回的数据进行处理,默认为return data,即不进行处理。

  • 流式接收回调:配置流式调用接口 chunk 数据获取时触发的事件。

  • 成功回调:配置接口调用成功时触发的事件。

  • 失败回调:配置接口调用失败时触发的事件。

高级配置

  • 防抖:设置防抖表达式,避免接口的频繁调用。

  • 禁止执行条件:根据条件表达式确定是否执行此集成操作。

手动触发集成

事件触发

  1. 在需要触发集成操作的组件中,配置事件处理器。

  2. 将动作类型设置为集成操作,并选择相应的集成。

  3. 以对象形式填写已配置的参数。

API 触发

若此集成操作的名称为action1,则在任何可以执行脚本的地方,可以使用action1.trigger()方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。