API de e-mail

No momento, ainda não lançamos nenhum wrapper de API, mas planejamos fazê-lo em breve. Envie um e-mail para api@forwardemail.net se desejar ser notificado quando o wrapper de API de uma linguagem de programação específica for lançado. Enquanto isso, você pode usar estas bibliotecas de solicitação HTTP recomendadas em seu aplicativo ou simplesmente usar enrolar como nos exemplos abaixo.

O caminho atual do URI base HTTP é: https://api.forwardemail.net.

Todos os endpoints exigem que seu Chave de API seja definido como o valor "nome de usuário" do cabeçalho Autorização Básica da solicitação (com exceção de Contatos de alias, Calendários Alias e Caixas de correio de alias que usam um nome de usuário e senha de alias gerados).

Não se preocupe — fornecemos exemplos abaixo para você caso não tenha certeza do que é isso.

Se ocorrer algum erro, o corpo de resposta da solicitação da API conterá uma mensagem de erro detalhada.

Nosso serviço é traduzido para mais de 25 idiomas diferentes. Todas as mensagens de resposta da API são traduzidas para a última localidade detectada do usuário que fez a solicitação. Você pode substituir isso passando um cabeçalho Accept-Language personalizado. Sinta-se à vontade para experimentar usando o menu suspenso de idiomas na parte inferior desta página.

A paginação é suportada por todos os endpoints da API que listam resultados.

Basta fornecer as propriedades da string de consulta page (e opcionalmente limit).

A propriedade page deve ser um número maior ou igual a 1. Se você fornecer limit (também um número), o valor mínimo será 10 e o máximo será 50 (salvo indicação em contrário).

Para determinar se há mais resultados disponíveis, fornecemos estes cabeçalhos de resposta HTTP (que você pode analisar para paginar programaticamente):

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Recuperar logs

Nossa API permite que você baixe os logs da sua conta programaticamente. Enviar uma solicitação para este endpoint processará todos os logs da sua conta e os enviará por e-mail como anexo (arquivo de planilha Gzip compactado CSV) após a conclusão.

Isso permite que você crie trabalhos em segundo plano com um Tarefa cron ou use nosso Software de agendamento de tarefas Node.js Bree para receber logs sempre que desejar. Observe que este endpoint está limitado a 10 solicitações por dia.

O anexo é a forma minúscula de email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz e o próprio e-mail contém um breve resumo dos logs recuperados. Você também pode baixar os logs a qualquer momento em Minha conta → Registros.

GET /v1/logs/download

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

Exemplo de tarefa Cron (à meia-noite todos os dias):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Observe que você pode usar serviços como Crontab.guru para validar a sintaxe da expressão do seu cron job.

Exemplo de tarefa Cron (à meia-noite todos os dias e com logs do dia anterior):

Para MacOS:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Para Linux e Ubuntu:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Criar conta

POST /v1/account

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Recuperar conta

GET /v1/account

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Atualizar conta

PUT /v1/account

Exemplo de solicitação:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Listar contatos

GET /v1/contacts

Em breve

Criar contato

POST /v1/contacts

Em breve

Recuperar contato

GET /v1/contacts/:id

Em breve

Atualizar contato

PUT /v1/contacts/:id

Em breve

Excluir contato

DELETE /v1/contacts/:id

Em breve

Listar calendários

GET /v1/calendars

Em breve

Criar calendário

POST /v1/calendars

Em breve

Recuperar calendário

GET /v1/calendars/:id

Em breve

Atualizar calendário

PUT /v1/calendars/:id

Em breve

Excluir calendário

DELETE /v1/calendars/:id

Em breve

Certifique-se de ter seguido as instruções de configuração do seu domínio.

Essas instruções podem ser encontradas em nossa seção de FAQ Vocês oferecem suporte para receber e-mails com IMAP?.

Listar e pesquisar mensagens

GET /v1/messages

Em breve

Criar mensagem

POST /v1/messages

Em breve

Recuperar mensagem

GET /v1/messages/:id

Em breve

Mensagem de atualização

PUT /v1/messages/:id

Em breve

Excluir mensagem

DELETE /v1/messages:id

Em breve

Listar pastas

GET /v1/folders

Em breve

Criar pasta

POST /v1/folders

Em breve

Recuperar pasta

GET /v1/folders/:id

Em breve

Atualizar pasta

PUT /v1/folders/:id

Em breve

Excluir pasta

DELETE /v1/folders/:id

Em breve

Copiar pasta

POST /v1/folders/:id/copy

Em breve

Certifique-se de ter seguido as instruções de configuração do seu domínio.

Estas instruções podem ser encontradas em Minha conta → Domínios → Configurações → Configuração de SMTP de saída. Você precisa garantir a configuração de DKIM, Return-Path e DMARC para enviar SMTP de saída com seu domínio.

Obter limite de e-mail SMTP de saída

Este é um ponto de extremidade simples que retorna um objeto JSON contendo count e limit para o número de mensagens de saída SMTP diárias por conta.

GET /v1/emails/limit

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

Listar e-mails SMTP de saída

Observe que esse ponto de extremidade não retorna valores de propriedade para message, headers ou rejectedErrors de um e-mail.

Para retornar essas propriedades e seus valores, use o ponto de extremidade Recuperar e-mail com um ID de e-mail.

GET /v1/emails

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Criar e-mail SMTP de saída

Nossa API para criação de e-mails é inspirada e utiliza a configuração de opções de mensagem do Nodemailer. Consulte o Configuração de mensagem do Nodemailer para todos os parâmetros do corpo abaixo.

Observe que, com exceção de envelope e dkim (já que os definimos automaticamente para você), oferecemos suporte a todas as opções do Nodemailer. Definimos automaticamente as opções disableFileAccess e disableUrlAccess como true por motivos de segurança.

Você deve passar a opção única de raw com seu e-mail completo bruto, incluindo cabeçalhos ou passar opções de parâmetros de corpo individuais abaixo.

Este endpoint de API codificará automaticamente emojis para você caso eles sejam encontrados nos cabeçalhos (por exemplo, uma linha de assunto Subject: 🤓 Hello é convertida para Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automaticamente). Nosso objetivo era criar uma API de e-mail extremamente amigável ao desenvolvedor e à prova de erros.

POST /v1/emails

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Recuperar e-mail SMTP de saída

GET /v1/emails/:id

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Excluir e-mail SMTP de saída

A exclusão de e-mails definirá o status como "rejected" (e, consequentemente, não o processará na fila) se, e somente se, o status atual for "pending", "queued" ou "deferred". Podemos remover e-mails automaticamente após 30 dias da criação e/ou envio. Portanto, você deve manter uma cópia dos e-mails SMTP enviados em seu cliente, banco de dados ou aplicativo. Se desejar, você pode consultar o valor do nosso ID de e-mail em seu banco de dados. Esse valor é retornado pelos endpoints Criar e-mail e Recuperar e-mail.

DELETE /v1/emails/:id

Exemplo de solicitação:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Listar domínios

GET /v1/domains

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Criar domínio

POST /v1/domains

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Recuperar domínio

GET /v1/domains/example.com

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Verificar registros de domínio

GET /v1/domains/example.com/verify-records

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Verificar registros SMTP de domínio

GET /v1/domains/example.com/verify-smtp

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Lista senhas abrangentes de todo o domínio

GET /v1/domains/example.com/catch-all-passwords

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Criar senha abrangente para todo o domínio

POST /v1/domains/example.com/catch-all-passwords

Exemplo de solicitação:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Remover senha geral de todo o domínio

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Exemplo de solicitação:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Atualizar domínio

PUT /v1/domains/example.com

Exemplo de solicitação:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Excluir domínio

DELETE /v1/domains/:domain_name

Exemplo de solicitação:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Aceitar convite de domínio

GET /v1/domains/:domain_name/invites

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Criar convite de domínio

POST /v1/domains/example.com/invites

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Remover convite de domínio

DELETE /v1/domains/:domain_name/invites

Exemplo de solicitação:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Atualizar membro do domínio

PUT /v1/domains/example.com/members/:member_id

Exemplo de solicitação:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Remover membro do domínio

DELETE /v1/domains/:domain_name/members/:member_id

Exemplo de solicitação:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Gerar uma senha de alias

Observe que, se você não enviar instruções por e-mail, o nome de usuário e a senha estarão no corpo de resposta JSON de uma solicitação bem-sucedida no formato { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Listar aliases de domínio

GET /v1/domains/example.com/aliases

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Criar novo alias de domínio

POST /v1/domains/example.com/aliases

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Recuperar alias de domínio

Você pode recuperar um alias de domínio pelo valor id ou name.

GET /v1/domains/:domain_name/aliases/:alias_id

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Exemplo de solicitação:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Atualizar alias de domínio

PUT /v1/domains/example.com/aliases/:alias_id

Exemplo de solicitação:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Excluir alias de domínio

DELETE /v1/domains/:domain_name/aliases/:alias_id

Exemplo de solicitação:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Permitimos que você criptografe registros, mesmo no plano gratuito, sem nenhum custo. A privacidade não deve ser um recurso, mas sim inerente a todos os aspectos de um produto. Conforme altamente solicitado no Discussão sobre Guias de Privacidade e no nossos problemas no GitHub, adicionamos isso.

Criptografar registro TXT

POST /v1/encrypt

Exemplo de solicitação:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"