此操作用来设置或者修改邮件配置信息。
注意
如果邮件服务器地址是IPv6地址,为了确保邮件能发送成功,建议每台HBlock服务器上都有一个能连接到邮件服务器的IPv6地址。
请求语法
PUT /rest/v1/system/config/notification HTTP/1.1
Date: date
Content-Type: application/json; charset=utf-8
Content-Length: length
Host: ip:port
Authorization: authorization
{
"status": status,
"smtpHost": smtpHost,
"smtpPort": smtpPort,
"SSL": ssl,
"senderEmail": senderEmail,
"password": password,
"receiverEmail": reciverEmail
}
请求参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
status | String | 是否启用邮件通知功能。 取值:
| 是 |
smtpHost | String | SMTP服务器。 取值:SMTP服务器域名或IP。 注意 如果启用邮件通知时,未在服务端保存过邮件配置,此项必填。 | 否 |
smtpPort | Integer | SMTP端口号。 取值:[1,65535]。 说明
| 否 |
SSL | String | 是否启用SSL。 取值:
默认值为Disabled。 | 否 |
senderEmail | String | 发件箱。 邮箱格式local-part@domain:
注意 如果启用邮件通知时,未在服务端保存过邮件配置,此项必填。 | 否 |
password | String | 邮箱授权码。 说明 授权码是邮箱推出的,用于第三方客户端登录的专用密码。 注意 如果启用邮件通知时,未在服务端保存过邮件配置,此项必填。 | 否 |
receiverEmail | String | 收件箱。可以填写多个收件箱。 邮箱格式local-part@domain:
注意 如果启用邮件通知时,未在服务端保存过邮件配置,此项必填。 | 否 |
请求示例1
设置邮件配置信息,并启用邮件通知功能。
PUT /rest/v1/system/config/notification HTTP/1.1
Date: Mon, 1 Aug 2022 01: 53: 36 GMT
Content-Type: application/json; charset=utf-8
Authorization: HBlock userName:signature
Content-Length: 243
Host: 192.168.0.121: 1443
{
"status": "Enabled",
"smtpHost": "smtp.ctyun.cn",
"smtpPort": 475,
"SSL": "Enabled",
"senderEmail": "account1@ctyun.cn",
"password": "**************",
"receiverEmail": "account2@ctyun.cn"
}
响应示例1
HTTP/1.1 204 No Content
x-hblock-request-id: 24c17819e3ed4c648f37d13f9af05537
Connection: keep-alive
Date: Mon, 1 Aug 2022 01:53:36 GMT
Server: HBlock
请求示例2
关闭邮件通知功能,但是不删除已经配置的smtpHost等信息。
PUT /rest/v1/system/config/notification HTTP/1.1
Date: Mon, 01 Aug 2022 01: 56: 05 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 30
Host: 192.168.0.121: 1443
Authorization: HBlock userName:signature
{
"status": "Disabled"
}
响应示例2
HTTP/1.1 204 No Content
x-hblock-request-id: 9022434a208a4c2ebf89da97f3f72976
Connection: keep-alive
Date: Mon, 01 Aug 2022 01:56:05 GMT
Server: HBlock