BISMail: mudanças entre as edições
Ir para navegação
Ir para pesquisar
Sem resumo de edição |
|||
| (3 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
| Linha 1: | Linha 1: | ||
BISMail é o serviço que o | BISMail é o serviço que o BIS10 oferece para gerenciar caixas de e-mail do sistema. Montado em cima dos métodos oferecidos pelo [[FWMail]], o BISMail centraliza as funcionalidades de e-mail do sistema peritindo que o sistema compartilhe as caixas de e-mails cadastradas no sistema. | ||
= Entidades = | |||
== MailBoxVO == | |||
Representa uma caixa (ou conta) de e-mail. Tem os atributos necessários para identificação e acesso do e-mail, como usuário, senha, servidor, etc | Representa uma caixa (ou conta) de e-mail. Tem os atributos necessários para identificação e acesso do e-mail, como usuário, senha, servidor, etc. | ||
== MailMessageVO == | |||
Entidade que representa uma mensagem de e-mail. Pode ser uma mensagem de e-mail recebida, um rascunho aguardando finalização, ou uma mensagem já enviada. | Entidade que representa uma mensagem de e-mail. Pode ser uma mensagem de e-mail recebida, um rascunho aguardando finalização, ou uma mensagem já enviada. | ||
* Mantém referência para a caixa de e-mail à qual esta mensagem foi recebida/enviada. | * Mantém referência para a caixa de e-mail à qual esta mensagem foi recebida/enviada. | ||
* Referencia quatro listas de MailAddress***VO para armazenar os destinatários, os "Cópia Carbono" e os "Cópia Carbono Oculta" e dos remetentes da mensagem. | * Referencia quatro listas de MailAddress***VO para armazenar os destinatários, os "Cópia Carbono" e os "Cópia Carbono Oculta" e dos remetentes da mensagem. | ||
* Referencia ainda uma instância de MailAddressVO para o endereço do remetente usado na ocasião do recebimento/envio. | |||
*: Embora pareça um absurdo o campo "from" pode conter uma lista de endereços pela API de e-mail do java. Como não pude encontrar se há mesmo a possibilidade de múltiplos "senders", acatei a API. | *: Embora pareça um absurdo o campo "from" pode conter uma lista de endereços pela API de e-mail do java. Como não pude encontrar se há mesmo a possibilidade de múltiplos "senders", acatei a API. | ||
* Referencia ainda o MailAttachmentVO que representa os anexos da mensagem. | * Referencia ainda o MailAttachmentVO que representa os anexos da mensagem. | ||
= Funcionalidades = | |||
Todos os métodos de acesso ao serviço estão disponibilizados através da fachada. Melhor e mais atualizada documentação no JavaDoc dos métodos. | |||
== Agendamento de Checagem de E-mails == | |||
A caixa de e-mail tem um parâmetro que permite configurar se os e-mails devem ou não serem "baixados" do servidor. Caso verdadeiro, o sistema fará a verificação de novas mensagens automaticamente. Para cada nova mensagem recebida o serviço disparará eventos através do serviço [[EventDispatcher]]. A relação de eventos pode ser encontrada em [[Eventos do BIS10]]. | |||
== Os métodos do CRUD == | |||
O CRUD apresenta tantos métodos com a finalidade de enviar um e-mail a partir de uma caixa de correio específica (como a conta de e-mail de um usuário específico), quando o método '''sendMailFromSystem()''' com a finalidade de enviar um e-mail com a conta padrão do sistema. | |||
A conta padrão do sistema deve ser utilizada para enviar e-mails automáticos do sistema, de notificação, relatórios agendados, etc. diretamente para seus usuários. As contas de e-mail particulares devem ser utilizadas quando um usuário deseja compartilhar algum relatório/informação com alguém. | |||
{{nota|Sistema de Notificações do BIS|Note que além do e-mail, o BIS tem o [[BISNotification]]. O [[BISNotification]] é o sistema de centralização de envio de notificações do sistema para "targets" específicos. Leia o material para entender como funciona o sistema, e se for o caso faça os disparos de e-mails através do [[BISNotification]] ao invés de enviar um e-mail diretamente.}} | |||
Edição atual tal como às 16h59min de 28 de outubro de 2020
BISMail é o serviço que o BIS10 oferece para gerenciar caixas de e-mail do sistema. Montado em cima dos métodos oferecidos pelo FWMail, o BISMail centraliza as funcionalidades de e-mail do sistema peritindo que o sistema compartilhe as caixas de e-mails cadastradas no sistema.
Entidades
MailBoxVO
Representa uma caixa (ou conta) de e-mail. Tem os atributos necessários para identificação e acesso do e-mail, como usuário, senha, servidor, etc.
MailMessageVO
Entidade que representa uma mensagem de e-mail. Pode ser uma mensagem de e-mail recebida, um rascunho aguardando finalização, ou uma mensagem já enviada.
- Mantém referência para a caixa de e-mail à qual esta mensagem foi recebida/enviada.
- Referencia quatro listas de MailAddress***VO para armazenar os destinatários, os "Cópia Carbono" e os "Cópia Carbono Oculta" e dos remetentes da mensagem.
- Referencia ainda uma instância de MailAddressVO para o endereço do remetente usado na ocasião do recebimento/envio.
- Embora pareça um absurdo o campo "from" pode conter uma lista de endereços pela API de e-mail do java. Como não pude encontrar se há mesmo a possibilidade de múltiplos "senders", acatei a API.
- Referencia ainda o MailAttachmentVO que representa os anexos da mensagem.
Funcionalidades
Todos os métodos de acesso ao serviço estão disponibilizados através da fachada. Melhor e mais atualizada documentação no JavaDoc dos métodos.
Agendamento de Checagem de E-mails
A caixa de e-mail tem um parâmetro que permite configurar se os e-mails devem ou não serem "baixados" do servidor. Caso verdadeiro, o sistema fará a verificação de novas mensagens automaticamente. Para cada nova mensagem recebida o serviço disparará eventos através do serviço EventDispatcher. A relação de eventos pode ser encontrada em Eventos do BIS10.
Os métodos do CRUD
O CRUD apresenta tantos métodos com a finalidade de enviar um e-mail a partir de uma caixa de correio específica (como a conta de e-mail de um usuário específico), quando o método sendMailFromSystem() com a finalidade de enviar um e-mail com a conta padrão do sistema.
A conta padrão do sistema deve ser utilizada para enviar e-mails automáticos do sistema, de notificação, relatórios agendados, etc. diretamente para seus usuários. As contas de e-mail particulares devem ser utilizadas quando um usuário deseja compartilhar algum relatório/informação com alguém.
|
|