Email

Permite a configuração de e-mail para receber um link do Azure Blob Storage com os arquivos gerados a partir das mensagens trafegadas.

As mensagens trafegadas são agrupadas em arquivos para serem enviados periodicamente para o destino. Caso você precise de enviar de forma transacional as mensagens (uma a uma) para destinos utilizando templates de e-mails, utilize o output Email Transacional

Parâmetros

Parâmetros aceitos para esse tipo de sindicância de destino:

Campo	Descrição	Valor
email.to	E-mails dos destinatários	Tipo: []string Obrigatório
email.cc	E-mails em cópia	Tipo: []string Valor padrão: -
email.bcc	E-mails em cópia oculta	Tipo: []string Valor padrão: -
email.subject	Assunto do e-mail	Tipo: string Obrigatório
email.file	Dados do arquivo a ser gerado	Tipo: object Valor padrão: {}
email.file.path	Caminho do arquivo gerado	Tipo: string Valor padrão: -
email.file.extension	Extensão do arquivo gerado	Tipo: enum[csv json] Valor padrão: cs
email.file.separator	Separador do arquivo gerado - caso necessário	Tipo: string Valor padrão: ;
email.file.max_size_mb	Tamanho máximo em MB do arquivo gerado	Tipo: int[1-100] Valor padrão: 10
email.file.period	Períodos de geração/envio dos arquivos para o email	Tipo: enum[1m 1h 2h 3h 4h 6h 8h 12h 1d] Valor padrão: 1d
email.file.schema	Esquema de campos do arquivo resultante. A ordem dos campos é respeitada.	Tipo: list Valor padrão: {}
email.file.schema.name	Nome do campo	Tipo: string Obrigatório

Requisição

curl --location '<HOST>/v1/configs' \
--header 'Content-Type: application/json' \
--header 'Authorization: <ACCESS-TOKEN>' \
--data '{
    "output": {
        "type": "EMAIL",
        "email": {
          "to": [
            "[email protected]"
          ],
          "cc": [
            "[email protected]"
          ],
          "bcc": [
            "[email protected]"
          ],
          "subject": "SUBJECT",
          "file": {
            "path": "folder/file.csv",
            "extension": "csv",
            "separator": ";",
            "max_size_mb": 100,
            "period": "1h"
          }
        }
    }
}'

Resposta

A resposta desse endpoint será no seguinte formato:

{
  "id": "FIREHOSE-ID",
  "output": {
    "type": "EMAIL",
    "email": {
      "to": [
        "*"
      ],
      "cc": [
        "*"
      ],
      "bcc": [
        "*"
      ],
      "subject": "SUBJECT",
      "file": {
        "path": "folder/file.csv",
        "extension": "csv",
        "separator": ";",
        "max_size_mb": 100,
        "period": "1h"
      }
    }
  }
}