Email Trigger V2

Saiba mais sobre o Email Trigger V2 e como usá-lo na Digibee Integration Platform.

O Email Trigger V2 recupera dados de uma caixa de email e os envia para o pipeline.

Este trigger oferece suporte apenas ao protocolo IMAP.

Parâmetros

Dê uma olhada nos parâmetros de configuração do trigger. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetros de configuração

Parâmetro	Descrição	Valor padrão	Tipo de dado
Account	Define o tipo de conta utilizado pelo trigger. Tipos suportados: Basic, OAuth 2 e Azure Key.	N/A	String
E-mail	Endereço de email a ser acessado. Se o tipo de conta for OAuth 2, somente endereços de email hospedados no Google são suportados. Para endereços de email da Microsoft, utilize o tipo de conta Azure Key.	N/A	String
Operation	Especifica a ação a ser executada pelo trigger. Opções: Mark as Read, Move to Another Folder e Delete. Veja detalhes na seção Operações.	Mark as Read	String
Hostname	Hostname do servidor IMAP (por exemplo, imap.uol.com).	imap.gmail.com	String
Port	Número da porta para conexão IMAP.	993	Integer
Email Folder	Nome da pasta/caixa de entrada que o trigger irá ler (por exemplo, inbox). Essa pasta não deve conter mais de 100 mensagens (lidas ou não lidas).	inbox	String
Destination Email Folder	Define para qual pasta as mensagens devem ser movidas. Este campo é exibido apenas quando a opção Move to Another Folder está selecionada no parâmetro Operation.	N/A	String
Maximum Timeout	Tempo máximo de processamento (em milissegundos) antes de o pipeline retornar uma resposta. Limite: 900000.	30000	Integer
Allow Redelivery Of Messages	Quando habilitado, permite que as mensagens sejam entregues novamente caso o Pipeline Engine falhe.	False	Booleano
Documentation	Seção para documentar informações necessárias sobre a configuração do conector e regras de negócio.	N/A	String

Operações

• Mark as Read: Marca a mensagem como lida após o processamento.

• Move to Another Folder: Move a mensagem processada para uma pasta específica. O campo Destination Email Folder é obrigatório nesse caso.

• Delete: Exclui a mensagem após o processamento.

Anexos

Se o email recebido contiver anexos, eles serão baixados e armazenados no diretório de execução do pipeline. Os nomes dos arquivos estarão listados na propriedade attachments, como um array de strings.

Se houver dois anexos com o mesmo nome, um identificador único será adicionado para diferenciá-los.

Exemplo: Se um email contiver dois anexos chamados file.csv, a propriedade attachments será:

{
  "attachments": ["file.csv", "0072e485-8ba2-4f79-bba5-8068e37ee792_file.csv"]
}

O identificador é gerado a cada execução.

Se estiver utilizando o Gmail como servidor IMAP, será necessário autorizar o acesso de aplicativos menos seguros. Consulte a documentação externa do Google para mais detalhes.

Exemplo de uso

Siga as etapas abaixo para configurar e utilizar o trigger:

1. Abra as configurações do trigger e selecione o tipo email-v2.

2. Preencha os campos de configuração conforme necessário. Neste exemplo, selecione a opção Mark as Read em Operation.

3. Clique em Confirmar.

4. Continue construindo o pipeline.

5. Implante do pipeline. Aprenda o passo a passo.

Quando acionado, o pipeline receberá um payload semelhante a este:

{
  "textMessage": "",
  "htmlMessage": "Hello, Peter\r\nI still haven’t received the report for this month. Could you send it by the end of the day?",
  "attachments": [
    "attachment_fileName1",
    "attachment_fileName2",
    "attachment_fileName3"
  ],
  "subject": "Monthly report",
  "from": [
    "Renato Peixe Junior <[email protected]>"
  ],
  "to": [
    "[email protected]"
  ],
  "cc": [],
  "bcc": [],
  "replyTo": [
    "Renato Peixe Junior <[email protected]>"
  ],
  "sentDate": "2020-02-10T17:54:40Z[UTC]",
  "receivedDate": "2020-02-10T17:54:52Z[UTC]"
}

Campos do payload

• textMessage: Conteúdo em texto simples do email.

• htmlMessage: Conteúdo do email em formato HTML.

• attachments: Lista com os nomes dos arquivos anexos.

• subject: Assunto do email. from: Email do remetente.

• to: Emails dos destinatários.

• cc: Emails em cópia. bcc: Emails em cópia oculta.

• replyTo: Email para o qual a resposta deve ser enviada.

• sentDate: Data e hora em que o email foi enviado.

• receivedDate: Data e hora em que o email foi recebido.