发送邮件

发送邮件到指定的邮箱地址。

请求 URL

POST {base_url}/{api_path}/system/sendemail?access_token={access_token}

请求参数

参数 是否必填 类型 说明
email_server 是 String 邮件服务器类型。
取值范围：
  • follow_system：跟随系统
  • ys：星纵数字 SMTP 服务器
  • custom：自定义邮件服务器
recipient 否 Array<String> 收件人邮箱地址。
cc 否 Array<String> 抄送人邮箱地址。
bcc 否 Array<String> 密送人邮箱地址。
subject 否 String 邮件主题。
body 否 String 邮件正文内容。
attachments 否 Array<String> 附件。

取值范围：存储在 PBX 本地的文件的绝对路径。例如， /ysdisk/syslog/pbxlog.log。
force_attach 否 Integer

是否仅发送带有附件的邮件。

取值范围：

  • 0：禁用
  • 1：启用

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例
POST /openapi/v1.0/system/sendemail?access_token=n9lRd1ejSkrkc8AukPxYXTUt3wz5p7a2 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "email_server": "ys",
  "recipient": [
    "leo@yeastar.com",
    "dave@yeastar.com"
  ],
  "cc": [
    "test@yeastar.com"
  ],
  "bcc": [
    "demo@yeastar.com"
  ],
  "subject": "API Test",
  "body": "This is API Test",
  "attachments": [
    "/ysdisk/syslog/pbxlog.log"
  ],
  "force_attach": 0
}
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}