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.

Request

Body Params multipart/form-data

token

string

required

Token generated by the management backend

Example:

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://domain-open-api.getmx.com/v1/message/delete' \
--form 'token="token"' \
--form 'folder="Inbox"' \
--form 'mail_id="12345678"' \
--form 'message_id="12345678"'

Responses

🟢200成功

application/json

Body

code

integer

required

msg

string

required

data

object

required

Example

{
  "code": 0,
  "msg": "string",
  "data": {}
}

Modified at 2024-12-03 00:49:37

Get Message Detail

Flagged Message