1. Des produits
  2.   E-mail
  3.   Ruby
  4.   Postal
 
  

API Ruby open source pour vérifier le suivi des e‑mails et le statut de livraison

Postal est une API de messagerie complète et une plateforme de livraison conçue pour gérer les e‑mails entrants et sortants pour les sites web, les applications et vérifier le suivi des e‑mails et le statut de livraison.

Qu’est-ce que la bibliothèque Postal ?

Dans le paysage numérique actuel, la communication par e‑mail efficace est plus cruciale que jamais. Que vous envoyiez des e‑mails transactionnels, des campagnes marketing ou des notifications courantes, une plateforme de livraison d’e‑mail fiable et évolutive est indispensable. Bien que des services propriétaires comme SendGrid et Mailgun dominent le marché, une alternative open‑source puissante fait sensation : Postal. Le gem Postal Ruby est une bibliothèque cliente Ruby maintenue par la communauté qui fournit une interface pour utiliser la plateforme de livraison d’e‑mail Postal. Elle permet aux applications Ruby (et Rails) de s’intégrer à Postal via son API HTTP. Elle est conçue spécialement pour les développeurs Ruby. Elle ne se contente pas d’envelopper les points de terminaison de l’API ; elle offre une interface orientée objet qui paraît naturelle dans le contexte Ruby.

Postal est une plateforme de livraison de courriels complète, riche en fonctionnalités et open source pour les sites web et les serveurs web. Considérez‑la comme votre propre SendGrid ou Mailgun privé, fonctionnant sur vos propres serveurs. Cela vous donne un contrôle total sur l’envoi de vos e‑mails, vos données et votre réputation. Développé avec Ruby et soutenu par un ensemble robuste de technologies, Postal est conçu pour la performance, l’évolutivité et la facilité d’utilisation. Il fournit une interface web complète pour gérer vos serveurs de messagerie, consulter les journaux et suivre les performances, tout en offrant une API puissante pour une intégration transparente avec vos applications.

Previous Next

Premiers pas avec Postal

Le moyen le plus simple d’installer la bibliothèque Postal est via RubyGems. Veuillez utiliser la commande suivante pour une installation facile.

Installer Postal via Rubygems

 gem install 'postal-ruby'

Envoyer un e‑mail basique via l’API Ruby

Les API Postal open source ont inclus une prise en charge complète de l'envoi de messages électroniques de diverses manières. Les développeurs Ruby peuvent envoyer des e‑mails de plusieurs façons, répondant à différents niveaux de complexité. Simple Hash est parfait pour les envois rapides avec des paramètres de base. Le texte brut et le HTML peuvent être utilisés pour envoyer des e‑mails multiparties. Il prend également en charge l'ajout de pièces jointes sans effort à vos messages électroniques, etc. L'exemple suivant montre la façon la plus simple d'envoyer un e‑mail.

Comment envoyer un e‑mail simple en utilisant l’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}"

Vérifier le suivi des e‑mails et le statut de livraison

Surveillez les ouvertures et les clics des e‑mails pour évaluer l’efficacité de vos campagnes. Les API Postal offrent une fonctionnalité complète pour suivre vos messages électroniques dans les applications Ruby. Après avoir envoyé un e‑mail, vous pouvez utiliser le message_id retourné pour vérifier son statut actuel. Surveillez les ouvertures et les clics des e‑mails pour évaluer l’efficacité de vos campagnes. L’exemple suivant montre comment vérifier le statut de livraison d’un message électronique à l’aide de commandes Ruby.

Comment vérifier le statut de livraison d’un e‑mail via l’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

Envoyer un e‑mail HTML enrichi avec une pièce jointe

Les e‑mails modernes nécessitent souvent un formatage HTML et des pièces jointes. L'API de messagerie open source Postal facilite la création et l'envoi de messages e‑mail HTML enrichis depuis leurs applications Ruby. Il est recommandé d'inclure toujours une version texte brut pour les clients de messagerie qui ne prennent pas en charge le HTML. Vous pouvez passer un tableau d'objets File pour joindre des documents, des images, etc. Voici un exemple de code très utile qui montre comment les développeurs peuvent créer et envoyer des messages e‑mail HTML avec pièces jointes en utilisant l'API Ruby.

Comment envoyer un e‑mail HTML riche avec une pièce jointe via l’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}"
 Français