Skip to main content

Enviar uma mensagem

Esta ação permite o envio de uma nova mensagem, bastando fornecer os parâmetros adequados.

URL

/api/v1/send/message

Acesso

É necessário autenticar-se como um servidor utilizando o header X-Server-API-Key. Se não for autorizado, será retornado um erro do tipo AccessDenied.

Parâmetros

ParâmetroTipoValor PadrãoDescrição
toArraynullEndereços de e-mail dos destinatários (máximo de 50).
ccArraynullEndereços de e-mail de cópia (máximo de 50).
bccArraynullEndereços de e-mail em cópia oculta (máximo de 50).
fromStringnullEndereço de e-mail para o cabeçalho "From".
senderStringnullEndereço de e-mail para o cabeçalho "Sender".
subjectStringnullAssunto do e-mail.
tagStringnullTag identificadora do e-mail.
reply_toStringnullEndereço de resposta (Reply-To).
plain_bodyStringnullCorpo do e-mail em texto puro.
html_bodyStringnullCorpo do e-mail em HTML.
attachmentsArraynullLista de anexos a serem enviados com o e-mail.
headersHashnullHash de cabeçalhos adicionais personalizados.
bounceBooleannullIndica se a mensagem é uma notificação de erro (bounce).

Erros

ErroAtributos
ValidationError
Os dados fornecidos não foram suficientes para envio.
  • errors

    Hash com detalhes dos campos inválidos.

NoRecipients
Nenhum destinatário foi definido para a mensagem.
 
NoContent
O conteúdo da mensagem está ausente.
 
TooManyToAddresses
Limite máximo de destinatários "To" atingido (máx. 50).
 
TooManyCCAddresses
Limite máximo de endereços "CC" atingido (máx. 50).
 
TooManyBCCAddresses
Limite máximo de endereços "BCC" atingido (máx. 50).
 
FromAddressMissing
O endereço "From" é obrigatório e está ausente.
 
UnauthenticatedFromAddress
O endereço "From" não está autorizado neste servidor.
 
AttachmentMissingName
Um dos anexos está sem nome definido.
 
AttachmentMissingData
Um dos anexos está sem dados definidos.
 

Dados da Resposta

Esta ação retorna um Hash com os dados da mensagem enviada.