Email Trigger
Conheça o trigger e saiba como utilizá-lo.
Este trigger suporta apenas o protocolo IMAP, sem anexos.
O Email Trigger permite o recebimento dos dados de uma conta de e-mail no pipeline.
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âmetro | Descrição | Valor padrão | Tipo de dado |
---|---|---|---|
Account | Especifique a conta para que o trigger acesse o e-mail correto. | N/A | String |
Operation | Ação a ser executada pelo trigger. As opções são: Mark as Read, Move to Another Folder e Delete. Veja mais sobre as operações na seção abaixo. | Mark as Read | String |
Hostname | nome do host do servidor IMAP (por exemplo, imap.uol.com). | imap.gmail.com | String |
Port | Número da porta. | 993 | Inteiro |
Email Folder | Nome da pasta/caixa de entrada que o trigger deve ler (por exemplo, inbox). Nessa pasta não podem existir mais que 100 mensagens (lidas/não lidas). | inbox | String |
Destination Email Folder | Aponte para qual pasta a mensagem deve ser movida. Note que este campo aparece apenas quando é escolhida a opção Move to Another Folder em Operation. | N/A | String |
Maximum Timeout | tempo máximo (em milissegundos) para o pipeline processar informação antes de retornar uma resposta. Limite: 900000. | 30000 | Inteiro |
Allow Redelivery Of Messages | se ativada, a opção permite que as mensagens sejam entregues novamente caso o Pipeline Engine falhe. | False | Booleano |
Campo Operation
Mark as Read: selecione essa opção se, após processada, você deseja que a mensagem seja marcada como lida.
Move to Another Folder: selecione essa opção se, após processada, você deseja que a mensagem seja movida para uma pasta pré-determinada. O destino é especificado no campo Destination Email Folder, que só aparece nas configurações quando Move to Another Folder é selecionada.
Delete: selecione essa opção se, após processada, você deseja que a mensagem seja excluída.
Anexos
Caso haja algum anexo no corpo da mensagem recebida pelo trigger, ele vai baixá-las e disponibilizá-las dentro do diretório de execução do pipeline. Os nomes dos anexos estarão contidos dentro da propriedade attachments
e essa propriedade será um array de strings contendo os nomes dos anexos.
Caso haja 2 anexos com o mesmo nome na mensagem, um identificador único será adicionado no nome do anexo baixado.
Exemplo:
Há 2 anexos com nome "file.csv" dentro da mensagem. Portanto, o conteúdo da propriedade attachments
será:
O identificador varia a cada execução.
Nota: Se você utilizar o Gmail como host do servidor IMAP, será necessário autorizar o suporte de aplicações não seguras. Confira a documentação externa do Google para ver o passo-a-passo.
Exemplo de uso
Veja os parâmetros a serem configurados com o exemplo abaixo:
1. Abra as configurações de trigger e selecione o tipo email.
2. Preencha os campos de configuração de acordo com as suas especificações. Para este exemplo, selecione a opção Mark as Read em Operation.
3. Clique em Confirmar.
4. Continue a construção do pipeline.
5. Conecte os seus componentes.
6. Faça o deploy do pipeline:
Clique em Run, localizado na parte superior da tela.
Selecione o ambiente, que pode ser test ou prod.
Clique em Criar.
Selecione o pipeline com a sua versão e capacidade.
Clique em Implantar.
7. Quando for disparado, o pipeline receberá um payload similar ao seguinte:
data: conteúdo da mensagem.
subject: assunto da mensagem.
from: e-mail do remetente.
to: e-mail do destinatário.
cc: destinatários em cópia.
bcc: destinatários em cópia oculta.
replyTo: e-mail de destino da resposta.
sentDate: data de envio da mensagem.
receivedDate: data de recebimento da mensagem.
Atualizado