Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi\apiEmail.p |
Objetivo
Enviar email utilizando a include padrão utp/utapi019.i.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttEmail |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
c-para | Char |
| Para |
|
c-cc | Char |
| Contato |
|
c-anexos | Char |
| Anexo |
|
c-assunto | Char |
| Assunto |
|
num_id_layout | Int |
| Id do layout |
|
c-areaemail | Char |
| Descrição email |
|
ttListEmails |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Nome | Char |
| Nome |
|
Char |
|
|
ttListEmailsSearch |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Nome | Char |
| Nome |
|
Char |
|
|
ttListEmailsSelecionados |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Nome | Char |
| Nome |
|
Char |
|
|
ttEmailAcount |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Conta | Int |
| Id da conta |
|
Char |
|
| ||
Html | Char |
| html |
|
Parâmetros de input e output da api
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
|
|
|
|
|
|
|
Métodos
Métodos básicos
Método: sendEmails
Descrição: método principal para envio de email apartir de um publico selecionado.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttEmail | Tt |
| X |
|
| Parâmetros para envio de email |
c-numIdPublico | Int |
| X |
|
| Id do publico |
l-retorno | Log |
|
| X |
| Envio email |
Métodos básicos
Método: destroyHandle
Descrição: deletar os handle da memória.
Requisitos: nenhum
Parâmetros: nenhum
Métodos básicos
Método: sendOneEmail
Descrição: método padrão para envio de email.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttEmail | Tt |
| X |
|
| Parâmetros para envio de email |
l-retorno | Log |
|
| X |
| Envio email |
Métodos básicos
Método: prepareListOfEmailTT
Descrição: organiza temp-table que contém a parametrização dos email a serem enviados.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttEmail | Tt |
|
|
| x | Parâmetros para envio de email |
Método: prepareListOfEmailTTbyPublic
Descrição: organiza temp-table que contém a parametrização dos email a serem enviados para o publico selecionado.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttEmail | Tt |
|
|
| x | Parâmetros para envio de email |
Método: listEmails
Descrição: valida e organiza em uma temp-table os email.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-tipo | Char |
| X |
|
| Tipo – conta ou usuário |
ttListEmails | Tt |
|
| X |
| Lista de emails |
Método: searchEmails
Descrição: filtra os emails de acordo com o valor passado.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-tipo | Char |
| X |
|
| Tipo – conta ou usuário |
c-word | Char |
| X |
|
| Valor |
ttListEmailsSearch | Tt |
|
| X |
| Emails filtrados |
Método: returnEmails
Descrição: retorna uma lista com os email que serão utilizados no envio.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-word-anterior | Char |
| X |
|
| Valor anterior |
ttListEmailsSelecionados | Tt |
| X |
|
| Emails selecionados |
c-word | Char |
|
| X |
| Valor atual com os emails |
Método: returnPublic
Descrição: retorna uma lista com os email que serão utilizados no envio.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
i-numIdPublico | Int |
| X |
|
| Id do publico |
c-publico | Char |
|
| X |
| Descrição do publico |
Método: assignTTEmail
Descrição: retorna a parametrização que devera ser utilizada para envio de email.
Requisitos: nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tt-envio2 | Tt |
|
|
| X | Parametrização para envio de email |