Receive Emails: Attachments

Get Attachment

Download an attachment of a message as base64 inside the command result.

POSThttps://g.sendcorex.com/v1command: get_attachment
i

Use the attachment_id from get_messages (include attachments). For large files, Raw Message downloads the binary directly.

!

An attachment blocked by the security scan is not returned.

Arguments

  • idstringrequired

    The message_uid.

  • attachment_idstringrequired

    The attachment id.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_attachment",
        args: {
          id: "Vj0xQUJDMTIz",
          attachment_id: "6f1c2a9e-4b7d-4e21-9a3f-0c8d5e7b1a42"
        }
      }
    ]
  },
  { 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": "get_attachment",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "attachment_id": "6f1c2a9e-4b7d-4e21-9a3f-0c8d5e7b1a42",
        "file_name": "invoice.pdf",
        "content_type": "application/pdf",
        "size_bytes": 48213,
        "content": "JVBERi0xLjcKJcfsj6IK…",
        "inline": false
      }
    }
  ]
}

Response fields

  • content

    The file in base64.

  • inline

    true for images embedded in the body (cid).

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.

  • CMDFILE_BLOCKED

    A file was blocked by the security scan.

  • CMDINTERNAL

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