Delete message
POST/v1/message/delete- For Scale version requests to this interface, please use the dedicated server address. Reference documentation: https://docs.getmx.com/docs/domain-email/operation/open#api-request-address
- This deletion interface performs a permanent deletion without moving to trash. To delete to trash, please use the /v1/message/move folder movement interface.
- For quick deletion of all emails in a mailbox, please use the /v1/mail/clean-up one-click cleanup interface.
请求参数
Body Params multipart/form-data
token
string
required
Token generated by the management backend
Example:
{{token}}
folder
string
required
Email folder, through the /v1/message/folder/list endpoint. e.g. Inbox. Note: Inbox for incoming messages, Drafts for drafts, Sent for sent messages, Deleted Items for deleted emails.
Example:
Inbox
mail_id
string
required
Mail ID (can be obtained from the GetMX management backend or through the /v1/mail/list endpoint; the 'id' field is the 'mail_id').
Example:
12345678
message_id
string
required
Message ID (obtainable through the /v1/message/list endpoint; the 'id' field corresponds to 'message_id')
Example:
12345678
示例代码
Responses
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
Data Schema
code
integer
required
msg
string
required
data
object
required
Example
{
"code": 0,
"msg": "string",
"data": {}
}Last modified: 1 个月前