Documentação da API de e-mail

Comece aqui

Sua primeira solicitação em quatro etapas

Configure uma caixa de correio no painel.

Copie apikey e a caixa de correio apikeybox.

Envie primeiro um e-mail de texto simples.

Adicione anexos ou incorporado imagens somente depois que a solicitação básica funcionar.

Autenticação

Mantenha as credenciais no seu servidor

Os endpoints de e-mail exigem a apikey da conta e a apikeybox específica da caixa de correio. Armazene ambas as credenciais no lado do servidor e mascare-as nos logs do aplicativo.

PUBLICAR

Enviar um e-mail

ENDPOINThttps://api.smsmobileapi.com/sendemail/

Envia email em texto simples ou HTML por meio de uma caixa de correio configurada.

Quando usá-lo

Use-a para emails transacionais ou operacionais do seu aplicativo.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`apikeybox`	corda	Obrigatório	Chave de API da caixa de correio configurada.
`sender_name`	corda	Obrigatório	Nome de exibição do remetente.
`sender_email`	e-mail	Obrigatório	Endereço de e-mail do remetente.
`recipient_email`	e-mail	Obrigatório	Endereço do destinatário.
`mail_subject`	corda	Obrigatório	Assunto do e-mail.
`mail_body`	corda	Obrigatório	Texto simples ou corpo HTML.
`allow_self_signed`	yes \| no	Obrigatório	Defina como sim somente quando o servidor de e-mail configurado usar um certificado autoassinado interno confiável.
`unsubscribe`	1	Opcional	Adiciona termos de cancelamento de assinatura e um link.
`email_cc1`	e-mail	Opcional	Primeiro destinatário opcional do CC.
`email_cc2`	e-mail	Opcional	Segundo destinatário opcional do CC.
`email_cc3`	e-mail	Opcional	Terceiro destinatário opcional do CC.
`attachmentBase64`	base64	Opcional	Conteúdo de anexo codificado em Base64.
`charset`	corda	Opcional	Conjunto de caracteres; padrão UTF-8.
`embeddedImage`	URL HTTPS	Opcional	Imagem a ser incorporada no e-mail.
`embeddedImage_cid`	corda	Opcional	ID do conteúdo referenciado no corpo HTML.
`format`	corda	Opcional	Formato de resposta solicitado.
`reply_name`	corda	Opcional	Nome de exibição para resposta.
`reply_email`	e-mail	Opcional	Endereço para resposta.

Exemplo de solicitação

enrolar

curl -X POST "https://api.smsmobileapi.com/sendemail/" \
  -d "apikey=YOUR_API_KEY" \
  -d "apikeybox=YOUR_MAILBOX_KEY" \
  --data-urlencode "sender_name=Example Team" \
  -d "sender_email=team@example.com" \
  -d "recipient_email=customer@example.net" \
  --data-urlencode "mail_subject=Order confirmation" \
  --data-urlencode "mail_body=Your order has been confirmed." \
  -d "allow_self_signed=no"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Prefira POST porque o corpo do e-mail pode ser longo.
Anexos Base64 podem tornar as solicitações grandes; aplique limites de tamanho razoáveis em seu aplicativo.

PEGAR

Recuperar e-mails

ENDPOINThttps://api.smsmobileapi.com/getemail/

Recupera mensagens de uma pasta de caixa de correio configurada.

Quando usá-lo

Use-a para sincronizar e-mails recebidos em um help desk ou fluxo de trabalho de aplicativo.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`apikeybox`	corda	Obrigatório	Chave de API de caixa de correio.
`mbox`	corda	Obrigatório	Pasta de caixa de correio, para exemplo INBOX.
`start`	inteiro	Obrigatório	Índice inicial; use 0 para a primeira página.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/getemail/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&mbox=INBOX&start=0"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

As respostas incluem assunto disponível, remetente, destinatário, corpo, carimbo de data/hora e detalhes do anexo.

PEGAR

Verifique contatos não inscritos

ENDPOINThttps://api.smsmobileapi.com/email/unsubscribed/

Verifica os registros de cancelamento de assinatura gerados por e-mails enviados pela plataforma.

Quando usá-lo

Use-o antes de enviar campanhas e ao sincronizar listas de supressão.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`apikeybox`	corda	Obrigatório	Chave de API de caixa de correio.
`email`	e-mail	Opcional	Filtrar um contato. Um resultado vazio significa que nenhum registro de cancelamento de assinatura foi encontrado.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/email/unsubscribed/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&email=customer@example.net"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Mantenha seu próprio banco de dados de destinatários sincronizado com os resultados de cancelamento de assinatura.
Você continua responsável pelas regras antispam e de privacidade aplicáveis.

Solução de problemas

Erros e novas tentativas seguras

Leia o status HTTP e o campo de erro JSON antes de tentar novamente. Não tente novamente falhas de validação ou autenticação sem primeiro corrigir a solicitação.

HTTP	Código	O que fazer
400	`missing_parameter`	Um parâmetro obrigatório está vazio ou ausente. Verifique a tabela de parâmetros do endpoint.
403	`invalid_apikey`	A chave de API é desconhecida, expirou ou não está autorizada para o recurso solicitado.
429	`too_many_requests`	As solicitações estão chegando muito rapidamente. Aguarde e tente novamente com espera exponencial.
500	`server_error`	O serviço não pôde concluir a solicitação. Mantenha a resposta e entre em contato com o suporte se ela persistir.

Regra de nova tentativaTente novamente apenas respostas transitórias 429 e 5xx. Comece após 1 segundo e depois volte para 2, 4 e 8 segundos.

Precisar de ajuda?

Traga o contexto da solicitação, não seus segredos.

Compartilhe o endpoint, o carimbo de data/hora, o status HTTP e a resposta limpa. Nunca inclua chaves de API, tokens ou conteúdo de mensagens privadas.

Entre em contato com o suporte da API →