SendcorexDocs

Receive Emails: Organize

Delete

Permanently delete messages. Only messages in Trash or Spam can be deleted.

POSThttps://g.sendcorex.com/v1command: delete
!

This cannot be undone. To send a message to the trash instead, use move with to_folder: "Trash".

i

A message that is also in another folder (for example a reply in Sent) is only removed from Trash. It is not erased.

Arguments

  • idsstring[]optional

    Up to 100 message ids.

  • idstringoptional

    A single message id. Use this or ids.

  • from_folderstringrequired

    Must be Trash or Spam. Anything else fails with NOT_IN_TRASH.

  • scopestringoptional

    thread (default) or message.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "delete",
        args: {
          id: "Vj0xQUJDMTIz",
          from_folder: "Trash"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "delete",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "items": [
          {
            "id": "Vj0xQUJDMTIz",
            "ok": true,
            "data": {
              "changed": 1,
              "deleted": 1,
              "removed": 0
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Response fields

  • items[].data.changed

    Entries changed.

  • items[].data.deleted

    Messages erased for good.

  • items[].data.removed

    Messages only removed from the folder because they also live in another folder.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401TOKEN_EXPIRED

    The access token has expired. Call Refresh Token and repeat the request.

  • 401INVALID_TOKEN

    The token is malformed, unknown or revoked.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.

  • CMDINVALID_ARGS

    A required argument is missing or invalid.

  • CMDNOT_FOUND

    The message, thread or folder does not exist for this token.

  • CMDNOT_IN_TRASH

    delete only works on messages in Trash or Spam. Use move to send a message to Trash first.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.