此操作用來設置或者修改郵件配置信息。
注意
如果郵件服務器地址是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.daliqc.cn",
"smtpPort": 475,
"SSL": "Enabled",
"senderEmail": "account1@daliqc.cn",
"password": "**************",
"receiverEmail": "account2@daliqc.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