API de e-mail

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

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

Todos os endpoints exigem sua Chave API para ser definido como o valor "username" da solicitação Autorização básica cabeçalho. Não se preocupe - os exemplos são fornecidos abaixo para você, se você não tiver certeza do que é isso.

Se ocorrer algum erro, o corpo da 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 está fazendo a solicitação da API. Você pode substituir isso passando um personalizado Accept-Language cabeçalho. Sinta-se à vontade para experimentá-lo usando o menu suspenso de idiomas na parte inferior desta página.

Se você deseja ser notificado quando a paginação estiver disponível, envie um e-mail api@forwardemail.net.

Recuperar registros

Nossa API permite programaticamente que você baixe logs para sua conta. O envio de uma solicitação para esse endpoint processará todos os registros da sua conta e os enviará por e-mail como anexo (Gzip comprimido CSV arquivo de planilha) depois de concluído.

Isso permite criar trabalhos em segundo plano com um Trabalho Cron ou usando nosso Software de agendamento de tarefas Node.js Bree para receber logs sempre que desejar. Observe que esse 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 email contém um breve resumo dos logs recuperados. Você também pode baixar logs a qualquer momento em Minha conta → Registros

GET /v1/logs/download

Solicitação de exemplo:

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

Exemplo de Cron job (à 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 Cron job (à meia-noite todos os dias e com registros 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

Solicitação de exemplo:

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

Recupere a conta

GET /v1/account

Solicitação de exemplo:

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

Atualizar conta

PUT /v1/account

Solicitação de exemplo:

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

Verifique se você seguiu 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 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.

Listar e-mails

Observe que este endpoint não retorna um e-mail já criado message, headers, accepted, nem rejectedErrors propriedades.

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

Este endpoint retornará no máximo 50 resultados de cada vez. Se você quiser consultar várias páginas, anexe ?page=NUMBER onde NUMBER é um número inteiro, por ex. ?page=1.

GET /v1/emails

Solicitação de exemplo:

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

Criar e-mail

Nossa API para criar um e-mail é inspirada e aproveita a configuração de opção de mensagem do Nodemailer. Por favor, adie para o Configuração de mensagem do Nodemailer para todos os parâmetros corporais abaixo.

Note que com exceção de envelope e dkim (uma vez que os definimos automaticamente para você), oferecemos suporte a todas as opções do Nodemailer. Nós definimos automaticamente disableFileAccess e disableUrlAccess opções para true para fins de segurança.

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

POST /v1/emails

Solicitação de exemplo:

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"

Solicitação de exemplo:

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

Recuperar e-mail

GET /v1/emails/:id

Solicitação de exemplo:

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

Excluir e-mail

A exclusão de e-mail definirá o status como "rejected" (e subsequentemente não processá-lo na fila) se e somente se o status atual for um dos "pending", "queued", ou "deferred". Podemos limpar e-mails automaticamente após 30 dias após terem sido criados e/ou enviados - portanto, você deve manter uma cópia dos e-mails SMTP de saída em seu cliente, banco de dados ou aplicativo. Você pode fazer referência ao nosso valor de ID de e-mail em seu banco de dados, se desejar - esse valor é retornado de ambos Criar e-mail e Recuperar e-mail pontos de extremidade.

DELETE /v1/emails/:id

Solicitação de exemplo:

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

Listar domínios

GET /v1/domains

Solicitação de exemplo:

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

Criar domínio

POST /v1/domains

Solicitação de exemplo:

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

Solicitação de exemplo:

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

Verificar registros de domínio

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

Solicitação de exemplo:

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

Atualizar domínio

PUT /v1/domains/example.com

Solicitação de exemplo:

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

Excluir domínio

DELETE /v1/domains/:domain_name

Solicitação de exemplo:

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

Solicitação de exemplo:

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

Criar convite de domínio

POST /v1/domains/example.com/invites

Solicitação de exemplo:

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

Solicitação de exemplo:

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

Solicitação de exemplo:

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

Solicitação de exemplo:

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

Listar aliases de domínio

GET /v1/domains/example.com/aliases

Solicitação de exemplo:

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

Crie um novo alias de domínio

POST /v1/domains/example.com/aliases

Solicitação de exemplo:

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 por seu id ou seu name valor.

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

Solicitação de exemplo:

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

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

Solicitação de exemplo:

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

Atualizar alias do domínio

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

Solicitação de exemplo:

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

Excluir alias do domínio

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

Solicitação de exemplo:

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