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 (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 – abaixo fornecemos exemplos para você caso não tenha certeza do que é isso.

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

[!DICA] Se você receber um código de status 5xx (o que não deveria acontecer), entre em contato conosco em api@forwardemail.net e nós o ajudaremos a resolver seu problema imediatamente.

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.

[!NOTA] A partir de 1º de novembro de 2024, os endpoints da API para Listar domínios e Listar aliases de domínio será o padrão para 1000 máximo de resultados por página. Se você quiser optar por esse comportamento antecipadamente, você pode passar ?paginate=true como um parâmetro de string de consulta adicional para a URL da consulta do ponto de extremidade.

A paginação é suportada por todos os endpoints de 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), então o valor mínimo é 10 e o máximo é 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):

Solicitação de exemplo:

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

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"

[!NOTA] Ao contrário de outros endpoints de API, estes requerem Autenticação "nome de usuário" igual ao nome de usuário do alias e "senha" igual à senha gerada pelo alias como cabeçalhos de Autorização Básica.

[!AVISO] Esta seção de endpoint é um trabalho em andamento e será lançada (espero) em 2024. Enquanto isso, use um cliente IMAP no menu suspenso "Aplicativos" na navegação do nosso site.

[!NOTE] O suporte a CardDAV ainda não está disponível, siga esta discussão no GitHub para atualizações.

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

[!NOTA] Ao contrário de outros endpoints de API, estes requerem Autenticação "nome de usuário" igual ao nome de usuário do alias e "senha" igual à senha gerada pelo alias como cabeçalhos de Autorização Básica.

[!AVISO] Esta seção de endpoint é um trabalho em andamento e será lançada (espero) em 2024. Enquanto isso, use um cliente IMAP no menu suspenso "Aplicativos" na navegação do nosso site.

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

[!NOTA] Ao contrário de outros endpoints de API, estes requerem Autenticação "nome de usuário" igual ao nome de usuário do alias e "senha" igual à senha gerada pelo alias como cabeçalhos de Autorização Básica.

[!AVISO] Esta seção de endpoint é um trabalho em andamento e será lançada (espero) em 2024. Enquanto isso, use um cliente IMAP no menu suspenso "Aplicativos" na navegação do nosso site.

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 perguntas frequentes Vocês oferecem suporte para receber e-mails com IMAP?.

Listar e pesquisar mensagens

GET /v1/messages

Em breve

Criar mensagem

[!NOTA] Isto irá NOT envie um e-mail – ele simplesmente adicionará a mensagem à sua pasta de caixa de correio (por exemplo, isso é semelhante ao IMAP APPEND comando). Se você quiser enviar um e-mail, veja Criar e-mail SMTP de saída abaixo. Após criar o e-mail SMTP de saída, você pode anexar uma cópia dele usando este endpoint à caixa de correio do seu alias para fins de armazenamento.

POST /v1/messages

Em breve

Recuperar mensagem

GET /v1/messages/:id

Em breve

Mensagem de atualização

PUT /v1/messages/:id

Em breve

Apagar mensagem

DELETE /v1/messages:id

Em breve

[!DICA] Pontos de extremidade de pasta com o caminho de uma pasta /v1/folders/:path como seu ponto final são intercambiáveis com o ID de uma pasta :id. Isso significa que você pode consultar a pasta por meio de seu path ou id valor.

[!AVISO] Esta seção de endpoint é um trabalho em andamento e será lançada (espero) em 2024. Enquanto isso, use um cliente IMAP no menu suspenso "Aplicativos" na navegação do nosso site.

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 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.

Obtenha limite de e-mail SMTP de saída

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

GET /v1/emails/limit

Solicitação de exemplo:

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

Listar e-mails SMTP de saída

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

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

GET /v1/emails

Solicitação de exemplo:

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

Criar e-mail SMTP de saída

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.

Este ponto de extremidade da API codificará automaticamente os emojis para você se eles forem encontrados nos cabeçalhos (por exemplo, uma linha de assunto de Subject: 🤓 Hello é convertido 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 falhas.

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 SMTP de saída

GET /v1/emails/:id

Solicitação de exemplo:

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

Excluir e-mail SMTP de saída

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:

[!DICA] Pontos de extremidade de domínio com um nome de domínio /v1/domains/:domain_name como seu ponto final é intercambiável com o ID de um domínio :domain_id. Isso significa que você pode fazer referência ao domínio por seu name ou id valor.

Listar domínios

[!NOTA] A partir de 1º de novembro de 2024, os endpoints da API para Listar domínios e Listar aliases de domínio será o padrão para 1000 máximo de resultados por página. Se você quiser optar por esse comportamento antecipadamente, você pode passar ?paginate=true como um parâmetro querystring adicional para a URL para a consulta do ponto de extremidade. Veja Paginação para mais insights.

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

[!IMPORTANTE] Se o usuário convidado já for um membro aceito de qualquer outro domínio do qual o administrador que o convidou seja membro, ele aceitará o convite automaticamente e não enviará um e-mail.

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:

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 da 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

Solicitação de exemplo:

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

Listar aliases de domínio

[!NOTA] A partir de 1º de novembro de 2024, os endpoints da API para Listar domínios e Listar aliases de domínio será o padrão para 1000 máximo de resultados por página. Se você quiser optar por esse comportamento antecipadamente, você pode passar ?paginate=true como um parâmetro querystring adicional para a URL para a consulta do ponto de extremidade. Veja Paginação para mais insights.

GET /v1/domains/example.com/aliases

Solicitação de exemplo:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -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:

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. Como altamente solicitado em um Discussão sobre guias de privacidade e assim por diante nossos problemas do GitHub nós adicionamos isso.

Criptografar registro TXT

POST /v1/encrypt

Solicitação de exemplo:

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