/email_platform

Email simple platform to send html templates or custom html templates with panel to customize emails

Primary LanguageHTMLMIT LicenseMIT

Plataforma de Email

Esta é uma plataforma simples para enviar emails utilizando templates HTML ou templates HTML personalizados. A aplicação é orquestrada com Docker e Docker Compose e inclui um painel para personalizar os emails.

Requisitos

  • Docker
  • Docker Compose

Como Usar

Configuração Inicial

  1. Clone o repositório para sua máquina local.
  2. Navegue até o diretório do projeto.
  3. Cole o arquivo .env na raiz do projeto.
  4. Execute para construir os contêineres.
docker-compose build
  1. Execute para inicializar os contêineres.
docker-compose up

Criar uma Conta de Administrador

  1. Após a inicialização do docker-compose, abra um novo terminal.
  2. Execute para acessar o contêiner do Django.
docker exec -it django_app_email sh
  1. Dentro do contêiner, execute e siga as instruções para criar um usuário administrador.
python manage.py createsuperuser
  1. Pronto agora pode sair do terminal do contaier e desfrutar da plataforma.

Acessar a Plataforma

  1. Quando executar o container com docker-compose up uma url NGROK será informada ela que você usará.
  2. Painel de Administração: Acesse <url_ngrok>/admin para administrar a plataforma. É aqui que você pode enviar emails e gerenciar destinatários.
  • Relatórios: Acesse <url_ngrok> para ver gráficos e relatórios sobre os emails enviados.

Funcionalidades

  • Envio de emails com templates HTML pré-definidos.
  • Envio de emails com templates HTML personalizados.
  • Painel para customização de emails.
  • Gráficos e relatórios para monitorar os emails enviados.
  • Exportacao de relatório em formato CSV.

Dicas

  • Fique atento aos logs do docker.

Observações

  • A "Feature" de detectar quando um e-mail foi aberto não é possível com um e-mail comum, como o que está sendo utilizado no projeto. Para habilitar esse recurso com eficácia, é necessário configurar registros SPF, DKIM e DMARC para o domínio de e-mail utilizado. Essas configurações ajudam a verificar a legitimidade dos e-mails enviados e são especialmente importantes se você deseja manter uma boa reputação do domínio. No entanto, vale mencionar que a funcionalidade de rastreamento de abertura de e-mails já está ativa no sistema. Cada e-mail enviado contém um pixel de 1x1 para esse propósito. Quando o e-mail é aberto em um navegador, esse pixel em tese aciona uma requisição GET, registrando assim a abertura do e-mail porêm com o email registrado isso não acontece. Por razões de teste, caso queira testar o rastreamento ache o link de cada email com um simples print no link presente na função de enviar email e abra num navegador, você verá que o email será marcado como aberto.