Envie uma carta

API 0.16.0OpenAPIllms-full.txt

POST/v1/mailboxes/{mailbox_id}/send

Obrigatório Idempotency-Key 8–128 caracteres. Repetir com a mesma chave e corpo retorna a mesma operação; outro corpo dá 409. HTTP 202 significa fila. Verifique o status da operação, não o fato de que uma resposta foi recebida.

Áreas de autorização e acesso · Erros e repetições

Solicitar

curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/send' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"to":["[email protected]"],"subject":"Hello","text":"A message from Adapt Mail"}'

Opções

mailbox_idpathNecessariamente

integer

X-Customer-IDheader

Opção 1

string

Opção 2

null

Idempotency-KeyheaderNecessariamente

string

minLength: 8

maxLength: 128

Solicitar corpo · application/json

object

toNecessariamente

array

Endereços dos principais destinatários.

minItems: 1

maxItems: 50

Elementos da matriz

string

cc

array

Copie os endereços dos destinatários que estão visíveis para outros participantes.

maxItems: 50

Elementos da matriz

string

bcc

array

Endereços de destinatários Cco.

maxItems: 50

Elementos da matriz

string

subject

string

Assunto da carta.

Padrão: ""

maxLength: 998

text

string

O texto da carta sem formatação.

Padrão: ""

maxLength: 200000

html

HTML-versão formatada da carta.

Opção 1

string

maxLength: 300000

Opção 2

null

file_ids

array

ID arquivos baixados anteriormente nesta caixa de correio. Obtenha-os durante o download ou na lista de arquivos.

maxItems: 20

Elementos da matriz

string · uuid

forward_message

O e-mail original cujos anexos precisam ser encaminhados.

Opção 1

object

folderNecessariamente

string

Nome da pasta da lista de pastas, por exemplo INBOX.

minLength: 1

maxLength: 255

uidvalidityNecessariamente

integer

O valor é uidvalidity da resposta API para esta pasta.

exclusiveMinimum: 0

uidNecessariamente

integer

exclusiveMinimum: 0

Campos desconhecidos não são aceitos.

Opção 2

null

reply_to_message_id

O valor message_id do e-mail ao qual você está respondendo.

Opção 1

string

maxLength: 998

Opção 2

null

references

O valor references da mensagem original para salvar a cadeia de resposta.

Opção 1

string

maxLength: 4000

Opção 2

null

send_at

Tempo de despacho atrasado com fuso horário, por exemplo 2026-11-01T12:00:00Z. Sem um valor, o despacho começa conforme a fila é processada.

Opção 1

string · date-time

Opção 2

null

Campos desconhecidos não são aceitos.

Respostas

202 Resposta bem-sucedida

application/json

object

id

string · uuid

ID da operação para verificar o status e cancelar um envio pendente.

kind

string

mailbox_id

Opção 1

integer

Opção 2

null

status

string

Valores válidos: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

created_at

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

completed_at

Opção 1

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

Opção 2

null

error

O motivo do erro se a operação não foi concluída com êxito.

Opção 1

string

Opção 2

null

result

O resultado da operação. Para envio, contém informações sobre destinatários aceitos e rejeitados.

Opção 1

object

Opção 2

null

400 Cabeçalho ou identificador inválido

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

401 Login necessário

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

403 Sem acesso

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

404 Recurso não encontrado

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

409 Conflito de estado

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

413 Tamanho excedido

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

422 Erro de validação

application/json

object

detail

array

Elementos da matriz

object

locNecessariamente

array

Elementos da matriz

Opção 1

string

Opção 2

integer

msgNecessariamente

string

typeNecessariamente

string

503 Indisponibilidade temporária

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

Resultado de envio bem-sucedido

Os campos result da operação são posteriores à execução, não a resposta ao enfileiramento.

object

message_id

string

smtp_accepted

boolean

sent_saved

boolean

accepted_recipients

array

Elementos da matriz

string

rejected_recipients

array

Elementos da matriz

object

email

string

code

integer