API Ruby متن‌باز برای بررسی ردیابی ایمیل و وضعیت تحویل

شروع کار با Postal

آسان‌ترین روش برای نصب کتابخانه Postal از طریق RubyGems است. لطفاً برای نصب آسان از فرمان زیر استفاده کنید.

 gem install 'postal-ruby'

ارسال ایمیل ساده از طریق API روبی

APIهای متن باز Postal پشتیبانی کامل برای ارسال پیام‌های ایمیل به روش‌های مختلف را فراهم کرده‌اند. توسعه‌دهندگان Ruby می‌توانند ایمیل‌ها را به روش‌های متعدد ارسال کنند و به سطوح مختلف پیچیدگی پاسخ دهند. Simple Hash برای ارسال سریع با پارامترهای پایه ایده‌آل است. می‌توان از متن ساده و HTML برای ارسال ایمیل‌های چندبخشی استفاده کرد. همچنین امکان پیوست کردن فایل‌ها به پیام‌های ایمیل شما به‌راحتی فراهم می‌شود و غیره. مثال زیر ساده‌ترین روش برای ارسال یک ایمیل را نشان می‌دهد.

# 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}"

بررسی ردیابی ایمیل و وضعیت تحویل

باز کردن‌ها و کلیک‌های ایمیل را نظارت کنید تا اثربخشی کمپین‌های خود را ارزیابی کنید. APIهای Postal عملکرد کامل برای ردیابی پیام‌های ایمیل شما در برنامه‌های Ruby فراهم می‌کنند. پس از ارسال یک ایمیل، می‌توانید از message_id بازگردانده‌شده برای بررسی وضعیت فعلی آن استفاده کنید. باز کردن‌ها و کلیک‌های ایمیل را نظارت کنید تا اثربخشی کمپین‌های خود را ارزیابی کنید. مثال زیر نشان می‌دهد چگونه وضعیت تحویل پیام ایمیل را با استفاده از دستورات 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

ارسال ایمیل HTML غنی با پیوست

ایمیل‌های مدرن اغلب به قالب‌بندی HTML و پیوست‌ها نیاز دارند. API ایمیل منبع باز Postal ایجاد و ارسال پیام‌های Rich HTML Email را از برنامه‌های Ruby برای توسعه‌دهندگان نرم‌افزار آسان می‌کند. بهترین روش این است که همیشه یک نسخه متن ساده برای مشتریان ایمیلی که از HTML پشتیبانی نمی‌کنند، گنجانده شود. می‌توانید یک آرایه از اشیاء File را برای پیوست کردن اسناد، تصاویر و غیره پاس دهید. در اینجا یک نمونه کد بسیار مفید آورده شده است که نشان می‌دهد چگونه توسعه‌دهندگان نرم‌افزار می‌توانند با استفاده از Ruby API، پیام‌های ایمیل HTML را با پیوست‌ها ایجاد و ارسال کنند.

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}"