Skip to content

Agendar Emails

O agendamento de emails permite notificar clientes quando um documento é liberado.

Atores Autorizados

Os seguintes tipos de usuários podem agendar emails:

  • RAD Físico
  • RAD Admin

Condição Prévia

O documento deve estar com status "Liberado" antes de agendar email.

Processo de Agendamento

1. Localizar Documento Liberado

  • Acesse a lista de documentos
  • Filtre por status "Liberado" se necessário
  • Localize o documento que deseja notificar

2. Agendar Email

  • Clique no botão "Agendar Email" ou "Notificar"
  • Confirme o agendamento
  • Sistema agenda o envio

O Que Acontece Quando Email é Agendado

  1. Marcação: Documento é marcado com scheduledEmail: true
  2. Processamento: Sistema processa o agendamento
  3. Envio: Email é enviado para clientes da instalação
  4. Registro: sendedEmail é marcado como true após envio

Conteúdo do Email

O email enviado contém:

  • Informações do documento
  • Link para visualizar o documento
  • Informações da instalação
  • Data de validade (se aplicável)

Destinatários

O email é enviado para:

  • Clientes associados à instalação do documento
  • Clientes do tipo "cliente" e "cliente MN"
  • Apenas clientes ativos

Endpoint da API

Método: POST

URL: /document/scheduleEmail/

Body:

json
{
  "_id": "documentId"
}

Processamento Automático

O sistema possui um job agendado (DocumentLiberationNotificationJob) que:

  • Processa documentos liberados com scheduledEmail: true
  • Envia emails para clientes
  • Marca sendedEmail: true após envio bem-sucedido

Status Após Agendamento

Após agendar email:

  • scheduledEmail é marcado como true
  • Email é processado e enviado
  • Clientes recebem notificação
  • sendedEmail é marcado após envio

Verificação de Envio

Você pode verificar se o email foi enviado:

  • Campo sendedEmail indica se foi enviado
  • Logs do sistema podem mostrar detalhes
  • Clientes confirmam recebimento

Considerações Importantes

Timing

  • Email pode ser agendado imediatamente após liberação
  • Ou pode ser agendado posteriormente
  • Sistema processa conforme configuração

Múltiplos Agendamentos

  • Email pode ser agendado apenas uma vez
  • Verifique scheduledEmail antes de agendar novamente

Falhas no Envio

  • Se o envio falhar, sendedEmail permanece false
  • Sistema pode tentar novamente em próxima execução do job
  • Logs registram falhas para investigação

Próximos Passos

Documentação da Plataforma Trevo Radimenstein