Sign inGet Started

Visão geral do Email

Envie emails transacionais e de marketing por meio do POST /v1/email/messages. Use uma chave bk_{region}_... com o host regional correspondente: https://us1.platform.bird.com ou https://eu1.platform.bird.com. Nós assinamos a mensagem com DKIM, fazemos a entrega e reportamos o resultado de cada destinatário.
Para enviar algo antes de continuar lendo, o quickstart leva você de uma chave API a uma mensagem entregue. Esta página cobre o modelo que o restante desta seção assume, e aponta para o guia de cada parte dele.

Como o envio funciona

Um envio é aceito em uma única chamada e entregue de forma assíncrona. POST /v1/email/messages valida o payload e o domínio de envio e retorna 202 Accepted com um ID de mensagem em_. Leia o resultado de cada destinatário por meio de eventos de webhook ou dos endpoints de mensagem. Enviando e-mail cobre o payload, os limites de campos e a resposta.
Duas consequências desse modelo definem o restante desta seção.
Uma mensagem, vários destinatários, um ciclo de vida cada. Uma mensagem para cinco endereços produz cinco resultados independentes, e o status no nível da mensagem que você consulta é um agregado deles. A supressão é avaliada da mesma forma: um endereço suprimido retorna rejected enquanto os outros quatro são entregues.
Toda mensagem declara por que você a está enviando. Uma categoria transactional ou marketing decide quais supressões se aplicam a ela. Alguém que cancelou a assinatura da sua newsletter ainda precisa receber a redefinição de senha, e a categoria é o que nos diz a diferença.
Um envio também pode chegar por outra rota ou sair depois. SMTP aceita submissões de qualquer coisa que fale o protocolo, e o envio agendado retém uma mensagem até um horário que você definir.

A seção Email do dashboard

Email é um dos canais na barra lateral do dashboard. Suas páginas, na ordem em que aparecem:
PáginaO que contém
OnboardingUm checklist de três etapas: criar uma chave API, enviar um e-mail, adicionar seu domínio. Ele aparece até você concluí-lo
MetricsTaxas de entrega, abertura, bounce e reclamação ao longo do tempo; veja Métricas de e-mail
EmailsTodas as mensagens enviadas; veja o log de e-mail. A aba Receiving lista o que chegou
MailboxesCaixas de entrada programáveis que seu código lê e responde; veja Agent mailboxes
TemplatesConteúdo reutilizável de assunto e corpo, com versões de rascunho e publicada; veja Templates de e-mail
DomainsSeus domínios de envio, registros DNS e status de verificação em tempo real; veja Domínios de envio
IP PoolsIPs dedicados e os pools em que estão; veja IPs dedicados e pools
BroadcastsUm e-mail para uma audiência armazenada, com entrega rastreada por destinatário; veja Broadcasts
SuppressionsEndereços para os quais não enviamos e o motivo; veja Supressões
Unsubscribe pageIdentidade visual da página hospedada para a qual todo e-mail de marketing aponta; veja Links de cancelamento de assinatura
SMTPConfigurações de conexão, padrões de envio por chave e conexões ativas; veja SMTP
Os destinatários ficam fora da seção Email, em Contacts na barra lateral: All contacts armazena pessoas com propriedades personalizadas tipadas (veja Contatos), e Audiences os agrupa em listas reutilizáveis para as quais um broadcast envia (veja Audiências).

Onde cada guia se encaixa

Envio. Enviando e-mail é o primeiro a ler: ele define o payload do qual todo outro caminho de envio é uma variação. A partir dele, templates armazenam conteúdo que você reutiliza, anexos adicionam arquivos, envio em lote submete até 100 mensagens em uma solicitação, e broadcasts enviam um e-mail para uma audiência inteira.
Domínios e autenticação. Domínios de envio cobre o registro de um domínio e sua verificação. DKIM, SPF e DMARC explica o que cada registro comprova para o provedor de caixa de entrada receptor, e BIMI exibe seu logo ao lado das suas mensagens em aplicativos de e-mail compatíveis.
Reputação. Supressões é a lista de endereços para os quais paramos de enviar, preenchida automaticamente a partir de hard bounces e reclamações; cancelamentos de assinatura interrompem a entrega da mesma forma, mas por preferência declarada em vez de um registro de supressão. IPs dedicados e pools e Aquecimento de IP cobrem o envio a partir de endereços IP que somente a sua organização usa. Entregabilidade de e-mail conecta tudo isso.
Saber o que aconteceu. O log de e-mail mostra uma mensagem e sua linha do tempo por destinatário. Métricas de e-mail agrega seu tráfego. Eventos é o vocabulário de eventos e como webhooks os entregam ao seu próprio endpoint.
Recebimento. Recebendo e-mail cobre as duas formas de entrada: um endereço de encaminhamento que geramos sem necessidade de DNS, ou registros MX em um subdomínio seu. Agent mailboxes se baseia nisso com caixas de entrada das quais seu código também envia.
Testes. O mail sandbox exercita sua integração de ponta a ponta sem entregar em lugar nenhum. Envie para bounce@messagebird.dev para gerar um hard bounce pelo pipeline real de eventos e webhooks. O teste não grava nada na sua lista de supressão.
Para migrar e-mail de produção de outro provedor, siga o guia de migração. Ele cobre mapeamento de solicitações, DNS, supressões, webhooks, testes em sandbox e transferência de tráfego.