> ## Documentation Index
> Fetch the complete documentation index at: https://docs.escrybe.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# E-mail Registrado

> Envie e-mails registrados juridicamente e acompanhe entrega e abertura.

E-mails registrados são enviados por um provedor certificado e monitorados
quanto a eventos de entrega e abertura.

## Endpoints

| Método | Caminho                                      | Descrição                   |
| ------ | -------------------------------------------- | --------------------------- |
| `POST` | `/api/email/v1/post`                         | Enviar um e-mail registrado |
| `GET`  | `/api/email/v1/get/{securityToken}/{job_id}` | Consultar status            |

Os schemas completos estão na aba **Referência da API**.

## Enviando

`POST /api/email/v1/post` exige ao menos `name`, `email` e `subject`, além de
`msg` (corpo HTML) **ou** um `attachment`.

```bash theme={null}
curl -X POST "https://app.escrybe.com.br/api/email/v1/post" \
  -F "userSecurityToken=SEU_TOKEN" \
  -F "name=Maria Silva" \
  -F "email=maria@exemplo.com" \
  -F "subject=Seu contrato" \
  -F "msg=<p>Olá Maria, segue seu contrato em anexo.</p>" \
  -F "attachment=@/caminho/para/contrato.pdf"
```

* Anexos são limitados a **20 MB**; tipos comuns de documento e imagem são
  aceitos; PDFs com senha são rejeitados.
* Domínios de e-mail descartáveis são rejeitados.
* `reply_to` usa o endereço de resposta padrão do seu perfil quando omitido e,
  na falta dele, o e-mail da conta.
* Um corpo JSON (`application/json`) também é aceito para envios sem anexo.

## Acompanhamento

`GET /api/email/v1/get/{securityToken}/{job_id}` retorna o estado de entrega
(ids de pedidos de e-mail começam com `E`, ex.: `E2607031`):

| Campo                                          | Significado                                                                                                         |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `status`                                       | 0 Processando pagamento · 1 Aguardando envio · 2 Créditos insuficientes · 3 Enviado · 4 Cancelado · 5 Falha         |
| `delivered`                                    | 1 quando entregue                                                                                                   |
| `opened`                                       | 1 quando aberto                                                                                                     |
| `deferred`                                     | 1 quando o servidor do destinatário adiou a mensagem — o pedido é marcado como falha e os créditos são reembolsados |
| `date_sent` / `date_delivered` / `date_opened` | Timestamps em UTC                                                                                                   |