Objetivo

Utilização da API utapi019

para envio de mensagens pelo servidor de correio eletrônico

..

Fontes

$/FOUNDATION/Fontes_Doc/Sustentacao/V11/V11/progress/src/utp

• utapi019.p
• utapi019.i
• utapi019.i1
• utapi019.i2
  
  

Considerações gerais

Âncora
parametros parametros

Parâmetros de e-mail

O produto possui um cadastro de parâmetros de e-mail (BTB962ZB). Mais informações quanto a parametrização estão disponíveis em: Parâmetros Email Foundation (BTB962ZB).

Esses parâmetros serão utilizados quando não informados na temp-table enviada à API:

Temp-tables

tt-envio2

Possui definições da mensagem a ser enviada.

Abaixo é possível visualizar onde cada atributo é obrigatório ou opcional:

tt-mensagem

Possui o conteúdo da mensagem enviada. Essa temp-table foi criada porque o número máximo de caracteres por registro no Progress é de 32kb e caso a mensagem do e-mail possuísse mais 32 Kb era exibida a

mensagem Progress 444.  Com essa temp-table será possível enviar e-mail com quantos caracteres forem necessários, menos com a opção Exchange que ainda mantém essa limitação.

ttAttachment

Possui informações dos arquivos que serão anexos ao e-mail.

tt-paramEmail

Indica somente o tipo de envio de e-mail (campo caminhoEmail) e sua evolução segue na definição da TempTable tt-paramEmail2, abaixo.

tt-paramEmail2

Indica tipo de envio de e-mail, usuário e senha para autenticação no servidor de e-mail caso venha a ser necessário, opção de ativar comportamento de resposta do para utilização de remetente padrão.

  Os parâmetros acima (tt-paramEmail2) não são obrigatórios, caso não sejam informados, serão utilizadas as informações da tela de parâmetros de e-mail do foundation (btb962zb).

tt-erro

Possui os erros encontrados pela API.

Âncora
replyto replyto

Funcionalidade Responder Para

A funcionalidade Responder Para serve foi criada para que a resposta do e-mail seja direcionada para um endereço diferente do que o utilizado para o envio, por exemplo, equipes de marketing. Caso a função seja ativada, a resposta ao e-mail será enviada ao valor informado no campo "remetente" da tabela tt-envio2. Caso este campo não esteja preenchido, será utilizado o remetente informado no cabeçalho do e-mail. Para decisão do remetente do e-mail enviado será utilizada a seguinte estrutura:

1. campo "codRemetPadrao" da tabela tt-paramEmail2;
2. campo "Remetente Padrão" da tela Parâmetros Email Foundation (BTB962ZB);
3. campo "remetente" da tabela tt-envio2.

Execução

A API possui um método que pode ser executado:

1. pi-execute4: recebe cinco temp-tables como parâmetros: tt-envio2 (INPUT), tt-mensagem (INPUT), tt-paramEmail (INPUT), ttAttachment (INPUT) e tt-erros (OUTPUT).

A API irá executar duas validações básicas:

1. Versão de integração: verifica se o programa chamador está íntegro com a API, e isto ocorre por meio da verificação da versão de integração passada como parâmetro. Caso a versão esteja incompatível, a API abortará a execução retornando a mensagem 3941.
2. Inconsistência ou insuficiência de dados: verifica a inconsistência e/ou insuficiência dos dados. Isto ocorre por meio da verificação dos dados passados como parâmetros. Caso os dados sejam inconsistentes ou insuficientes, a API abortará a execução retornando o código de erro 8646. Cabe ao programa de origem, verificar a consistência do registro que está sendo enviado.

Existem dois retornos possíveis para a execução da API:

1. OK: Mensagem enviada com sucesso.
2. NOK: Envio de mensagem abortado. Os erros encontrados serão retornados por meio da temp-table tt-erros.

Exemplos

{utp/utapi019.i2}

RUN utp/utapi019.p PERSISTENT SET h-utapi019.

CREATE tt-envio2.
ASSIGN tt-envio2.versao-integracao = 1
       tt-envio2.destino   = "[email protected]"	
	   tt-envio2.remetente = "[email protected]"
	   tt-envio2.assunto   = "teste envio DATASUL MAIL SERVICE".

CREATE ttAttachment.
ASSIGN ttAttachment.fileName    = "teste.txt"
       ttAttachment.fileType    = "text/plain".

// COPIANDO CONTEÚDO DE ARQUIVO DO COMPUTADOR PARA O CAMPO BLOB
COPY-LOB FILE "C:\teste.txt" TO ttAttachment.fileContent.   //conteúdo do arquivo em formato binário

ALERT-BOX.


DELETE PROCEDURE h-utapi019.

Pontos de customização

A API possui eventos de UPC que permitem ao usuário alterar o comando de execução. Esses pontos foram desenvolvidos para atender as necessidades de usuários que precisam adicionar informações específicas não contempladas no produto Datasul.

{include/i-epc200.i1} /* definição da temp-table tt-epc */

DEFINE INPUT        PARAMETER p-ind-event AS CHARACTER NO-UNDO.
DEFINE INPUT-OUTPUT PARAMETER TABLE       FOR tt-epc.

DEFINE VARIABLE cComandoEmail AS CHARACTER NO-UNDO.

IF p-ind-event = "eMailBlat" THEN DO:
    FIND FIRST tt-epc
        WHERE tt-epc.cod-event     = "eMailBlat":U
        AND   tt-epc.cod-parameter = "CommandEmail":U
        EXCLUSIVE-LOCK NO-ERROR.
    IF AVAILABLE tt-epc THEN 
        ASSIGN cComandoEmail = tt-epc.val-parameter.
    
    ASSIGN cComandoEmail = cComandoEmail + " -hostname ~"tech-valdir~"":U.

    IF AVAILABLE tt-epc THEN 
        ASSIGN tt-epc.val-parameter = cComandoEmail.
END.

O nome do evento pode possuir os seguintes valores: