...
Utilização da API utapi019 para envio de mensagens pelo servidor de correio eletrônico e envio de FAX pelo servidor de FAX..
...
- A utilização dessa API não é recomendada em ambientes WEB, pois a mesma pode solicitar informações ao usuário e, no caso de executar o Blat, o usuário do IIS deverá ter permissão para efetuar a tarefa de envio e rodar o aplicativo Blat.
- A include utapi019.i contém as definições das temp-table's tt-envio2, tt-mensagem e tt-erro que devem ser passadas como parâmetros à API.
- A include utapi019.i1 contém a definição da temp-table tt-paramEmail e chamada para a include utapi019.i, resultando na definição de todas as temp-table's necessárias para chamadas à API.É possível enviar e-mail e FAX em ambiente Windows e apenas e-mail em ambiente UNIX.
- Por padrão, será utilizado Outlook ou Blat no ambiente Windows ou comando sendmail no ambiente UNIX para envio de e-mail e será utilizado Outlook para envio de FAX.
- Quando for utilizado envio de e-mail numa sessão background do Progress(batch-mode) e o ambiente for Windows, a API utilizará sempre o Blat.
- No envio da mensagem em ambiente UNIX, o sendmail e o uuencode devem estar configurados corretamente. Para testar o funcionamento do comando, digite no prompt, usando o mesmo usuário e na mesma pasta em que a API será executada, os respectivos comandos sendmail e uuencode. A execução destes programas não deve apresentar erros. Caso ocorram erros deve-se entrar em contato com a equipe de suporte do sistema operacional do servidor.
- A API possui eventos de UPC que permitem ao usuário alterar o comando de execução do envio. Esses pontos foram desenvolvidos para atender às necessidades de usuários que precisam adicionar informações específicas de ser serviço de e-mail que não são contempladas pelos produtos Datasul.
- A API tem algumas restrições ao ser comparado a um serviço de e-mail: não efetua validações dos tipos de arquivos anexados à mensagem nem outros tipos de tratamento que um serviço de e-mail realiza. Caso ocorra alguma dessas validações que a API não trata, será considerado pela API que todos os e-mails foram enviados corretamente.
...
| Atributo | Tipo | Valor Inicial | Descrição |
|---|
| versao-integracao | integer |
| Versão de integração da API. |
| servidor | character |
| Hostname ou endereço IP do servidor de e-mail. Caso não informado, é utilizado o cadastro dos parâmetros de e-mail do produto. |
| porta | integer | 0 | Número da Porta do servidor de e-mail. Caso não informado, é utilizado o cadastro dos parâmetros globais do produto. Só influencia quando utilizado OCX para envio da mensagem. |
| exchange | logical | no | Utilizar servidor Exchange para envio da mensagem. |
| destino | character |
| Destinatário(s) da mensagem. Quando é mais de um, devem ser separados por vírgulas. Deve ser informado obrigatoriamente. Quando for utilizado para envio de fax, deve ser passado no padrão “[fax:número]”. |
| copia | character |
| Cópia Carbono da mensagem. Quando é mais de um, devem ser separados por vírgulas. Para ambiente UNIX, os endereços adicionados nesse campo serão incluídos no campo "para". |
| remetente | character |
| Remetente da mensagem. Só influencia quando utilizado OCX para envio da mensagem. Precisa ter os padrões de um endereço de e-mail([email protected]). Tem que ser um e-mail valido quando utilizado JAVA. |
| assunto | character |
| Assunto da mensagem. |
| mensagem | character |
| Corpo da mensagem. Informação obrigatória. |
| arq-anexo | character |
| Caminho completo do arquivo a ser anexado na mensagem. Disponível apenas para envio de mensagem por MS-Exchange, Blat, Java e UNIX. Em outros casos, é incorporado na mensagem, o caminho do arquivo. Para anexar mais de um arquivo, eles devem ser separados por virgula. |
| importancia | integer | 0 | Nível da importância da mensagem. Só influencia quando utilizado servidor Exchange. Os valores possíveis são de 0 a 2: 0 – Prioridade Baixa, 1 – Prioridade Normal, 2 – Prioridade Alta. |
| log-enviada | logical | no | Envia uma mensagem para o remetente assim que a sua mensagem original for enviada. Só influencia quando utilizado servidor Exchange. |
| log-lida | logical | no | Envia uma mensagem para o remetente assim que a sua mensagem original for lida. Só influencia quando utilizado servidor Exchange. |
| acomp | logical | yes | Execução do utilitário ut-acomp, para verificar o desenvolvimento da execução. Só influencia quando utilizado servidor Exchange. |
| formato | character | Texto | Aceita dois valores: "TEXTO", para enviar e-mail sem formatação e "HTML" , onde o e-mail será enviado no formato HTML. |
Abaixo é possível visualizar onde cada atributo é obrigatório ou opcional:
| Atributo | DatasulMailService | EXCHANGE |
|---|
FAX | | BLAT/OCX | SENDMAIL (UNIX) | JAVA | MAILSEND (SSL) |
|---|
| versao-integracao | Obrigatório | Obrigatório | Obrigatório | Obrigatório | Obrigatório | Obrigatório |
|---|
| servidor |
|---|
Desnecessário| Opcional | Desnecessário | Opcional | Opcional | Obrigatório | Obrigatório |
| porta |
|---|
Desnecessário| Opcional | Desnecessário | Opcional | Desnecessário | Obrigatório | Obrigatório |
| destino | Obrigatório | Obrigatório | Obrigatório | Obrigatório | Obrigatório | Obrigatório |
|---|
| copia | Opcional | Opcional | Opcional | Desnecessário | Desnecessário | Opcional |
|---|
| remetente |
|---|
Desnecessário| Obrigatório(*) | Desnecessário | Obrigatório | Opcional | Obrigatório | Obrigatório |
| assunto |
|---|
Opcional| Obrigatório | Opcional | Obrigatório | Opcional | Obrigatório | Obrigatório |
| mensagem | Obrigatório | Obrigatório | Obrigatório | Obrigatório | Obrigatório | Obrigatório |
|---|
| arq-anexo | Opcional |
|---|
Obrigatório| Opcional | Opcional¹ | Opcional³ | Opcional | Opcional |
| importancia | Desnecessário | Opcional |
|---|
Desnecessário | Desnecessário | Desnecessário | Desnecessário | Desnecessário |
| log-enviada | Desnecessário | Opcional | Desnecessário | Desnecessário | Desnecessário | Desnecessário |
|---|
Desnecessário | | log-lida | Desnecessário | Opcional | Desnecessário | Desnecessário | Desnecessário | Desnecessário |
|---|
| acomp | Desnecessário |
|---|
acomp | | Opcional | Desnecessário | Desnecessário | Desnecessário | Desnecessário |
DesnecessárioformatoDesnecessário | Opcional¹ | Opcional³ | Desnecessário | Desnecessário |
- Para utilização do Blat, é necessário encontrar o arquivo “interfac/mail/blat.exe” na estrutura de diretórios do produto. Caso não seja encontrado, o e-mail será enviado sem o anexo. O arquivo “blat.exe” é distribuído gratuitamente junto às mídias/pacotes dos produtos Datasul.
- Só é possível enviar e-mail no formato HTML utilizando Outlook 2000 ou posterior.
- Não é possível enviar e-mail no formato HTML quando existir arquivo anexo no UNIX.
- (*) Caso seja selecionada a opção de utilizar o comportamento “ativar responder para”, o remetente padrão informado será quem vai receber a resposta do e-mail. E caso o campo remetente padrão estiver preenchido na tela de parâmetros de e-mail, e não for passado um remetente como parâmetro, será utilizado como remetente o supra citado que está cadastrado no campo remetente padrão (tela parâmetros e-mail foundation).
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.
...
Possui os erros encontrados pela API.
| Atributo | Tipo | Valor Inicial | Descrição |
|---|
| cod-erro | integer |
| Número do erro |
| desc-erro | character |
| Descrição do erro |
| desc-arq | character |
| Caminho do arquivo que não pode ser anexado, por se tratar de envio de mensagem no ambiente UNIX. |
Execução
...
A API possui um método que pode ser executado:
...
