Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Por se tratar de um serviço a chamada para o envio do e-mail se dá através de chamadas REST. A imagem abaixo exemplifica a arquitetura do serviço:

 

Configurações mínimas

// TODO: Reavaliar para utilizar os paramêtros cadastrados no btb962zb (emsfnd.param_email).

Para utilização do serviço é preciso se atentar a algumas configurações no produto.

  • No aquivo datasul_framework.properties preencher as propriedades com seus respectivos valores:
    mail.smtp.auth: (true/false): Habilita a autenticação para realização do envio de e-mail;

    • mail.smtp.user: (string): Usuário da conta que irá realizar o envio de e-mail;
      • No caso dos ambientes locais ao utilizar uma das contas de e-mails da TOTVS o usuário é simplesmente o e-mail sem o '@totvs.com.br'.
    • mail.smtp.pass: (string): Senha da conta que irá realizar o envio de e-mail;
    • mail.smtp.host: (string): Endereço do serviço de e-mail;
    • mail.smtp.port: (integer): Porta do serviço de e-mail;
    • mail.smtp.ssl.enable: (true/false): Habilita o suporte a SMTPS caso o servidor de e-mail esteja com HTTPS (SSL) habilitado;
    • mail.smtp.starttls.enable: (true/false): Habilita o suporte ao TLS;
    • mail.smtp.debug.enable: (true/false): Habilita o DEBUG da API do JAVA MAIL.

 


Bloco de código
languagejs
firstline1
titleExemplo
linenumberstrue
#+----------------------------------------------------------+
#|              DATASUL MAIL                                |
#+----------------------------------------------------------+
# Habilita a autenticação para realização do Usuário e senha da conta que irá realizar o envio de e-mail.
mail.smtp.authuser=true
#<username Usuário e senha da conta que irá realizar o envio de e-mail.
mail.smtp.user=<username ou login>ou login>
mail.smtp.pass=<senha do email>
# Endereço e porta do serviço de e-mail.
mail.smtp.host=mail.totvs.com.br
mail.smtp.port=587
# Habilita o suporte a SMTPS caso o servidor de e-mail esteja com HTTPS (SSL) habilitado.
mail.smtp.ssl.enable=true
# Indica se o servidor de e-mail está com o suporte ao TLS ativo.
mail.smtp.starttls.enable=true
# Habilita o DEBUG da API do JAVA MAIL.
mail.smtp.debug.enable=false

Serviços disponíveis

Através do contexto datasul-mail/resources estão disponíveis 3 serviços para envio de e-mails com as seguintes assinaturas:

 

  1. @GET /help

    1. Path: N/A.
    2. Query:
      1. debug: (true/false) Habilita/desabilita o modo de DEBUG da API do JAVA MAIL;
      2. reload: (true/false) Indica se deve ou não recarregar as configurações do serviço de e-mail.
    3. Response: Retorna as propriedades do Mail Service Response: Retorna algumas configurações de ambiente para facilitar a identificação de alguma possível situação inesperada:
    4. os: sistema operacional no qual está sendo executado o JBoss;
    5. java_home: diretório raiz a instalação da JVM utilizada pelo JBoss;
    6. java_version: versão da JVM utilizada pelo JBoss;
    7. encoding: encoding utilizado pela JVM;mail.smtp.auth
    8. As propriedades do Mail Service cadastradas no datasul_framework.properties (mail.smtp.auth, mail.smtp.user, mail.smtp.pass, mail.smtp.host, mail.smtp.port, mail.smtp.ssl.enable, mail.smtp.starttls.enable, mail.smtp.debug.enable).

    Exemplo: http://cordas:8480/dts/datasul-mail/resources/help/

  2. @POST /send: @Consumes({ MediaType.APPLICATION_JSON, MediaType.TEXT_PLAIN })

    Este serviço recebe o e-mail e suas opções para envio. Não suporta anexos.

    1. Path: N/A.
    2. Query: N/A.
    3. Body: JSON contendo a entidade Mail;
    4. Response: Uma cópia da entidade Mail em formato JSON.

    Exemplo: http://cordas:8480/dts/datasul-mail/resources/send/

  3. @POST /send: @Consumes(MediaType.MULTIPART_FORM_DATA)

    Este serviço recebe o e-mail e suas opções para envio. Suporta anexos.

    1. Path: N/A.
    2. Query: N/A.
    3. Body: JSON contendo a entidade Mail;
    4. Response: Uma cópia da entidade Mail em formato JSON.

    Exemplo: http://cordas:8480/dts/datasul-mail/resources/send/

...