Árvore de páginas

Versões comparadas

Chave

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

Índice

Pré Requisitos

  • TOTVS 12 com versão 12.1.15 ou superior;
  • Comunicação com o AppServer ativa e funcional para o resgate das informações 'base' para o envio de e-mail;
  • Servidor de e-mails com suporte a SMTP e uma conta válida para envio de e-mails.

...

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



@GET /help



Path: N/A.

Query: N/A.

Response: Retorna as propriedades do Mail Service (mail.smtp.sender, 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).




Bloco de código
languagejava
titleEXEMPLO
http://cordas:8480/dts/datasul-mail/resources/help/


@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.


Path: N/A.

Query: N/A.

Body: JSON contendo a entidade Mail;

Response: Uma cópia da entidade Mail em formato JSON.



Bloco de código
languagejava
titleEXEMPLO
http://cordas:8480/dts/datasul-mail/resources/send/



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

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

Path: N/A.

Query: N/A.

Body: JSON contendo a entidade Mail;

Response: Uma cópia da entidade Mail em formato JSON.


Bloco de código
languagejava
titleEXEMPLO
http://cordas:8480/dts/datasul-mail/resources/send/


Âncora
mail_object
mail_object

...

  1. subject: (string) assunto do e-mail;
  2. content: (string) conteúdo do e-mail, podendo ser HTML;
  3. reply: (string) (opcional) endereço de e-mail que receberá a resposta do e-mail enviado;
  4. to: ([string]) lista contendo os endereços de destinatários;
  5. cc: ([string]) (opcional) lista contendo os endereços de destinatários a receberem a cópia do e-mail;
  6. bcc: ([string]) (opcional) lista contendo os endereços de destinatários a receberem a cópia oculta do e-mail;
  7. returnNotificationType: (integer) (opcional): indica como deve ser o retorno em caso do envio retornar alguma confirmação ou erro.
    1. 1. Retorna o e-mail completo;
    2. 2. Retorna apenas o cabeçalho (default). 
  8. deliveryNotification: (integer) (opcional): indica o tipo de notificação que o remetente gostaria de receber.
    1. -1. Nenhuma (defaul);
    2. 1. Ao entregar o e-mail ao destinatário;
    3. 2. Ao falhar na entrega ao destinatário;
    4. 4. Ao atrasar a entrega ao destinatário;
  9. readNotificationTo: (string) Em caso de leitura do e-mail, caso tenha sido informado um endereço válido para este atributo, este receberá uma notificação de que o e-mail foi lido;
  10. priority: (integer) (opcional): prioridade do e-mail:
    1. 1: Alta;
    2. 3: (default) Normal;
    3. 5: Baixa.


tip
Dica
  • As mensagens de confirmação de entrega e falhas serão retornadas a caixa de e-mail do usuário que estiver sendo utilizado como sender pelo serviço de e-mail. Entretanto, quando informado um endereço de e-mail válido no atributo readNotificationTo, este receberá o e-mail de confirmação de leitura.


  • O envio de e-mail ocorre de forma assíncrona, desta forma os erros ou retornos de falhas do envio propriamente dito não são resgatados no momento da execução. Isso se deve ao fato de que o Datasul Mail Service delega ao servidor SMTP o envio da mensagem, sendo que este pode não efetuar o envio no momento em que for solicitado, variando de acordo com a sua fila de despachos e parametrizações.



Recursos Disponíveis

Para mais informações de quais são os recursos disponíveis quanto a esta opção de envio, consultar o link: Envio de e-mail.

...