Recevoir des e-mails : Pièces jointes

Téléverser un gros fichier

Envoyez un fichier jusqu'à 25 Mo sous forme de données binaires, en dehors du JSON de 1 Mo de POST /v1. Renvoie le même compose_uid et le même id de pièce jointe que upload_attachment.

POSThttps://g.sendcorex.com/v1/attachment
i

Utilisez cette route pour les fichiers de plus de 700 Ko environ. Avec upload_attachment, le fichier est envoyé en base64 dans le JSON, limité à 1 Mo, et le base64 grossit le fichier d'environ 33 %.

i

Envoyez ensuite le compose_uid (et éventuellement attachment_ids) dans send_email, reply, forward, schedule_send ou save_draft. Renvoyez le même compose_uid pour ajouter d'autres fichiers au même e-mail.

!

Les fichiers non envoyés sous 48 heures, et utilisés par aucun brouillon ni e-mail programmé, sont supprimés. Envoyez à nouveau le fichier si vous recevez ATTACHMENT_MISSING.

Query parameters

  • file_namestringobligatoire

    Nom du fichier affiché au destinataire. Obligatoire avec un body binaire ; en multipart, le nom de la partie file est utilisé.

  • compose_uidstringfacultatif

    Ajoute le fichier à un e-mail que vous êtes déjà en train de préparer. En multipart, il peut aussi s'agir d'un champ du formulaire.

Démarrage rapide

import axios from 'axios';
import { readFileSync } from 'node:fs';

const res = await axios.post('https://g.sendcorex.com/v1/attachment', readFileSync('invoice.pdf'), {
  params: { file_name: 'invoice.pdf' },
  headers: {
    Authorization: process.env.SENDCOREX_TOKEN,
    'Content-Type': 'application/pdf',
  },
  maxBodyLength: Infinity,
});

const { compose_uid, attachment } = res.data.data;
console.log(compose_uid, attachment.id);

Réponse

{
  "type": "SUCCESS",
  "data": {
    "compose_uid": "Vj0xQ01QMDAx",
    "attachment": {
      "id": "6f1c2a9e-4b7d-4e21-9a3f-0c8d5e7b1a42",
      "file_name": "invoice.pdf",
      "size_bytes": 3145728,
      "content_type": "application/pdf"
    }
  }
}

Champs de la réponse

  • data.compose_uid

    Envoyez-le avec les fichiers suivants du même e-mail et avec la commande d'envoi.

  • data.attachment.id

    Utilisez-le dans attachment_ids ou delete_attachment.

Body de la requête

Envoyez le fichier de l'une des deux façons. Un fichier par requête.

  • Binaire

    Le body est le fichier lui-même. Définissez Content-Type avec le type du fichier (par exemple application/pdf) ; sans lui, le fichier est enregistré en application/octet-stream.

  • Multipart

    multipart/form-data avec le fichier dans le champ file. Champs facultatifs : compose_uid et file_name.

Limites

  • Par fichier

    25 Mo.

  • Par e-mail

    20 fichiers et 25 Mo au total.

  • Par boîte aux lettres

    50 e-mails avec des fichiers pas encore envoyés, et 500 Mo au total. Envoyer un e-mail libère immédiatement sa part.

  • Fichiers non utilisés

    Supprimés au bout de 48 heures si aucun brouillon ni e-mail programmé ne les utilise. Les fichiers d'un brouillon ou d'un e-mail programmé restent tant qu'il existe.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • 400INVALID_ARGS

    `file_name` est manquant (body binaire), le multipart n'a pas de champ `file` ou en a plusieurs, ou `compose_uid` est invalide.

  • 400INVALID_ATTACHMENT

    Le fichier est vide ou n'a pas pu être lu.

  • 400FILE_BLOCKED

    Le fichier a été bloqué par l'analyse de sécurité.

  • 400ALREADY_SENT

    Le `compose_uid` appartient à un e-mail déjà envoyé.

  • 400TOO_MANY_OPEN_COMPOSES

    La boîte aux lettres a 50 e-mails avec des fichiers pas encore envoyés. Envoyez-les, ou attendez que ceux qui ne sont pas utilisés soient supprimés au bout de 48 heures.

  • 413ATTACHMENTS_TOO_LARGE

    Le fichier dépasse 25 Mo, l'e-mail dépasse 25 Mo, ou la boîte aux lettres a déjà 500 Mo de fichiers envoyés en attente d'envoi.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.