API Ruby Open Source untuk Memeriksa Pelacakan Email & Status Pengiriman
Postal adalah API Surat dan Platform Pengiriman yang Lengkap, Dirancang untuk Menangani Email Masuk dan Keluar untuk Situs Web, Aplikasi, serta Memeriksa Pelacakan Email & Status Pengiriman.
Apa itu Perpustakaan Postal?
Dalam lanskap digital saat ini, komunikasi email yang efektif menjadi lebih penting daripada sebelumnya. Apakah Anda mengirim email transaksional, kampanye pemasaran, atau notifikasi rutin, platform pengiriman email yang handal dan skalabel sangat penting. Sementara layanan proprietari seperti SendGrid dan Mailgun mendominasi pasar, alternatif open-source yang kuat sedang menjadi sorotan: Postal. Gem Ruby Postal adalah perpustakaan klien Ruby yang dipelihara komunitas, yang menyediakan antarmuka untuk menggunakan platform pengiriman email Postal. Ini memungkinkan aplikasi Ruby (dan Rails) untuk terintegrasi dengan Postal melalui HTTP API-nya. Dirancang dengan mempertimbangkan pengembang Ruby. Tidak hanya membungkus endpoint API; ia menyediakan antarmuka berorientasi objek yang terasa alami dalam konteks Ruby.
Postal adalah platform pengiriman email yang lengkap, berfitur penuh, dan bersifat open-source untuk situs web dan server web. Anggaplah ini sebagai SendGrid atau Mailgun pribadi Anda, yang berjalan di server Anda sendiri. Ini memberi Anda kontrol penuh atas pengiriman email, data, dan reputasi Anda. Dikembangkan dengan Ruby dan didukung oleh rangkaian teknologi yang kuat, Postal dirancang untuk kinerja, skalabilitas, dan kemudahan penggunaan. Ia menyediakan antarmuka web yang komprehensif untuk mengelola server email Anda, melihat log, dan melacak kinerja, sekaligus menawarkan API yang kuat untuk integrasi mulus dengan aplikasi Anda.
Memulai dengan Postal
Cara termudah untuk menginstal pustaka Postal adalah melalui RubyGems. Silakan gunakan perintah berikut untuk instalasi yang mudah.
Instal Postal via Rubygems
gem install 'postal-ruby'Mengirim Email Dasar melalui Ruby API
API Postal sumber terbuka telah menyertakan dukungan lengkap untuk mengirim pesan email dalam berbagai cara. Pengembang Ruby dapat mengirim email dengan banyak cara, menyesuaikan dengan tingkat kompleksitas yang berbeda. Simple Hash sangat cocok untuk pengiriman cepat dengan parameter dasar. Teks biasa dan HTML dapat digunakan untuk mengirim email multipart. Ia juga mendukung melampirkan file dengan mudah ke pesan email Anda, dan sebagainya. Contoh berikut menunjukkan cara paling sederhana untuk mengirim email.
Cara Mengirim Email Sederhana menggunakan Ruby API?
# 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}"
Periksa Pelacakan Email & Status Pengiriman
Pantau pembukaan email dan klik untuk mengukur efektivitas kampanye Anda. API Postal menyediakan fungsionalitas lengkap untuk melacak pesan email Anda di dalam aplikasi Ruby. Setelah mengirim email, Anda dapat menggunakan message_id yang dikembalikan untuk memeriksa statusnya saat ini. Pantau pembukaan email dan klik untuk mengukur efektivitas kampanye Anda. Contoh berikut menunjukkan cara memeriksa Status Pengiriman Pesan Email menggunakan perintah Ruby.
Cara Memeriksa Status Pengiriman Pesan Email melalui Ruby API?
# 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
Mengirim Email HTML Kaya dengan Lampiran
Email modern sering memerlukan format HTML dan lampiran. API email open source Postal memudahkan pengembang perangkat lunak untuk membuat dan mengirim pesan Email HTML Kaya dari aplikasi Ruby mereka. Sebaiknya selalu menyertakan versi teks biasa untuk klien email yang tidak mendukung HTML. Anda dapat mengirimkan array objek File untuk melampirkan dokumen, gambar, dll. Berikut adalah contoh kode yang sangat berguna yang menunjukkan cara pengembang perangkat lunak dapat membuat dan mengirim pesan email HTML dengan lampiran menggunakan Ruby API.
Cara Mengirim Email HTML Rich dengan Lampiran melalui Ruby API?
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}"