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

# Canal E-mail

> Envie um AR-Email com comprovação de entrega e leitura, anexos e validação de segurança.

O AR-Email é o canal de e-mail da AR Online, com comprovação de entrega e leitura. O endpoint de envio se chama `POST /gw/email`; o campo `to` (destinatário do e-mail) é exigido **apenas** no envio somente e-mail. Veja a [visão geral do envio](/enviando/visao-geral).

## Campos

<ParamField path="nameTo" type="string" required>
  Nome do destinatário.
</ParamField>

<ParamField path="to" type="string">
  E-mail do destinatário. **Obrigatório apenas quando o envio é somente e-mail.**
</ParamField>

<ParamField path="subject" type="string" required>
  Assunto da mensagem.
</ParamField>

<ParamField path="content" type="string" required>
  Conteúdo da mensagem em **HTML**.
</ParamField>

<ParamField path="attachments" type="array">
  Lista de anexos. Cada item tem `name` (nome do arquivo) e `base64` (conteúdo em base64). Opcional.
</ParamField>

<ParamField path="validation" type="object">
  Protege o acesso ao link público do AR-Portal com pergunta e resposta de segurança.

  <ParamField path="validation.question" type="string">
    Pergunta de segurança exibida na página do AR-Portal.
  </ParamField>

  <ParamField path="validation.reply" type="string">
    Resposta de segurança solicitada ao destinatário.
  </ParamField>
</ParamField>

<Warning>
  O recurso `validation` é opcional e exige **habilitação prévia** da conta. Sem a ativação, uma requisição que contenha `validation` retorna erro **400**. Solicite a ativação ao suporte ([suporte@ar-online.com.br](mailto:suporte@ar-online.com.br)). Quando habilitada, a validação é aplicada a todos os canais de envio (Email, SMS e WhatsApp).
</Warning>

## Exemplo completo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.ar-online.com.br/gw/email" \
    -H "Authorization: SEU_TOKEN_AQUI" \
    -H "Content-Type: application/json" \
    -d '{
      "nameTo": "João da Silva",
      "to": "joao@exemplo.com",
      "subject": "Documento Importante",
      "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
      "attachments": [
        {
          "name": "documento.pdf",
          "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
        }
      ]
    }'
  ```

  ```json Body theme={null}
  {
    "nameTo": "João da Silva",
    "to": "joao@exemplo.com",
    "subject": "Documento Importante",
    "content": "<p><strong>Você recebeu um documento importante.</strong></p>",
    "attachments": [
      {
        "name": "documento.pdf",
        "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAABCAQAAABN/Pf1AAAADUlEQVR42mNk+M+AAQATFwEB/YopsAAAAABJRU5ErkJggg=="
      }
    ]
  }
  ```
</CodeGroup>

A resposta traz o `idEmail` do envio:

```json theme={null}
{
  "idEmail": "8c4813f5-8430-4ad4-ab72-19d7eed39731"
}
```

## Acompanhando o status

Use o `idEmail` para acompanhar a entrega e a leitura. Veja [Consultar status](/acompanhando/consultar-status).