1. Produtos
  2.   E-mail
  3.   Ruby
  4.   Postal
 
  

API Ruby de Código Aberto para Verificar Rastreamento de E‑mail e Status de Entrega

Postal é uma API de E‑mail e Plataforma de Entrega com Recursos Completos, projetada para lidar com e‑mails recebidos e enviados para sites, aplicativos e verificar o rastreamento de e‑mail e o status de entrega.

O que é a Biblioteca Postal?

No cenário digital atual, a comunicação eficaz por e‑mail é mais crucial do que nunca. Seja enviando e‑mails transacionais, campanhas de marketing ou notificações rotineiras, uma plataforma de entrega de e‑mail confiável e escalável é essencial. Embora serviços proprietários como SendGrid e Mailgun dominem o mercado, uma poderosa alternativa de código aberto está ganhando destaque: o Postal. O gem Postal Ruby é uma biblioteca cliente Ruby mantida pela comunidade que fornece uma interface para usar a plataforma de entrega de e‑mail Postal. Ela permite que aplicações Ruby (e Rails) integrem-se ao Postal via sua API HTTP. Foi projetada pensando nos desenvolvedores Ruby. Não se limita a envolver os endpoints da API; oferece uma interface orientada a objetos que parece natural dentro de um contexto Ruby.

Postal é uma plataforma completa, com todos os recursos, de entrega de e‑mail de código aberto para sites e servidores web. Pense nela como seu próprio SendGrid ou Mailgun privado, rodando em seus próprios servidores. Isso lhe dá controle total sobre o envio de e‑mails, dados e reputação. Desenvolvido com Ruby e apoiado por um conjunto robusto de tecnologias, o Postal foi projetado para desempenho, escalabilidade e facilidade de uso. Ele fornece uma interface web abrangente para gerenciar seus servidores de e‑mail, visualizar logs e acompanhar o desempenho, tudo isso oferecendo uma API poderosa para integração perfeita com suas aplicações.

Previous Next

Começando com o Postal

A maneira mais fácil de instalar a biblioteca Postal é via RubyGems. Por favor, use o comando a seguir para uma instalação simples.

Instalar o Postal via Rubygems

 gem install 'postal-ruby'

Enviando um e‑mail básico via API Ruby

As APIs open source do Postal incluíram suporte completo para o envio de mensagens de email de várias maneiras. Desenvolvedores Ruby podem enviar emails de múltiplas formas, atendendo a diferentes níveis de complexidade. Simple Hash é perfeito para envios rápidos com parâmetros básicos. Texto simples e HTML podem ser usados para enviar emails multipartes. Também oferece suporte ao anexo de arquivos de forma simples às suas mensagens de email e assim por diante. O exemplo a seguir demonstra a maneira mais simples de enviar um email.

Como enviar um e‑mail simples usando a API Ruby?

# Create a client instance
client = Postal::Client.new

# Send a message using a hash of parameters
message = client.send_message(
  from: 'noreply@yourdomain.com',
  to: 'customer@example.com',
  subject: 'Welcome to Our Service!',
  body: 'Thank you for signing up. We are excited to have you on board.'
)

# The response contains the message ID, which you can use for tracking
puts "Message sent! ID: #{message.message_id}"

Verificar o rastreamento de e‑mail e o status de entrega

Monitore aberturas e cliques de email para avaliar a eficácia de suas campanhas. As APIs do Postal fornecem funcionalidade completa para rastrear suas mensagens de email dentro de aplicações Ruby. Após enviar um email, você pode usar o message_id retornado para verificar seu status atual. Monitore aberturas e cliques de email para avaliar a eficácia de suas campanhas. O exemplo a seguir mostra como verificar o status de entrega da mensagem de email usando comandos Ruby.

Como verificar o status de entrega de mensagens de e‑mail via API Ruby?

# Assume you've stored the message_id from the send operation
stored_message_id = '01G5XYZABCDEF1234567890'

# Get the message details from Postal
message_details = client.get_message(stored_message_id)

# Check the delivery status
puts "Message Status: #{message_details.status}"

# Inspect the raw message (as received by the destination server)
puts "Raw Message: #{message_details.raw_message}"

# Check if the email has been opened
if message_details.opens.any?
  puts "The email was opened #{message_details.opens.count} time(s)."
end

Enviando um e‑mail HTML rico com um anexo

E‑mails modernos frequentemente exigem formatação HTML e anexos. A API de e‑mail Postal de código aberto facilita para desenvolvedores de software criar e enviar mensagens de e‑mail HTML rico a partir de suas aplicações Ruby. É uma prática recomendada incluir sempre uma versão em texto simples para clientes de e‑mail que não suportam HTML. Você pode passar um array de objetos File para anexar documentos, imagens, etc. Aqui está um exemplo de código muito útil que mostra como desenvolvedores podem criar e enviar mensagens de e‑mail HTML com anexos usando a API Ruby.

Como enviar um e‑mail HTML rico com anexo via API Ruby?

client = Postal::Client.new

message = client.send_message(
  from: 'orders@yourdomain.com',
  to: 'customer@example.com',
  subject: 'Your Order Confirmation #12345',
  html_body: File.read('path/to/order_confirmation.html'), # Load HTML from a file
  plain_body: 'Thank you for your order. Your order number is #12345.', # Fallback text
  attachments: [
    File.open('/path/to/invoice_12345.pdf') # Attach a file
  ]
)

puts "Rich email sent with attachment! ID: #{message.message_id}"
 Português