GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

De CIGAM WIKI

Voltar

Como Fazer > Utilidades/Diversos > Configuração de Envio de E-mail no CIGAM


Configuração de envio e email pelo Sistema CIGAM

[editar]

O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento.

Quais são as informações de envio de e-mail para parametrização?

[editar]

As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são:
⦁ Qual é o servidor de e-mail e respectiva porta?
⦁ Qual é a conta de e-mail do usuário?
⦁ Qual é a senha de e-mail do usuário?
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)?

Quais as parametrizações de envio de e-mail?

[editar]

O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “Como Fazer - Instalação do .Net”.

Voltar ao início

Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM?

[editar]

Qual é o cadastro a ser feito?

[editar]

Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele.
[Versão 221107.c 1] Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração GE - AM - 903 - Usuário para login no servidor de e-mail não constar informada.
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração GE - AM - 903 - Usuário para login no servidor de e-mail.

O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos

  • Utilidades / Diversos
    • Parâmetros
      • Usuários
        • Usuário - Grupos Direitos

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário.

Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.

Voltar ao início

Como configurar para utilização de envio através da opção SmtpClient?

[editar]

SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais).

Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:

  • IMPORTANTE: A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app.
  • Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração GE - AM - 904 - Senha para login no servidor de e-mail ou individualmente a cada envio que esse ocorrerá normalmente.
    • Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por senhas de APP ou gerenciamento de senhas de APP, ou siga as informações abaixo.

Voltar ao início

Como criar uma senha de aplicativo

[editar]

Senha de aplicativo Gmail

[editar]

Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google.

Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração GE - AM - 338 - Opção para envio de e-mail, acesse Criar e usar senhas de app e siga os passos.

Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.


Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu Utilidades/Diversos > Genéricos > Parâmetros > Configurações para informar na configuração GE - AM - 904 - Senha para login no servidor de e-mail a senha gerada.

Senha de aplicativo Outlook

[editar]

Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo:
Acesso direto conta Pessoal
Acesso diretor conta Profissional - Administrado por Exchange


Inserir uma validação com: E-mail ou Telefone:


Ativar a verificação em duas etapas:


Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração GE - AM - 904 - Senha para login no servidor de e-mail.


Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do Exchange do Office365.


Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.

Voltar ao início

Validação Kinghost

[editar]

O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM.

Como ativar SMTPI Kinghost

Como configurar para utilização de envio através da opção Gmail API?

[editar]

Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares).

O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0.
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - [Configurando o OAuth 2.0].

  • Importante: Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.

Voltar ao início

Como configurar para utilização de envio através da opção OAuth?

[editar]

A partir da [Versão 241007 1], a configuração GE - AM - 338 - Opção para envio de e-mail agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.

OAuth refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization).

OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada.

Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.

Envio de e-mail via Office 365

[editar]
O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - Como configurar autenticação Office 365 OAuth 2.0. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

As configurações do sistema CIGAM envolvidas são:

Cadastro de parâmetros OAuth
001.1 - Office 365 OAuth 2.0
Importante: A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

Envio de e-mail com OAuth utilizando o SendGrid

[editar]
O SendGrid é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.
  Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos para a versão CIGAM11 EnvioEmailCustomizado.zip.
Clique para baixar o pacote de arquivos para a versão CIGAM e10 EnvioEmailCustomizadoUniPaaS.zip.
Observação: para ambientes com a versão CIGAM e10, após realizar o download do arquivo compactado, certifique-se de deixar a pasta com o nome EnvioEmailCustomizado.
As parametrizações do sistema CIGAM envolvidas são:
Cadastros e configurações.
O cadastro do usuário deve estar com o endereço de e-mail devidamente preenchido. Este será utilizado como remetente dos e-mails enviados.
A configuração 'GE - AM - 2169 - E-mail do remetente variando por unidade de negócio', permite variar o e-mail do remetente conforme a Unidade de Negócio ativa. Quando informada, terá prioridade sobre o e-mail no cadastrado do usuário.
No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
EX_CK02176TSI = S
EX_CK02176TSICabPrg = EE00003
EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
EX_SENDGRID_APIKEY =
EX_EMAIL_CUSTOMIZADO = S
  IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja como integrar o SendGrid.

Voltar ao início

Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres?

[editar]

A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação.

  1. Autenticação pelo SMTP Relay: Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
  2. Implementação: A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
  3. Considerações de Segurança: Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

Envio de e-mail usuários externos

[editar]

[Versão 220404.c 1] Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários.

  • Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações:

Sendo assim onde existir a implementação da funcionalidade, caso a configuração: GE - AM - 904 - Senha para login no servidor de e-mail não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.

Voltar ao início

Manuais Referenciados

[editar]

Versão 220404

[editar]

Patch "c"

[editar]
  1. Liberado a partir da OS 373456/391.

Versão 221107

[editar]

Patch "c"

[editar]
  1. 1,0 1,1 1,2 1,3 1,4 1,5 1,6 Liberado a partir da OS 780634/2.

Versão 241007

[editar]
  1. Liberado a partir da OS 373456/716.