Documentação
Tudo o que você precisa para começar com o BgLetter - da conexão da sua própria caixa de e-mail e da lista de destinatários em arquivo CSV ao rastreamento e à API REST.
Veja em ação



Primeiros passos
O BgLetter é um Channel: uma ferramenta com a qual você envia e-mails pela sua própria caixa de e-mail (bring-your-own-SMTP). O envio passa pelo seu servidor de e-mail, você continua sendo o remetente e a reputação de remetente continua sendo sua - não fornecemos infraestrutura de envio nem cobramos por e-mail.
Sua lista de destinatários fica com você: os destinatários vêm de um arquivo CSV, a cada envio. Não há gestão de contatos - nem listas salvas, nem segmentos, nem formulários de inscrição. E os dados de que um envio precisa são excluídos no máximo após 30 dias (veja Conservação e exclusão).
Pronto em quatro passos
- Crie uma conta. Cadastre-se gratuitamente em /register.
- Conecte a sua própria caixa de e-mail. Informe as credenciais do seu servidor de e-mail (veja «Conectar SMTP»).
- Crie o conteúdo. Escreva o seu e-mail no criador de blocos ou no editor de código.
- Envie a lista de destinatários e dispare. Carregue o arquivo CSV deste envio e envie imediatamente ou agende.
A oferta destina-se exclusivamente a empresas e a outros usuários comerciais ou institucionais, e não a consumidores.
Conectar SMTP
Em Contas de remetente você cadastra uma ou mais contas de envio. O BgLetter traz predefinições de provedor pré-configuradas que preenchem o host, a porta e a criptografia (p. ex. Gmail/Google Workspace, Microsoft 365, Brevo, SendGrid, Mailgun, Postmark). Em alguns provedores (p. ex. Amazon SES e all-inkl/KAS), você informa o host manualmente, pois ele varia conforme a região ou o pacote.
Configurações típicas
Host: smtp.seudominio.com
Porta: 587 (STARTTLS) ou 465 (SSL/TLS)
Usuário: envio@seudominio.com
Senha: •••••••• (recomenda-se senha de aplicativo)
Remetente: "Seu Nome" <newsletter@seudominio.com>Após salvar, você pode iniciar uma conexão de teste. O BgLetter informa se o login e a criptografia estão funcionando.
Entregabilidade (SPF / DKIM / DMARC)
Se seus e-mails chegam depende, acima de tudo, da sua configuração de DNS. Três registros são fundamentais:
| Registro | Finalidade | Exemplo (TXT) |
|---|---|---|
| SPF | Determina quais servidores podem enviar em seu nome. | v=spf1 include:_spf.seuprovedor.com -all |
| DKIM | Assina os e-mails de forma criptográfica - os destinatários verificam a autenticidade. | selector._domainkey → v=DKIM1; k=rsa; p=… |
| DMARC | Define como lidar com as verificações que não passam. | v=DMARC1; p=quarantine; rua=mailto:dmarc@seudominio.com |
Em resumo: o SPF autoriza servidores, o DKIM comprova a autenticidade e o DMARC diz aos destinatários o que fazer em caso de falsificações. Juntos, os três aumentam consideravelmente a taxa de entrega.
Destinatários e envio
Os destinatários vêm de um arquivo CSV, a cada envio. Você carrega o arquivo no editor, associa as colunas e envia. Não há listas salvas, nem segmentos, nem formulários de inscrição: a sua lista de destinatários fica com você e o arquivo original permanece no seu computador.
Estrutura do arquivo CSV
A primeira linha é a linha de cabeçalho com os nomes das colunas. Vírgula e ponto e vírgula são os separadores mais comuns; salve o arquivo em UTF-8 para preservar os acentos.
| Coluna | Obrigatória | Descrição |
|---|---|---|
| Sim. O endereço do destinatário. A coluna é detectada pela linha de cabeçalho. | {{EMAIL}} | |
| Nome | Opcional. O nome do destinatário para a saudação personalizada. | {{NAME}} |
| Campos próprios | Opcional. Qualquer outra coluna pode ser usada como marcador no assunto e no conteúdo. | {{FATURA}} |
| Idioma | Opcional. Define qual versão de idioma cada destinatário recebe em um envio multilíngue. | pt · pt-BR · Português |
| País | Opcional. Usado como alternativa para atribuir o idioma quando não há coluna de idioma. | BR · Brasil |
Email;Nome;Fatura;Idioma;Pais
anna@example.com;Anna Berger;R-2041;de;DE
paul@example.org;Paul Vetter;R-2042;fr;FRAs colunas podem ter qualquer nome: após o carregamento, você escolhe no editor qual coluna contém o endereço de e-mail, qual contém o nome e qual contém o idioma ou o país. Há um arquivo de exemplo no editor em «Como deve ser o CSV?».
Duplicatas e lista de supressão
- As duplicatas são unificadas automaticamente: se o mesmo endereço aparecer várias vezes no arquivo, ele recebe apenas uma mensagem - vale a primeira linha com os seus valores de personalização. A comparação não diferencia maiúsculas de minúsculas.
- As linhas incompletas, sem endereço ou com um endereço claramente inválido, são descartadas antes do envio.
- A lista de supressão vale sempre. Os endereços da sua lista de cancelamentos são ignorados automaticamente em todos os envios - você não precisa limpar o arquivo CSV antes.
Envio
- Prévia para computador e celular - com dados de exemplo da primeira linha do seu arquivo CSV.
- Personalização por meio de marcadores como {{NAME}}, {{EMAIL}} e as suas próprias colunas.
- Um link de cancelamento é inserido automaticamente - obrigatório e bom para a reputação.
- O envio ocorre de forma controlada pela sua própria caixa de e-mail, para respeitar os limites dela.
Em Modo de envio você escolhe uma de três velocidades: Entrega segura (máxima confiabilidade, recomendado), Velocidade média (equilibrado) ou Velocidade rápida (apenas para caixas com limites de envio generosos). O BgLetter distribui o envio automaticamente para que e-mails ao mesmo provedor não se sigam muito de perto - não são necessárias configurações manuais de intervalo, e envios com falha temporária são repetidos automaticamente até duas vezes. Você envia imediatamente ou de forma agendada em um horário escolhido.
No envio imediato, você acompanha o progresso ao vivo e pode pausar, retomar ou cancelar o envio em andamento. O rastreamento de aberturas e cliques fica sempre ativo.
Cancelamentos / lista de supressão
A gestão de cancelamentos é a sua lista de supressão central: todo endereço listado aqui é ignorado de forma confiável em todos os envios - mesmo que ainda conste no seu arquivo CSV. Quando um destinatário clica no link de cancelamento - inclusive pelo cancelamento com um clique (list-unsubscribe) direto na caixa de entrada - ele aparece aqui imediatamente.
A partir do plano Pro, um item de menu próprio Cancelamentos abre a página; você também pode acessar diretamente pelo endereço /app/unsubscribes.
- Adicionar: insira endereços manualmente (um por linha), com um motivo da lista: Manual, Reclamação, Não entregável (rejeição) ou Outros.
- Importar: importe listas de supressão existentes como arquivo CSV ou de texto.
- Exportar: baixe a lista completa como CSV (e-mail, motivo, data).
A lista de supressão é o único conjunto de dados armazenado de forma permanente. Isso é uma exigência legal: só assim um cancelamento continua valendo além de um envio isolado, mesmo que o mesmo endereço reapareça em um arquivo CSV meses depois.
Conservação e exclusão
O BgLetter armazena o mínimo possível e pelo menor tempo possível. Para cada envio vale um prazo fixo: no máximo 30 dias após o envio, os dados relacionados a ele são excluídos automaticamente. Isso acontece sem qualquer ação sua e não pode ser prorrogado.
O que é excluído após 30 dias
- Os endereços dos destinatários do arquivo CSV carregado.
- Os dados de personalização - nomes e todas as demais colunas do seu arquivo.
- O conteúdo da mensagem do envio (texto, HTML, blocos, traduções).
- Os eventos de rastreamento - aberturas e cliques individuais, com horário e vínculo ao destinatário.
O que permanece
- A linha de assunto e o momento do envio.
- Números anônimos: quantidade de destinatários, enviados, falhados, taxa de entrega, bem como aberturas e cliques como totais - sem vínculo com pessoas específicas.
- A lista de cancelamentos (lista de supressão). Ela permanece de forma permanente, pois do contrário um cancelamento deixaria de valer após 30 dias.
Rascunhos e modelos
Também os rascunhos não alterados são excluídos 30 dias após a última modificação. Por isso, conteúdos que você quer manter e reutilizar pertencem a um modelo: os modelos não dependem de nenhum envio e permanecem até que você mesmo os exclua.
Menos dados armazenados significa menos coisas que podem se perder. O prazo não é uma limitação, mas a razão pela qual a sua lista de destinatários nunca fica permanentemente conosco.
Mensagens (transacionais)
Pela seção Mensagens você envia e-mails transacionais individuais - como faturas, lembretes de pagamento, comprovantes de pagamento, lembretes de compromisso, confirmações de pedido ou notificações - para um único destinatário pela sua própria conta de remetente. As mensagens estão disponíveis em todos os planos (inclusive o Free).
Para pagamentos, o construtor traz dois blocos: o botão de pagamento (um link de pagamento como modelo - PayPal.Me, PayPal Checkout, Stripe Payment Link ou qualquer URL própria; variáveis como {{AMOUNT}} ou {{INVOICE_NUMBER}} são inseridas por destinatário no envio, valores no formato com ponto como 12.50) e o código QR SEPA (Girocode): os destinatários o escaneiam com o app do banco e recebem uma transferência pré-preenchida com IBAN, valor e referência - sem nenhum provedor de pagamentos. Os dois blocos já vêm preparados nos modelos “Fatura” e “Lembrete de pagamento” e só são enviados quando estão configurados (URL ou IBAN).
- Modelos para os casos mais comuns (fatura, lembrete de pagamento, comprovante, lembrete de compromisso, confirmação de pedido, notificação).
- Anexos: até 10 arquivos com no máx. 10 MB no total (p. ex. uma fatura em PDF).
- Personalização por meio de {{NAME}} e {{EMAIL}}.
- Rastreamento de aberturas opcional por mensagem.
POST /api/v1/messages (a partir do Pro).Editor e criador de blocos
Você compõe as newsletters no editor, que oferece dois modos: o criador de blocos (blocos por arrastar e soltar, com formatação em linha: selecione o texto e altere o tamanho, a cor, o negrito, etc. diretamente) e o editor de código para o seu próprio HTML. O criador de blocos gera um código de e-mail que é exibido de forma confiável no Outlook, no Gmail e no Apple Mail.
Blocos disponíveis
- Texto, botão e imagem para o conteúdo.
- Colunas (2, 3 ou 4), separador e espaçamento para o layout.
- Redes sociais e um bloco HTML para os seus próprios trechos.
Tradução com IA
No editor, você traduz o assunto e o conteúdo para até 36 idiomas com um clique. Você escolhe o idioma de origem, o tratamento (formal ou informal) e os idiomas de destino desejados. Marcadores como {{NAME}} são mantidos.
Para o envio multilíngue, cada destinatário recebe a variante de idioma adequada: se o seu arquivo CSV contiver uma coluna de idioma (p. ex. «Idioma») ou de país (p. ex. «País»), a tradução correta é enviada por destinatário automaticamente - caso contrário, a versão de origem.
Você não precisa traduzir com antecedência: cada idioma detectado entre os seus destinatários é traduzido automaticamente no início do envio (status «A traduzir») - a entrega só começa quando todas as versões estão prontas.
Como funciona a atribuição de idioma: a coluna pode ter qualquer nome; após o carregamento, você escolhe qual coluna contém o idioma. São reconhecidos: códigos de idioma (de, deu, ger), locales (de-DE, en-US), nomes de idioma (Deutsch, German) e nomes e códigos de país (Deutschland, Germany, DE, AT). Valores vazios ou desconhecidos recebem a versão original. A coluna continua utilizável como marcador.
Rastreamento
O BgLetter registra aberturas e cliques por envio. Na análise, você vê a taxa de abertura e de cliques e os links mais clicados.
Os eventos individuais ficam vinculados a um destinatário apenas enquanto o envio existir - no máximo 30 dias após o envio eles são excluídos. Depois disso restam apenas os totais anônimos (veja Conservação e exclusão).
Envios e relatórios
Em Campanhas e estatísticas você encontra todos os envios com data, assunto, status, número de destinatários, enviados, falhados e a taxa de entrega (enviados ÷ total de destinatários). Os mais recentes ficam no topo. Pelo ícone de olho você abre o relatório.
O relatório mostra no topo os números principais, incluindo aberturas e cliques, além de uma barra de «Progresso do envio». O cartão Reações dos destinatários apresenta as aberturas e os cliques como únicos e totais e calcula a taxa de cliques (CTR) a partir dos cliques únicos por abertura única. Uma tabela lista os links mais clicados com cliques e cliques únicos.
- Tabela de destinatários: por destinatário, o e-mail, o provedor de e-mail, o nome, o status e - em caso de falha - a mensagem de erro SMTP exata, além do horário de envio. Essa tabela fica disponível por 30 dias.
- Filtros: Todos, Enviados, Falhados, Pendentes.
- Exportação CSV: «Exportar como tabela (CSV)» baixa todos os destinatários, independentemente do filtro ativo. Exporte a tempo, enquanto os dados ainda existirem.
Na visão geral não há exclusão manual - e nem é preciso: após 30 dias, o BgLetter remove por conta própria os dados dos destinatários, o conteúdo e os eventos de rastreamento. O assunto e os números anônimos permanecem como histórico.
API REST (visão geral)
Para integrações, o BgLetter oferece uma API REST. Você gera chaves de API na área de desenvolvedores da sua conta. A autenticação é feita por um token bearer no cabeçalho.
# Enviar uma mensagem transacional
curl -X POST https://bgletter.com/api/v1/messages \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{ "to": "cliente@example.com", "subject": "Sua fatura", "html": "<p>Olá …</p>" }'A URL base é <seu-dominio>/api/v1; a autenticação é feita por Authorization: Bearer bgl_… ou X-Api-Key: bgl_…. Estão disponíveis endpoints para mensagens transacionais (POST /api/v1/messages), para a lista de cancelamentos e endpoints de leitura para conta e envios. A especificação completa está em /api/v1/openapi.json.
- Idempotência: um cabeçalho
Idempotency-Keyno envio de mensagens evita a entrega duplicada em novas tentativas. - Assinatura de webhook: cada entrega leva
X-BgLetter-Signature: sha256=…(HMAC-SHA256 sobre o corpo bruto com a sua chavewhsec_) - verifique-a antes do processamento. - Limite de requisições: 120 requisições/minuto por conta (mensagens, adicionalmente, 300/hora).
Além disso, há webhooks disponíveis para notificar seu sistema em tempo real sobre eventos (p. ex. cancelamento, rejeição). Você encontra os endpoints e exemplos de resposta na área de desenvolvedores.
Faturamento
O BgLetter cobra com um preço de plano mensal fixo - sem custo por e-mail. Os planos se diferenciam no volume de envio mensal, no número de contas de remetente e em outros limites.
- Plano Free gratuito para experimentar - sem necessidade de cartão de crédito.
- Faça upgrade quando quiser na área Faturamento. Para um plano inferior, cancele a assinatura (volta para Free no fim do período).
- Todos os preços são em euros; o faturamento é feito pela Fontemia GmbH, Grammetstr. 14, CH-4410 Liestal.
Equipe e conta
Em Administração você convida membros da equipe e atribui funções: Proprietário, Admin ou Membro. Apenas o proprietário e os admins veem a Administração; apenas o proprietário pode convidar, alterar funções e remover membros.
O número de vagas depende do plano - um segundo membro da equipe é possível a partir do plano Pro. Cada membro ativa a sua própria autenticação de dois fatores (2FA) em Configurações.
Configurações
Em Configurações você gerencia a sua conta em uma única página com cinco cartões. A senha e a autenticação de dois fatores estão disponíveis para qualquer membro; o endereço de faturamento, o branding e Dados e privacidade são reservados ao proprietário.
- Alterar senha: uma nova senha com pelo menos 8 caracteres. Alterá-la desconecta automaticamente todas as outras sessões.
- Autenticação de dois fatores: configuração por código QR; em seguida, 8 códigos de recuperação de uso único são exibidos exatamente uma vez (guarde-os com segurança - não podem ser exibidos de novo). Para desativar, é necessário um código atual do seu app.
- Endereço de faturamento: empresa, endereço e número de identificação fiscal; aparece nas suas faturas (apenas o proprietário).
- Branding: cor da marca, URL do logotipo, endereço postal e um rodapé de e-mail próprio (detalhes abaixo).
- Dados e privacidade: «Exportar meus dados (JSON)» como arquivo, além da exclusão definitiva da conta (em duas etapas, irreversível).
No Branding, a cor da marca e a URL do logotipo afetam apenas as páginas públicas que os seus destinatários veem - como a página de cancelamento -, não os e-mails enviados. Já o endereço postal (remetente) é inserido no rodapé de cada e-mail enviado - se você deixá-lo vazio, a linha de endereço fica faltando (obrigação legal conforme o § 5 TMG na Alemanha). Um rodapé de e-mail em HTML próprio está disponível a partir do plano Business.
Solução de problemas
As perguntas mais frequentes e a sua solução em um relance. A maioria dos problemas de entregabilidade se resolve em poucos minutos.
| Problema | Solução | Observação |
|---|---|---|
| Os e-mails caem no spam | Verifique o seu domínio com a verificação de entregabilidade e configure SPF, DKIM e DMARC. | SPF · DKIM · DMARC |
| O teste de SMTP falha | Use uma senha de aplicativo em vez da senha da conta e verifique o host e a porta. | Autenticação falhou |
| «Cota esgotada» | Escolha um plano superior ou aguarde a data de reinício mensal. | Cota … esgotada |
| Faltam destinatários no relatório | Endereços duplicados são unificados, os inválidos descartados e os suprimidos ignorados. Verifique a lista de cancelamentos. | Ignorado / lista de supressão |
| O relatório não está mais lá | Após 30 dias, destinatários, conteúdo e eventos de rastreamento são excluídos automaticamente; assunto e números permanecem. Exporte os relatórios a tempo. | Excluído após 30 dias |
| Um rascunho desapareceu | Rascunhos não alterados expiram após 30 dias. Salve conteúdos reutilizáveis como modelo. | Rascunho com mais de 30 dias |
| Rejeição ou reclamação | O endereço é adicionado à lista de supressão e ignorado automaticamente nos próximos envios. | Não entregável / Reclamação |
Uma função está em cinza? Então ela não está incluída no seu plano - o plano necessário aparece ao lado do botão (p. ex. «A partir do Pro»). Um upgrade na área Faturamento a desbloqueia.