Histórico da Página
Í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 | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
http://cordas:8480/dts/datasul-mail/resources/send/ |
Âncora | ||||
---|---|---|---|---|
|
...
- subject: (string) assunto do e-mail;
- content: (string) conteúdo do e-mail, podendo ser HTML;
- reply: (string) (opcional) endereço de e-mail que receberá a resposta do e-mail enviado;
- to: ([string]) lista contendo os endereços de destinatários;
- cc: ([string]) (opcional) lista contendo os endereços de destinatários a receberem a cópia do e-mail;
- bcc: ([string]) (opcional) lista contendo os endereços de destinatários a receberem a cópia oculta do e-mail;
- returnNotificationType: (integer) (opcional): indica como deve ser o retorno em caso do envio retornar alguma confirmação ou erro.
- 1. Retorna o e-mail completo;
- 2. Retorna apenas o cabeçalho (default).
- deliveryNotification: (integer) (opcional): indica o tipo de notificação que o remetente gostaria de receber.
- -1. Nenhuma (defaul);
- 1. Ao entregar o e-mail ao destinatário;
- 2. Ao falhar na entrega ao destinatário;
- 4. Ao atrasar a entrega ao destinatário;
- 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;
- priority: (integer) (opcional): prioridade do e-mail:
- 1: Alta;
- 3: (default) Normal;
- 5: Baixa.
Dica |
---|
|
|
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.
...