01. DADOS GERAIS

Produto:

TOTVS Saúde Planos

Solucoes_totvs

Solucao

Solucoes_totvs_cross

SolucaoCross

Solucoes_totvs_parceiros

SolucaoParceiros

Solucoes_totvs_parceirosexptotvs

SolucaoParcsExpsTOTVS

Linha de Produto:

Linha Protheus

Linhas_totvs

Segmento:

Saúde

Segmentos_totvs

Segmento

Módulo:

GESTÃO DE CONTRATOS / FAMÍLIAS

Função:

GERENCIADOR DE CONTAS DE E-MAIL

Issue :

DSAUBE-26611

02. SITUAÇÃO/REQUISITO

Foi necessário criar uma rotina automatizada para o envio de e-mails, com o objetivo de tornar a comunicação mais eficiente e padronizar as mensagens geradas pelo sistema.

Durante esse processo, identificou-se a importância de permitir a configuração de eventos para disparo automático, garantindo que as notificações sejam enviadas de forma precisa e no momento adequado.

03. SOLUÇÃO

Gerenciador de Contas de E-mail

O gerenciador de contas de e-mail foi desenvolvido para otimizar e automatizar o envio de e-mails de forma rápida, segura e personalizada.

Introdução

Com uma interface intuitiva, o gerenciador de contas de e-mail permite a personalização de mensagens com campos dinâmicos. Além disso, pode ser utilizado em customizações das mais simples as mais complexas.

O gerenciador de contas de e-mail também prioriza a segurança, utilizando protocolos de envio confiáveis (como SMTP com autenticação TLS).

Funcionalidades

Entre as principais funcionalidades do gerenciado de e-mails, destacam-se:

Layouts em HTML e CSS

- Criação de layouts específicos em HTML e CSS para cada configuração.

Configuração de Remetentes

- Permite configurar diferentes remetentes para rotinas diferentes ou para uma mesma rotina.

Personalização do Corpo do E-mail

- Personalize o corpo do e-mail de acordo com diferentes rotinas, utilizando a mesma conta de e-mail ou contas distintas, conforme a necessidade sem precisar alterar código-fonte.

Como Acessar a Rotina

Para acessar o gerenciador de contas de e-mail, digite no campo que está na parte superior do lado esquerdo a seguinte informação: PLMNG001.
Voce também pode acessar a rotina navegando pelo menu:Miscelanea > Configurações > Gerenciador de Contas de E-mail.

Tela de configuração de e-mail:

Título Conf. - Título de identificação do objetivo da configuração.
Usu. Conta / Senha - Dados do e-mail remetente que irá enviar o e-mail.
Autentica? - Define se a conta utiliza fator de autenticação. Ao selecionar a opção 1 - Sim, é obrigatório preencher os campos Usuário Aut. e Senha Aut. Caso contrário, o preenchimento desses campos não é necessário.
Usuario Aut. / Senha Aut. - Usuário de e-mail com dados de autenticação e token de autenticação para liberar o envio de e-mail.

...

Remetente - Endereço do remetente que será utilizado para o envido envio do e-mail.
SMTP - SMTP do E-mail que está sendo configurado como rementente remetente (no exemplo estamos utilizando Gmail).
Porta - Porta do SMTP.
Utiliza TLS? / Utiliza SSL? - A configuração pode variar de acordo com o provedor de serviços de e-mail utilizado, consulte o provedor de e-mail utilizado para verificar.

...

Assun. E-mail - Assunto que irá aparecer no E-mail que será enviado.
Corpo E-mail - Dados do HTML e CSS para personalizar o corpo do e-mail que será enviado. Exmplo Exemplo disponível no tópico Exemplo de Código HTML Para o Corpo do E-mail.

Exemplo de Código HTML Para o Corpo do E-mail

Bloco de código

language	xml
theme	RDark
title	Exemplo
linenumbers	true

<!DOCTYPE html>
<html lang="pt-BR">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <style>
      body {
        font-family: Arial, sans-serif;
        margin: 0;
        padding: 0;
        background-color: #f4f4f4;
      }
      .container {
        max-width: 600px;
        margin: 40px auto;
        padding: 20px;
        border-radius: 8px;
        background-color: #ffffff;
        box-shadow: 0 4px 8px rgba(0, 0, 0, 0.05);
      }
      .header,
      .footer {
        background-color: #6c9ebd;
        color: #ffffff;
        text-align: center;
        padding: 10px;
        border-radius: 8px 8px 0 0;
      }
      .footer {
        border-radius: 0 0 8px 8px;
        margin-top: 20px;
        font-size: 14px;
      }
      h2 {
        text-align: center;
        color: #333;
      }
      .info {
        padding: 10px 0;
        font-size: 16px;
        color: #555;
      }
      .info strong {
        color: #222;
      }
      table {
        width: 100%;
        border-collapse: collapse;
        margin-top: 20px;
      }
      th,
      td {
        border: 1px solid #ddd;
        padding: 12px;
        text-align: left;
      }
      th {
        background-color: #6c9ebd;
        color: #ffffff;
      }
      tr:nth-child(even) {
        background-color: #f9f9f9;
      }
      .company-name {
        font-size: 20px;
        color: #333;
        text-align: center;
        margin-bottom: 20px;
        font-weight: bold;
      }
    </style>
  </head>
  <body>
    <div class="container">
      <div class="header">
        <h2>Usuario Bloqueado</h2>
      </div>

      <p class="info">
        <strong>Prezado(a):</strong> ##1, portador da matrícula
        <strong>##2</strong>
      </p>

      <p class="info">Esperamos que esta mensagem o(a) encontre bem.</p>
      <p class="info">
        Verificamos em nosso sistema que seu plano de saúde foi bloqueado devido
        à inadimplência. Conforme a Resolução Normativa nº 593 da ANS (Agência
        Nacional de Saúde Suplementar), o contrato pode ser suspenso ou
        rescindido caso haja atraso superior a 60 dias, consecutivos ou não.
      </p>
      <p class="info">
        Para restabelecer seus serviços de assistência à saúde, é necessário
        regularizar os débitos pendentes. Caso já tenha efetuado o pagamento,
        pedimos a gentileza de desconsiderar esta mensagem.
      </p>
      <p class="info">
        Estamos à disposição para auxiliá-lo(a) no que for necessário.
      </p>

      <table>
        <thead>
          <tr>
            <th>Nome</th>
            <th>Data de Inclusão</th>
            <th>Data de Bloqueio</th>
          </tr>
        </thead>
        <tbody>
          ##5
        </tbody>
      </table>

      <div class="footer">
        <p>
          Entre em contato conosco para mais informações.<br />Email: ##3 |
          Telefone: ##4
        </p>
      </div>
    </div>
  </body>
</html>

...

Func. Dados - Função que retorna os dados que por sua vez irão substituir as marcações no HTML com o ##Número.
- Para função de usuário, deve-se inserir a chamada completa U_FuncaoUsuario sem parênteses.
- A função de dados deve retornar um objeto JSON onde os atributos devem ser um sequencial de numeral conforme o exemplo no tópico Exemplo de Função de Dados.

Exemplo de Função de Dados:

Bloco de código

language	c#
theme	RDark
title	Exemplo
linenumbers	true

#INCLUDE "Totvs.ch"

function dados()

	Local cCompHtml   as character
	Local oJEmailData := JsonObject():New()

	cCompHtml += "<tr>"
	cCompHtml += "	<td>" + AllTrim(BA1->BA1_NOMUSR) + "</td>"
	cCompHtml += "	<td>" + DTOC(BA1->BA1_DATINC) + "</td>"
	cCompHtml += "	<td>" + DTOC(BA1->BA1_DATBLO) + "</td>"
	cCompHtml += "</tr>"    

    oJEmailData["1"] := BA1->BA1_NOMUSR  
	oJEmailData["2"] := BA1->(BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)  
	oJEmailData["3"] := BA1->BA1_EMAIL  
	oJEmailData["4"] := BA1->BA1_TELEFO  
	oJEmailData["5"] := cCompHtml

Return oJEmailData

...

Funcao Conf. - Campo destinado ao nome da função ou método que utilizará a configuração de e-mail. Cada função ou método deve ser inserido em uma nova linha no grid, permitindo o uso compartilhado da configuração por diferentes pontos do sistema.
- A função inseridano campo Funcao Conf. não pode ser do tipo static e deverá fazer a chamada da função conforme tópico Função de Configuração.
- Para função de usuário, deve-se inserir a chamada completa U_FuncaoUsuario sem parênteses.

Envio de E-mail Utilizando a Configuração do Gerenciador de Contas de E-mail

Após configurar uma conta no Gerenciador de Contas de E-mail, essa configuração poderá ser utilizada para o envio de mensagens, considerando os dados do remetente e o layout em HTML definidos. Para isso, basta utilizar o método SendEmailUsingConfigurator da classe EmailConfigurator. Com apenas alguns parâmetros, a classe identifica automaticamente a configuração apropriada, executa a função de retorno de dados, realiza a substituição das marcações no conteúdo e efetua o envio do e-mail.

Sintaxe

EmailManager:SendEmailUsingManager(< cConfigCode >, < cRecipient >, < aAttachments >, < cCopOcult >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cConfigCode	caractere	Código sequencial criado pelo gerenciador de contas de e-mail no campo ID Config.
cRecipient	caractere	Endereço de e-mail do destinatário que receberá o e-mail.	X
aAttachments	Array	Array contendo em cada posição o caminho completo do arquivo com a extenção extensão que será enviado junto ao e-mail.
cCopOcult	caractere	Endereços de e-mail dos destinatários que receberão a mensagem como cópia oculta (CCO), separados por vírgula.

Retorno

Nome

Tipo

Descrição

oJSendmail

json

Retorna um objeto do tipo json com dois atributos.

oJSendmail["sendMail"] - Retorna .T. caso o e-mail tenha sido enviado com sucesso, ou retorna .F. caso tenha ocorrido algum erro no envio.

oJSendmail["message"] - Mensagem de sucesso ou de erro.

Nota

O parâmetro cConfigCode deve ser utilizado apenas quando for necessário informar diretamente o código de uma configuração de e-mail, dispensando o preenchimento do campo "Função Conf." na configuração. Nesse caso, não é preciso vincular a função ou método de origem ao envio do e-mail. No entanto, vale destacar que, ao utilizar esse parâmetro, qualquer alteração de layout exigirá a modificação direta no código-fonte, o que reduz a flexibilidade e dificulta a manutenção. Por esse motivo, recomenda-se evitar o uso do parâmetro cConfigCode e, sempre que possível, preencher o campo "Função Conf." com o nome da função responsável pelo envio do e-mail.

Função de Configuração

Primeiro identifique a função (não pode ser static) ou método que irá realizar o processo de envio do e-mail.

...

Após a implementação da classe de envio de e-mail, acesse o Gerenciador de Contas de E-mail, localize a configuração que será utilizada e insira o nome da função no campo "Função Conf." do grid que no caso será U_MAILTSTE. É possível adicionar quantas linhas forem necessárias para registrar diferentes funções ou métodos que utilizarão essa configuração.

Log

...

de Erros

A maioria dos erros relacionados ao envio de e-mails utilizando o Gerenciador de Contas de E-mail pode ser analisada em maior detalhe no arquivo LogConfigEmail.log, localizado no diretório LOGPLS, dentro da pasta PROTHEUS_DATA.

Vídeo com o resultado das configurações acima:

View file

name	Teste de E-mail.mp4
height	250

04. DEMAIS INFORMAÇÕES

Atualização do Dicionário de Dados

inclusão de itens da tabela BZD no Arquivo SX3:

...

Tabela	BZF
Modo	Compartilhado
Modo Unidade	Exclusivo
Modo Empresa	Exclusivo
Chave Única	BZF_FILIAL + BZF_IDBZD + BZF_FUNCFG
Nome	Funcoes do Config. de email

Card documentos
Informacao As alterações de dicionário referente a essa implementação estarão disponíveis através de pacote de expedição contínua do plano de saúde com data igual ou superior

...

30/05/2025.
Titulo Importante

05. ASSUNTOS RELACIONADOS

Não se aplica

Templatedocumentos

...

Árvore de páginas

Versões comparadas

Versão antiga 29

Nova versão Atual

Chave

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

03. SOLUÇÃO

Gerenciador de Contas de E-mail

Introdução

Funcionalidades

Layouts em HTML e CSS

Configuração de Remetentes

Personalização do Corpo do E-mail

Como Acessar a Rotina

Tela de configuração de e-mail:

Exemplo de Código HTML Para o Corpo do E-mail

Exemplo de Função de Dados:

Envio de E-mail Utilizando a Configuração do Gerenciador de Contas de E-mail

Sintaxe

Parâmetros

Retorno

Função de Configuração

Log

de Erros

Vídeo com o resultado das configurações acima:

04. DEMAIS INFORMAÇÕES

Atualização do Dicionário de Dados

Card documentos
Informacao As alterações de dicionário referente a essa implementação estarão disponíveis através de pacote de expedição contínua do plano de saúde com data igual ou superior

30/05/2025.
Titulo Importante

05. ASSUNTOS RELACIONADOS

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 29

Nova versão Atual

Chave

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

03. SOLUÇÃO

Gerenciador de Contas de E-mail

Introdução

Funcionalidades

Layouts em HTML e CSS

Configuração de Remetentes

Personalização do Corpo do E-mail

Como Acessar a Rotina

Tela de configuração de e-mail:

Exemplo de Código HTML Para o Corpo do E-mail

Exemplo de Função de Dados:

Envio de E-mail Utilizando a Configuração do Gerenciador de Contas de E-mail

Sintaxe

Parâmetros

Retorno

Função de Configuração

Log

de Erros

Vídeo com o resultado das configurações acima:

04. DEMAIS INFORMAÇÕES

Atualização do Dicionário de Dados

Card documentosInformacaoAs alterações de dicionário referente a essa implementação estarão disponíveis através de pacote de expedição contínua do plano de saúde com data igual ou superior

30/05/2025.TituloImportante

05. ASSUNTOS RELACIONADOS

Card documentos
Informacao As alterações de dicionário referente a essa implementação estarão disponíveis através de pacote de expedição contínua do plano de saúde com data igual ou superior

30/05/2025.
Titulo Importante