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âmetro | Tipo | Valor Padrão | Descrição |
---|---|---|---|
to | Array | null | Endereços de e-mail dos destinatários (máximo de 50). |
cc | Array | null | Endereços de e-mail de cópia (máximo de 50). |
bcc | Array | null | Endereços de e-mail em cópia oculta (máximo de 50). |
from | String | null | Endereço de e-mail para o cabeçalho "From". |
sender | String | null | Endereço de e-mail para o cabeçalho "Sender". |
subject | String | null | Assunto do e-mail. |
tag | String | null | Tag identificadora do e-mail. |
reply_to | String | null | Endereço de resposta (Reply-To). |
plain_body | String | null | Corpo do e-mail em texto puro. |
html_body | String | null | Corpo do e-mail em HTML. |
attachments | Array | null | Lista de anexos a serem enviados com o e-mail. |
headers | Hash | null | Hash de cabeçalhos adicionais personalizados. |
bounce | Boolean | null | Indica se a mensagem é uma notificação de erro (bounce). |
Erros
Erro | Atributos |
---|---|
ValidationError Os dados fornecidos não foram suficientes para envio. |
|
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.