跳到主要内容

发送邮件(send-email)

发送邮件

快速体验

前期准备

  1. 如果使用QQ邮箱,预先准备好授权码
  2. 如果使用163邮箱,预先准备好POP3/SMTP授权码
  3. 如果使用企业邮箱请配置host(服务器地址)例如阿里邮箱SMTP地址和端口信息

快速开始

- plugin: @serverless-cd/send-email
inputs:
config:
service: 'qq', // 通用邮箱类型也可是163
pass: 'xxxxxxxx', // 这里密码不是qq密码,是你设置的smtp授权码
secure: true, // 为false默认端口号587 为true默认端口号为465
port: 465, // 自定义端口号
mail:
from: '"test" <xxxxxx@qq.com>', // 发送者qq邮箱地址
to: 'xxxx@qq.com', // 接收者邮箱,可以群发填写多个逗号分隔
subject: 'Hello', // 主题名(邮件名)
html: '<b>Hello world ${git.ref} ${args.name}?</b>'

邮箱示例

QQ邮箱示例:

- plugin: @serverless-cd/send-email
inputs:
config:
service: 'qq',
pass: 'xxxxxxxx', // 这里密码不是qq密码,是你设置的smtp授权码
secure: true, // 为false默认端口号587 为true默认端口号为465
mail:
from: 'xxxxxxxx@qq.com', // 发送者qq邮箱地址
to: 'xxxx@qq.com', // 接收者邮箱,可以群发填写多个逗号分隔
subject: 'Hello', // 主题名(邮件名)
html: '<b>Hello world ${git.ref} ${args.name}?</b>'

163邮箱示例:

- plugin: @serverless-cd/send-email
inputs:
config:
service: '163',
pass: 'xxxxxxxx', // 这里密码不是163邮箱密码,是你设置的pop3/smtp授权码
secure: true, // 为false默认端口号587 为true默认端口号为465
mail:
from: 'xxxxxxxx@163.com', // 发送者163邮箱地址
to: 'xxxx@qq.com','xxxx@163.com' // 接收者邮箱,可以群发填写多个逗号分隔
subject: 'Hello', // 主题名(邮件名)
html: '<b>Hello world ${git.ref} ${args.name}?</b>'

企业邮箱示例:

- plugin: @serverless-cd/send-email
inputs:
config:
host: 'smtp.qiye.aliyun.com', // 服务器地址
pass: 'xxxxxxxx', // smtp授权码 | 邮箱密码
port: 465, // 自定义端口号
mail:
from: 'xxxxxx@company.com', // 发送者公司邮箱地址
to: 'xxxx@company.com', // 接收者,可以群发填写多个逗号分隔
subject: 'Hello', // 主题名(邮件名)
html: '<b>Hello world ${git.ref} ${args.name}?</b>'

字段解析

参数名必填参数描述
configTrue邮件配置
mailTrue邮件内容

config

邮件服务配置

知名service 服务

支持知名service服务简化配置,具体查看文档

参数名必填参数描述
serviceTrue服务名
passTrue授权码

支持企业邮箱

支持知名Host服务简化配置,具体查看文档查看文档

参数名必填参数描述
hostTrue服务器地址
passTrue授权码 | 邮箱密码
portTrue服务器端口号

支持公司邮箱

支持知名Host服务简化配置,具体查看文档查看文档

参数名必填参数描述
hostTrue服务器地址
passTrue授权码
portTrue服务器端口号

smtp 协议

使用方式请查看文档

mail

邮件内容配置

参数名必填参数描述
fromTrue发件人,默认为 ${mail.from}
toTrue收件人
subjectTrue邮件主题
htmlFalse邮件内容(HTML格式)
textFalse邮件内容(文本格式)

注意事项

使用动态魔法变量

本插件可以使用Serverless-cd的全局context变量