API de Email

No momento, ainda não lançamos wrappers de API, mas planejamos fazê-lo em breve. Envie um email para api@forwardemail.net se desejar ser notificado quando o wrapper da API para uma linguagem de programação específica for lançado. Enquanto isso, você pode usar essas bibliotecas recomendadas para requisições HTTP em sua aplicação, ou simplesmente usar curl como nos exemplos abaixo.

O caminho atual do URI base HTTP é: https://fe.tiamati.email.

Todos os endpoints requerem autenticação usando Autorização Básica. Suportamos dois métodos de autenticação:

Autenticação por Token API (Recomendado para a maioria dos endpoints)

Defina sua chave API como o valor "username" com uma senha vazia:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Note o dois pontos (:) após o token API – isso indica uma senha vazia no formato Basic Auth.

Autenticação por Credenciais de Alias (Para email de saída)

O endpoint Criar email SMTP de saída também suporta autenticação usando seu endereço de email alias e uma senha de alias gerada:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Este método é útil ao enviar emails de aplicações que já usam credenciais SMTP e torna a migração do SMTP para nossa API transparente.

Endpoints Somente para Alias

Os endpoints Contatos de Alias, Calendários de Alias, Mensagens de Alias e Pastas de Alias requerem credenciais de alias e não suportam autenticação por token API.

Não se preocupe – exemplos são fornecidos abaixo para você caso não saiba o que é isso.

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

Nosso serviço está traduzido para mais de 25 idiomas diferentes. Todas as mensagens de resposta da API são traduzidas para o último idioma detectado do usuário que faz a requisição API. Você pode sobrescrever isso passando um cabeçalho Accept-Language personalizado. Sinta-se à vontade para testar usando o menu de seleção de idioma no rodapé desta página.

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

Basta fornecer as propriedades da querystring 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 é 10 e o máximo é 50 (a menos que indicado de outra forma).

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Recuperar logs

Nossa API permite programaticamente que você baixe logs da sua conta. Enviar uma requisição para este endpoint processará todos os logs da sua conta e os enviará por email como um anexo (arquivo de planilha CSV comprimido com Gzip) assim que concluído.

Isso permite que você crie tarefas em segundo plano com um Cron job ou usando nosso software de agendamento de tarefas Node.js Bree para receber logs sempre que desejar. Note que este endpoint é limitado a 10 requisições por dia.

O anexo tem o formato em minúsculas 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 → Logs

GET /v1/logs/download

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Exemplo de Cron job (à meia-noite todo dia):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Note 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 todo dia e com logs do dia anterior):

Para MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/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://fe.tiamati.email/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Criar conta

POST /v1/account

Exemplo de Requisição:

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

Recuperar conta

GET /v1/account

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Atualizar conta

PUT /v1/account

Exemplo de Requisição:

curl -X PUT https://fe.tiamati.email/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

Por favor, certifique-se de que você seguiu as instruções de configuração para seu domínio.

Estas instruções podem ser encontradas na seção FAQ Você suporta receber email com IMAP?.

Listar e buscar mensagens

GET /v1/messages

Em breve

Criar mensagem

POST /v1/messages

Em breve

Recuperar mensagem

GET /v1/messages/:id

Em breve

Atualizar mensagem

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

Por favor, certifique-se de que você seguiu as instruções de configuração para 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.

Obter limite de email SMTP de saída

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

GET /v1/emails/limit

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Listar emails SMTP de saída

Observe que este endpoint não retorna valores das propriedades do message, headers nem rejectedErrors de um email.

Para retornar essas propriedades e seus valores, use o endpoint Recuperar email com um ID de email.

GET /v1/emails

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Criar email SMTP de saída

Nossa API para criar um email é inspirada e utiliza a configuração de opções de mensagem do Nodemailer. Por favor, consulte a 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 configuramos automaticamente para você), suportamos todas as opções do Nodemailer. Definimos automaticamente as opções disableFileAccess e disableUrlAccess como true por motivos de segurança.

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

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

Autenticação: Este endpoint suporta tanto autenticação por token de API quanto autenticação por credenciais de alias. Veja a seção Autenticação acima para detalhes.

POST /v1/emails

Exemplo de Requisição (Token API):

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

Exemplo de Requisição (Credenciais do Alias):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Exemplo de Requisição (Email Bruto):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Recuperar email SMTP de saída

GET /v1/emails/:id

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Excluir email SMTP de saída

A exclusão do email definirá o status para "rejected" (e subsequentemente não o processará na fila) se e somente se o status atual for um dos seguintes: "pending", "queued" ou "deferred". Podemos purgar emails automaticamente após 30 dias da sua criação e/ou envio – portanto, você deve manter uma cópia dos emails SMTP de saída em seu cliente, banco de dados ou aplicação. Você pode referenciar nosso valor de ID do email em seu banco de dados, se desejar – este valor é retornado tanto nos endpoints Criar email quanto Recuperar email.

DELETE /v1/emails/:id

Exemplo de Requisição:

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Listar domínios

GET /v1/domains

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Criar domínio

POST /v1/domains

Exemplo de Solicitação:

curl -X POST https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Verificar registros do domínio

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

Exemplo de Solicitação:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Verificar registros SMTP do domínio

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

Exemplo de Solicitação:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Listar senhas catch-all para todo o domínio

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

Exemplo de Solicitação:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Criar senha catch-all 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 catch-all para todo o domínio

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

Exemplo de Solicitação:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Atualizar domínio

PUT /v1/domains/example.com

Exemplo de Requisição:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Excluir domínio

DELETE /v1/domains/:domain_name

Exemplo de Requisição:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Aceitar convite de domínio

GET /v1/domains/:domain_name/invites

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Criar convite de domínio

POST /v1/domains/example.com/invites

Exemplo de Requisição:

curl -X POST https://fe.tiamati.email/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 Requisição:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Atualizar membro do domínio

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

Exemplo de Requisição:

curl -X PUT https://fe.tiamati.email/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 Requisição:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Gerar uma senha para apelido

Note que se você não enviar instruções por email, o nome de usuário e a senha estarão no corpo da resposta JSON de uma requisiçã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 Requisição:

curl -X POST https://fe.tiamati.email/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 Requisição:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Criar novo alias de domínio

POST /v1/domains/example.com/aliases

Exemplo de Requisição:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Recuperar alias de domínio

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

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

Exemplo de Requisição:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Exemplo de Requisição:

curl https://fe.tiamati.email/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 Requisição:

curl -X PUT https://fe.tiamati.email/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 Requisição:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Permitimos que você criptografe registros mesmo no plano gratuito sem custo. Privacidade não deve ser um recurso, deve ser inerentemente incorporada a todos os aspectos de um produto. Conforme muito solicitado em uma discussão do Privacy Guides e em nossos issues no GitHub, adicionamos isso.

Criptografar Registro TXT

POST /v1/encrypt

Exemplo de Requisição:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"