Configuração OAuth da Google para o envio de e-mails

Para configurar o Google OAuth, é necessário ter uma conta no Google Cloud Console.

Após criar a conta no Google Cloud Console, siga o passo a passo abaixo para gerar as chaves de acesso, que serão posteriormente vinculadas ao Mentor Web.

1º passo: após a criação da conta no google console, acessar o link https://console.cloud.google.com/ e clicar em: APIs e serviços:

2º passo: será necessário acessar a tela de permissão Oauth para posteriormente criar as credenciais da aplicação. Para acessar a tela de permissão, deverá clicar em “Tela de permissão Oauth”:

3º passo: ao acessar a tela de permissão OAuth, selecionar o user type “Externo” e clicar em criar. Quando o google redirecionar para a próxima tela precisamos preencher alguns campos conforme abaixo:

• Nome do app: inserir um nome para identificar o registro.
• E-mail para suporte do usuário: inserir a conta em que você está logado no google console.
• Dados do contato do desenvolvedor: inserir um e-mail para contato.

4º passo: após preencher os campos da aba na tela de permissão OAuht, a próxima aba será a de escopos e nessa aba não é necessário preencher nenhum campo.

5º passo: a penúltima aba que é apresentada no google console, é a de usuários de teste. Será necessário inserir um e-mail que será utilizado para logar na autenticação do mensageria. Dica: utilizar o próprio e-mail em que está logado no google console.

6º passo: após salvar e continuar estamos aptos a criar a credencial que utilizaremos na configuração do mensageria. Para isso, basta clicar em: Credenciais.

7º passo: Ao clicar em Credenciais, a tela abaixo será exibida. Para prosseguir com a criação das credenciais, clique no botão Criar credenciais no topo da tela e selecione a opção ID do cliente OAuth.

8º passo: após clicar em “ID do cliente OAuth” será aberta a tela de preenchimento da criação do ID que deverá ser preenchida conforme abaixo:

• Tipo de aplicativo: deverá ser selecionado obrigatoriamente o tipo “aplicativo da web”.
• Nome: inserir um nome de fácil identificação para o ID.
• URIs de rediecionamento autorizado: deverá ser clicado em “adicionar URI” e a URI que deverá ser inserida é a que consta no Mentor Web > comum > mensageria > URIs de redirecionamento autorizados. O sistema sempre irá apresentar esse link automaticamente quando for selecionado o tipo de autenticação OAuth.
  

9º passo: após clicar em Criar, o Google Cloud Console gerará o ID do cliente e a chave secreta do cliente que serão utilizados na configuração do Mentor Web. Para acessar esses dados, clique no nome da credencial criada no passo anterior. Com o ID e a chave secreta copiados, você poderá prosseguir com a configuração da mensageria diretamente no Mentor Web.

Para mais detalhes, continue a leitura na seção “Configurações na mensageria” deste documento.

Agora que já possuímos o ID e a chave secreta do cliente, podemos continuar com a configuração no mensageria.

Após selecionar o tipo de autenticação OAuth:

• URIs de redirecionamento autorizados: o sistema sempre trará esse campo preenchido por padrão e sem possibilidade de editar. Essa URL é inserida na configuração do google console.
• ID do cliente: esse campo deverá ser inserido do campo “ID do cliente” dentro do google console. Para verificar onde pegar esse campo, acesse as configurações no google console acima.
• Chave secreta do cliente: esse campo deverá ser inserido do campo “Chave secreta do cliente” dentro do google console. Para verificar onde pegar esse campo, acesse as configurações no google console acima.

• Permitir a pessoa visualizar o remetente ao responder o e-mail?: quando marcado, habilitará no e-mail o campo “Responder para”, possibilitando que o e-mail seja respondido para o remetente configurado. O padrão para os clientes deverá ser marcado, que é como o processo ocorria anteriormente. Clientes que desejarem não utilizar esta função, deverão desmarcar o parâmetro.
• Número de tentativas: deve-se informar o número de tentativas para o envio de e-mail. O serviço respeitará esse valor para tentar enviar a mensagem.
• Número de mensagens por lote: por padrão, esse campo será apresentado com valor 95 (noventa e cinco), mas pode-se alterar o valor, porém, o número máximo permitido é 100 (cem), mas orienta-se validar qual o limite máximo de envio de mensagens que seu provedor de e-mail disponibiliza.
• Utiliza e-mail da conta como remetente: quando marcado, utilizará o e-mail cadastrado no campo “E-mail do remetente” para envio das mensagens. Ao marcar este parâmetro, habilitará o parâmetro “Permitir a pessoa visualizar o remetente ao responder o e-mail?”.
• Quantidade de envio por minuto, hora, dia e mês: pode-se informar a quantidade de envio de e-mails por minuto, hora, dia ou mês.
• Nível de log: nível de Log se refere ao quão detalhada a mensagem gerada é. Os Níveis de Log referem-se ao tipo de severidade escrita no Arquivo de Log. Quando utilizado o nível DEBUG, por exemplo, coletará muitas informações. Desta forma, será mais fácil encontrar e corrigir um possível erro. Esta opção é indicada para o processo de configuração do Mensageria, pois caso ocorra algum erro, será possível corrigir antes de liberar o processo para funcionamento em produção. Em contrapartida, se utilizar esta opção em produção (após a validação das configurações do mensageria), poderá sobre carregar o sistema. O ideal a ser utilizado em produção é o nível ERROR, pois todos os erros que ocorrerem no processo serão registrados, e as informações coletadas com este nível de Log já serão suficientes para a correção/solução do erro. Os níveis de log são: “FATAL”, “ERROR”, “WARN”, “INFO” e “DEBUG”.

A título de curiosidade, segue abaixo os limites de envio por parte de alguns servidores de e-mail:

Ao realizar as configurações de envio de e-mail, é possível preencher algumas informações automaticamente a partir do botão “Carregar modelo padrão”, localizado ao final da tela:

Ao selecionar um provedor de e-mail, os campos abaixo serão preenchidos automaticamente:

Então, pode-se realizar as alterações conforme necessidade e completar as configurações.

Ainda nas configurações do Mensageria, é possível definir uma ordem de envio dos e-mails. No caso, quando a instituição enviar um e-mail, o sistema respeitará a ordem configurada na tela abaixo:

No exemplo acima, ao enviar um e-mail, o sistema seguirá a seguinte ordem de envio:

• Primeiramente, buscará o e-mail institucional do destinatário para enviar o e-mail.
  
• Caso o destinatário não possua e-mail institucional, o sistema buscará o próximo da ordem, no caso, o e-mail pessoal do destinatário.
  
• Caso o destinatário não possua e-mail pessoal, o sistema buscará o próximo da ordem, no caso, o e-mail alternativo do destinatário.
  

Para alterar a ordem de envio, basta clicar sobre o número da ordem e arrastar para a posição desejada, conforme apresentado no GIF abaixo:

Após definir a nova ordem, deve-se clicar no botão Gravar para que as ordens sejam redefinidas.

Envia cópia: ao marcar este parâmetro, além de enviar o e-mail ao destinatário de prioridade superior, enviará uma cópia para os próximos destinatários marcados com este parâmetro. Veja um exemplo:

Exemplo: No exemplo abaixo, além de enviar e-mail para o e-mail institucional do destinatário (que é o primeiro da ordem), enviará uma cópia para o e-mail pessoal, e também, para o alternativo.



Se apenas o e-mail alternativo estiver marcado para enviar cópia, ao enviar o e-mail para o e-mail institucional, enviará uma cópia apenas para o e-mail alternativo.

Observação: O destinatário somente receberá o e-mail se o campo de e-mail em seu cadastro estiver devidamente preenchido.

Ao final da tela de configurações do Mensageria, é possível configurar um rodapé para os e-mails a serem enviados:

Após definir o rodapé, deve-se clicar em Gravar, e então, o rodapé será apresentado nos e-mails conforme configurado:

Após concluir as configurações, orienta-se realizar o envio de uma mensagem de teste, a fim de certificar-se que as configurações estão corretas.

Para enviar o e-mail de teste, deve-se clicar no botão flutuante (localizado ao final da tela), e selecionar a opção “Mensagem de teste”, e posteriormente informar o destinatário. Recomenda-se utilizar uma conta de destinatário na qual a instituição possua acesso, para confirmar o recebimento do e-mail.



Neste envio de e-mail, será validado se:

• As configurações informadas estão corretas;
• O serviço de Mensageria está respeitando as configurações;
• Está realizando a conexão entre Mentor e Servidor de e-mail corretamente.

Após essas validações, se o e-mail teste foi recebido, poderá iniciar os envios das mensagens de e-mail. Caso ocorra algum erro em tela, ou não receba o e-mail, deverá revisar as configurações informadas.

Ao confirmar o devido funcionamento das configurações de e-mail e execução do serviço de Mensageria, é necessário colocar o serviço em modo de produção para que inicie o envio de mensagens do sistema. Para isso, deve-se:

• Acessar o aquivo “\edusoft\servicos\mensageria\context.xml”;
  
• Editar o item “iniciaEmModoTeste”, alterando de “true” para “false”;
  
• Reiniciar o serviço do Mentor Mensageria.
  

1. No Windows: Execute o “C:\edusoft\servicos\mensageria\Parar serviço.bat” e depois “C:\edusoft\servicos\mensageria\Iniciar serviço.bat”
   
2. No Linux: Execute o comando “/ etc / init .d / EdusoftServicoMensageria stop” e depois “/ etc / init .d / EdusoftServicoMensageria start”.
   

Durante as configurações do Mensageria, ou até mesmo, durante a execução do serviço, algumas situações/erros podem ocorrer. Abaixo, seguem algumas situações que já ocorreram durante as configurações e que foram solucionadas com as orientações indicadas:

1) Erro original: javax.mail.MessagingException: Could not convert socket to TLS;nested exception is: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target.

- Deve-se retirar o escaneamento SSL ou retirar o escaneamento de envio de e-mail SMTP do antivírus.

2) Deve-se verificar a quantidade de e-mail que o provedor possibilita enviar por dia. Caso a quantidade enviada for igual à máxima permitida pelo seu provedor, os e-mails ficarão numa fila aguardando 24 horas para reenviar. Obs.: Caso a cota seja excedida, será notificado via e-mail sobre esta informação. Também poderá acompanhar pelo log da mensageria em Log Serviço.

3) Deve-se verificar o tamanho máximo de anexo que o provedor permite enviar. Caso um e-mail tenha um anexo maior que o permitido pelo seu provedor, o mesmo será barrado e consequentemente, não será enviado.

4) Quando não enviado e-mails pelo Gmail, deve-se verificar se foi ativado o envio de e-mail através de aplicativos menos seguros:
https://support.google.com/mail/answer/13287?hl=en
https://www.google.com/settings/security/lesssecureapps
https://myaccount.google.com/security?utm_source=OGB&pli=1#connectedapps → Permitir aplicativos menos seguros

5) Caso não esteja realizando o envio de e-mails, pode-se alterar as configurações de envio para modo DEBUG. Com esse modo ativado, será possível obter informações mais detalhadas, que poderão facilitar na identificação do problema. PORÉM, este modo deverá ser alterado para WARN, depois que o serviço estiver funcionando.

6) Caso no Gmail, mesmo realizando e validando todos os itens citados acima, porém ainda não está enviando os e-mails, recomenda-se seguir os seguintes passos:

• Primeiro passo: Verificar na caixa de entrada, do e-mail configurado, se não foi recebido nenhum e-mail ou notificação do Google com os temas “Alguém tem sua senha” ou “Tentativa de login bloqueada”. Caso exista, deverá aparecer um link com a label “REVISAR SEUS DISPOSITIVOS AGORA” ou algo semelhante, onde deverá clicar neste link e liberar o acesso para todos os dispositivos.
• Segundo passo: Ainda logado no Gmail e no mesmo navegador, acessar o link https://accounts.google.com/DisplayUnlockCaptcha, clicar em continuar, ou se solicitar novamente login, insira os dados de acesso a conta do Gmail.
• Terceiro passo: Tentar novamente enviar um e-mail de testes.

Para acessar a documentação técnica e os passos de Instalação e Configuração do Mentor Mensageria, clique aqui