Scribd
Carregar
23 visualizações4 páginas

Api SMTP

Este documento é um guia de referência para a API de envio SMTP, que permite integrar sistemas para enviar emails através de um SMTP dedicado. Ele detalha os parâmetros obrigatórios e opcionais que devem ser enviados em uma requisição POST, além de fornecer exemplos de envio e retorno em JSON. A API utiliza a porta 587 e requer que os dados sejam codificados em JSON com o header apropriado.

Enviado por

João Loureiro
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
23 visualizações4 páginas

Api SMTP

Este documento é um guia de referência para a API de envio SMTP, que permite integrar sistemas para enviar emails através de um SMTP dedicado. Ele detalha os parâmetros obrigatórios e opcionais que devem ser enviados em uma requisição POST, além de fornecer exemplos de envio e retorno em JSON. A API utiliza a porta 587 e requer que os dados sejam codificados em JSON com o header apropriado.

Enviado por

João Loureiro
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd

API para envio de email - JSON

Introdução

Bem-vindo ao guia de referências da API de envio SMTP! É através desta API


que você irá integrar seu sistema ao nosso para realizar os envios através de
nosso SMTP dedicado.

A primeira coisa que você deve saber é o endpoint que usamos:

https://painel.mailgrid.com.br/api/

OBS: Também é possível usar o protocolo http caso prefira.

As chamadas da API devem ser feitas em POST.

Objeto status

Ao realizar um envio, este será o objeto que você irá receber como resposta.
Todos os envios são realizados na API pela porta 587 SMTP.

OBS: Assunto e mensagem devem ser codificados em UTF-8.


Parâmetros a serem enviados

Parâmetro Valor Obs.


host_smtp Endereço do servidor SMTP Obrigatório
usuario_smtp Usuário para autenticação Obrigatório
senha_smtp Senha para autenticação Obrigatório
emailRemetente Email do remetente Obrigatório
nomeRemetente Nome do remetente Opcional
emailReply Email de resposta (reply-to) Opcional
emailDestino Email para onde será enviada a Obrigatório - pode ser único ou
mensagem array com múltiplos endereços
nomeDestino Nome do destinatário Opcional
emailDestinoCopia Email para onde será copiada a Opcional - pode ser único ou
mensagem array com múltiplos endereços
assunto Assunto da mensagem Obrigatório
mensagem Mensagem a ser enviada Obrigatório – texto ou html
anexoContent arquivo codificado em base64 Opcional
(Data URI)
anexoFileName nome do arquivo a ser enviado Opcional
anexoType tipo Mime do arquivo a ser Opcional
anexado (ex: image/jpeg)

Atenção: Os dados devem ser passados via POST, codificados em JSON.


Não esqueça de passar o header Content-Type: application/json
Exemplo de envio em JSON:

{
"host_smtp": "serverxx.mailgrid.com.br",
"senha_smtp": "xxxxxxxx",
"usuario_smtp": "[email protected]",
"emailRemetente": "[email protected]",
"nomeRemetente": "nome do remetente",
"emailDestino": [
"[email protected]",
"[email protected]",
"[email protected]"
],
"assunto": "assunto da mensagem",
"mensagem": "mensagem"
}

Exemplo de retorno em JSON:

Quando a mensagem for enviada:

{
"0": {
"status": "MSG ENVIADA",
"codigo": "200",
"criptokey": "67bb60dc8c61c2c807c53a97c781176a",
"to": "[email protected]"
}
}

Quando ocorrer erro no envio, retornará o erro:

{
"status": "ERRO",
"codigo": "204",
"criptokey": "f87e7bf77c609d9537e146fb32d88418",
"to": "[email protected]"
}
Caso a API retorne o erro “FALTAM PARAMETROS”, ex:

{"status":"ERRO: FALTAM PARAMETROS","codigo":"208"}

Isso quer dizer que um ou mais parâmetros não foram passados


corretamente via POST e codificados em JSON.

As mensagens enviadas com sucesso são registradas automaticamente no relatório


de envios.
__________________________________________________________________________________

Você também pode gostar