Envio de mensagens

Recursos disponíveis

URL

POST https://api.smtplw.com.br/v1/messages

Parâmetros (*)

Parâmetro	Descrição	Exemplo	Obrigatório
subject	Assunto do email	Um assunto qualquer	sim
body (**)	Conteúdo do e-mail. Pode conter tags html e texto	Um conteúdo qualquer	sim
from	Remetente. Precisa estar cadastrado no painel do SMTP	Nome do remetente <remetente@dominio.com>	sim
to	Destinatário. Pode ser um array ou um único e-mail	["to1@dominio2.com", "to2@dominio2.com"]	sim
headers	Cabeçalhos	{ "Content-Type": "text/plain" }	não
cc	Cópia. Pode ser um array ou um único e-mail	["cc1@dominio2.com", "cc2@dominio2.com"]	não
bcc	Cópia oculta. Pode ser um array ou um único e-mail	["bcc1@dominio2.com", "bcc2@dominio2.com"]	não

(*) Recomendamos a utilização da ferramenta JSONLint para validar o corpo da requisição que será feita à API.

(**) Lembramos que, ao inserir HTML no campo body da mensagem, é preciso escapar todas as aspas duplas no código utilizando-se \ (barra invertida).

Forma incorreta: "body": "<html><img src="http://meusistema.locaweb.com.br/images/logo.jpg"></html>"
Forma correta: "body": "<html><img src=\"http://meusistema.locaweb.com.br/images/logo.jpg\"></html>"

Você também pode utilizar aspas simples no lugar das aspas duplas.
Forma alternativa: "body": "<html><img src='http://meusistema.locaweb.com.br/images/logo.jpg'></html>"

Resposta

Status	Descrição
Enfileirado	Mensagem está na fila para ser processada.
Enviado	Mensagem enviada.
Erro	Falha ao enviar a mensagem. O reenvio não será feito automaticamente. Veja o campo response para mais detalhes.

Response code (HTTP status)	Descrição
201 - Created	Mensagem adicionada à fila com sucesso. O cabeçalho HTTP Location contém a URL do recurso para consultar o resultado.
400 - Bad Request	Parâmetros incorretos ou não encontrados. Veja a mensagem de erro para mais detalhes.
401 - Unauthorized	O token da API está incorreto ou ausente. Veja a mensagem de erro para mais detalhes.
403 - Forbidden	O limite de e-mails por minutos foi excedido. Veja a mensagem de erro para mais detalhes.
403 - Forbidden	O remetente especificado no campo from não tem permissão para enviar e-mails. Para utilizá-lo, é necessário confirmá-lo em https://smtplw.com.br/panel/settings/emails
413 - Request Entity Too Large	O tamanho da lista de destinatários está acima do limite de 1.000 endereços de e-mail.
415 - Unsupported media type	O cabeçalho content-type contém um tipo de mídia inválido. Esta API suporta application/json.
422 - Unprocessable Entity	Parâmetro com valor incorreto. Veja a mensagem de erro para mais detalhes
500 - Internal Server Error	Erro interno inesperado na API. Tente novamente em alguns minutos e se persistir contate o suporte.

Exemplo para destinatário único

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
POST https://api.smtplw.com.br/v1/messages
content-type: application/json
x-auth-token: 7sd6g8f7sdg78fsdg7fsd

{
    "from": "User1 <user1@email.com>",
    "subject": "Locaweb SMTP",
    "body": "Email Test",
    "to": "User2 <user2@email.com>",
    "headers": {
        "Reply-to": "teste@email.com",
        "x-locaweb-test": "header value"
    }
}


RESPOSTA:
Status: 201 Created
Location: https://api.smtplw.com.br/v1/messages/25

{
    status: "ok"
}

Exemplo para vários destinatários

1
2
3
4
5
6
7
8
9
10
11
12
13
POST https://api.smtplw.com.br/v1/messages
content-type: application/json
x-auth-token: 7sd6g8f7sdg78fsdg7fsd

{
    "to": [
        "recipient1@domain1.com",
        "recipient2@domain2.com"
    ],
    "from": "",
    "subject": "",
    "body": ""
}

Limites de envio

Item	Limite
Destinatários por mensagem	1.000
Envios por minuto. (Exemplo: 1 mensagem para 10 destinatários equivale a 10 envios)	1.000
Número máximo de cabeçalhos	50
Tamanho máximo do corpo da mensagem	1 MB
Tamanho máximo do título da mensagem	998 caracteres

Developer Network