Receber e-mails: Anexos

Upload de arquivo grande

Envie um arquivo de até 25 MB como dados binários, fora do JSON de 1 MB do POST /v1. Retorna o mesmo compose_uid e id de anexo que upload_attachment.

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

Use esta rota para arquivos acima de uns 700 KB. Em upload_attachment o arquivo vai em base64 dentro do JSON, que é limitado a 1 MB, e o base64 deixa o arquivo cerca de 33% maior.

i

Depois envie o compose_uid (e, opcionalmente, attachment_ids) em send_email, reply, forward, schedule_send ou save_draft. Envie o mesmo compose_uid de novo para adicionar mais arquivos ao mesmo e-mail.

!

Uploads não enviados em 48 horas, e que nenhum rascunho ou e-mail agendado usa, são excluídos. Envie o arquivo de novo se receber ATTACHMENT_MISSING.

Query parameters

  • file_namestringobrigatório

    Nome do arquivo exibido para o destinatário. Obrigatório com body binário; com multipart, é usado o nome da parte file.

  • compose_uidstringopcional

    Adiciona o arquivo a um e-mail que você já está montando. Com multipart, também pode ser um campo do formulário.

Início rápido

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);

Resposta

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

Campos da resposta

  • data.compose_uid

    Envie-o com os próximos uploads do mesmo e-mail e com o comando de envio.

  • data.attachment.id

    Use-o em attachment_ids ou delete_attachment.

Body da requisição

Envie o arquivo de uma de duas formas. Um arquivo por requisição.

  • Binário

    O body é o próprio arquivo. Defina Content-Type com o tipo do arquivo (por exemplo application/pdf); sem ele, o arquivo é salvo como application/octet-stream.

  • Multipart

    multipart/form-data com o arquivo no campo file. Campos opcionais: compose_uid e file_name.

Limites

  • Por arquivo

    25 MB.

  • Por e-mail

    20 arquivos e 25 MB no total.

  • Por caixa de correio

    50 e-mails com uploads ainda não enviados, e 500 MB no total. Enviar um e-mail libera a parte dele na hora.

  • Uploads não usados

    Excluídos após 48 horas se nenhum rascunho ou e-mail agendado os usar. Os arquivos de um rascunho ou e-mail agendado ficam enquanto ele existir.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • 400INVALID_ARGS

    `file_name` está ausente (body binário), o multipart não tem campo `file` ou tem mais de um, ou `compose_uid` é inválido.

  • 400INVALID_ATTACHMENT

    O arquivo está vazio ou não pôde ser lido.

  • 400FILE_BLOCKED

    O arquivo foi bloqueado pela verificação de segurança.

  • 400ALREADY_SENT

    O `compose_uid` pertence a um e-mail que já foi enviado.

  • 400TOO_MANY_OPEN_COMPOSES

    A caixa de correio tem 50 e-mails com uploads ainda não enviados. Envie-os ou espere os não usados serem excluídos após 48 horas.

  • 413ATTACHMENTS_TOO_LARGE

    O arquivo passa de 25 MB, o e-mail passa de 25 MB, ou a caixa de correio já tem 500 MB de uploads aguardando envio.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.