01. DADOS GERAIS

Produto:	TOTVS Saúde Planos
Linha de Produto:	Linha Protheus
Segmento:	Saúde
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: Atualizações > 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.

Em alguns provedores de serviços de e-mail, a senha de acesso à conta e a senha de autenticação para aplicativos externos são diferentes. Além disso, pode ser necessário autorizar o uso da conta por aplicativos de terceiros para o envio de e-mails. Recomenda-se consultar o provedor de e-mail utilizado para verificar se as configurações e credenciais estão corretas.

Remetente - Endereço do remetente que será utilizado para o envio do e-mail.
SMTP - SMTP do E-mail que está sendo configurado como 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. 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

Exemplo

<!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:

Exemplo

#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 inserida no 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 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.

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.

No exemplo abaixo a função de usuário MailTste irá utilizar uma das configurações do gerenciador de contas de e-mail para enviar o e-mail.

Exemplo

User Function MailTste()
	Local oemail as object
	Local ojson  as object 

	// instanciando a classe Gerenciadora de E-mail
	oemail := totvs.protheus.health.plan.manager.EmailManager():New()

	// Chamada do método responsável por fazer todo o processamento de envio de e-mail
	// param1 = ID do gerenciador
	// param2 = e-mail destinatário
	// param3 = Diretório de anexos que deseja enviar no e-mail (Pode receber um array de diretórios)
	// param4 = e-mail que você deseja enviar como cópia
	ojson := oemail:SendEmailUsingManager(NIL,"[email protected]")
	
	If  ojson["sendMail"] //.T. = enviado com sucesso
		FWAlertSuccess(ojson["message"])
	Else	
		 FWAlertError(ojson["message"])
	EndIf
 
Return

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:

Teste de E-mail.mp4

04. DEMAIS INFORMAÇÕES

Atualização do Dicionário de Dados

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

Campo	Tipo	Tamanho	Titulo	Descrição	Relação	Usado	Obrigatório	Exibe Browser	Visual	Contexto	VLDUSR	CBox	Help
BZD_FILIAL	Caracter	8	Filial	Filial do Sistema		Não	Não	Não					Filial do Sistema
BZD_ID	Caracter	6	ID Config.	ID Config.	NextNumero("BZD", 1, "BZD_ID", .T.)	Sim	Sim	Não	Visual	Real			ID do gerenciador
BZD_TITCFG	Caracter	100	Titulo Conf.	Titulo da configuracao		Sim	Sim	Sim	Alterar	Real			Titulo da configuracao
BZD_REMTNT	Caracter	254	Remetente	Remetente		Sim	Sim	Sim	Alterar	Real	VAZIO() .OR. ValidMail(M->BZD_REMTNT)		Remetente
BZD_SMTP	Caracter	254	SMTP	SMTP		Sim	Sim	Sim	Alterar	Real			SMTP
BZD_USUARI	Caracter	254	Usu. Conta	Usuario		Sim	Sim	Não	Alterar	Real	VAZIO() .OR. ValidMail(M->BZD_USUARIO)		Usuario
BZD_SENHA	Caracter	254	Senha	Senha		Sim	Sim	Não	Alterar	Real			Senha
BZD_PORTA	Númeral	6	Porta	Porta		Sim	Sim	Sim	Alterar	Real			Porta
BZD_AUTENT	Caracter	1	Autentica?	Autentica?	"1"	Sim	Sim	Não	Alterar	Real		0=Nao;1=Sim	Autentica?
BZD_USUAUT	Caracter	254	Usuario Aut.	Usuario Aut.		Sim	Não	Não	Alterar	Real	VAZIO() .OR. ValidMail(M->BZD_USUAUT)		Usuario Autenticador
BZD_SENAUT	Caracter	254	Senha Aut.	Senha Aut.		Sim	Não	Não	Alterar	Real			Senha Aut.
BZD_ASSUNT	Caracter	254	Assun. Email	Assun. Email		Sim	Sim	Não	Alterar	Real			Assun. Email
BZD_FUNCAO	Caracter	20	Func. Dados	Func. Dados		Sim	Não	Não	Alterar	Real			Func. Dados
BZD_HTML	Memo	10	Corpo E-mail	Corpo E-mail		Sim	Sim	Não	Alterar	Real			Corpo E-mail
BZD_USERGA	Caracter	17	Log de Alter	Log de Alteracao		Não	Não	Não	Visual	Real			Log de Alteração
BZD_USERGI	Caracter	17	Log de Inclu	Log de Inclusao		Não	Não	Não	Visual	Real
BZD_TLS	Caracter	1	Utiliza TLS?	Utiliza TLS?		Sim	Sim	Não	Alterar	Real		0=Nao;1=Sim	Utiliza TLS?
BZD_SSL	Caracter	1	Utiliza SSL?	Utiliza SSL?		Sim	Sim	Não	Alterar	Real		0=Nao;1=Sim	Utiliza SSL?

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

Campo	Tipo	Tamanho	Titulo	Descrição	Relação	Usado	Obrigatório	Exibe Browser	Visual	Contexto	Help
BZF_FILIAL	Caracter	8	Filial	Filial do Sistema		Não	Não	Não			Filial do Sistema
BZF_IDBZD	Caracter	6	ID cabecalho	ID cabecalho	M->BZD_ID	Sim	Não	Não	Visual	Real	ID do cabeçalho
BZF_ID	Caracter	6	ID registro	ID registro		Sim	Não	Não	Visual	Real	ID do registro
BZF_FUNCFG	Caracter	30	Funcao Conf.	Funcao de Configuracao		Sim	Não	Não	Alterar	Real	Função de Configuração
BZF_USERGI	Caracter	17	Log de Inclu	Log de Inclusao		Não	Não	Não	Visual	Real	Log de Inclusão
BZF_USERGA	Caracter	17	Log de Alter	Log de Alteracao		Não	Não	Não	Visual	Real	Log de Alteração

Inclusão no Arquivo SIX:

Índice	Ordem	Chave	Descrição
BZD	1	BZD_FILIAL + BZD_ID	Filial + ID
BZF	1	BZF_FILIAL + BZF_FUNCFG	Filial + funcao em execucao

Inclusões na tabela SX2 (Tabela):

Tabela	BZD
Modo	Compartilhado
Modo Unidade	Exclusivo
Modo Empresa	Exclusivo
Chave Única	BZD_FILIAL + BZD_ID
Nome	Cabecalho do Config. de email

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

Importante

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.

05. ASSUNTOS RELACIONADOS

Não se aplica

Árvore de páginas

DT Gerenciador de Contas de E-mail

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

Importante

05. ASSUNTOS RELACIONADOS