Open Source Ruby API For Build Email Automation Apps

Getting Started with MailyHerald

The easiest way to install the MailyHerald library is via RubyGems. Please use the following command for easy installation.

 gem install maily_herald

Creating Email Sequences via Ruby

The open source MailyHerald library provides software developers the capability to build complex email sequences with precise timing inside Ruby applications. A series of emails sent in a defined order with specific delays, ideal for onboarding processes. Moreover, it offers a streamlined and developer-friendly approach to managing email notifications in Ruby applications. The following example demonstrates, how to create complex email sequences using Ruby commands.

MailyHerald.sequence(:onboarding) do |sequence|
  sequence.title = "User Onboarding Sequence"
  sequence.list = :all_users
  sequence.start_at = "user.created_at"
  
  # Welcome email (immediately)
  sequence.add_emails do |email|
    email.title = "Welcome Email"
    email.subject = "Welcome to Our App!"
    email.absolute_delay = 0.hours
    email.template = "Hi {{user.name}}, thanks for joining us!"
  end

  # Follow-up (3 days later)
  sequence.add_emails do |email|
    email.title = "Getting Started Guide"
    email.subject = "Here's how to get the most from our app"
    email.absolute_delay = 3.days
  end
end

Create Event-based Triggers via Ruby

Emails can be triggered by application events, making it perfect for user onboarding or activity-based messaging. The open source MailyHerald library has provided complete support for creating and managing event-based email triggers inside Ruby applications. Here is a simple example that demonstrates how software developers can define an event-triggered sequence using Ruby commands.

MailyHerald.sequence(:abandoned_cart) do |sequence|
  sequence.title = "Abandoned Cart Reminders"
  sequence.list = :shopping_users
  sequence.trigger = :cart_updated
  
  sequence.add_emails do |email|
    email.title = "1 Hour Reminder"
    email.subject = "Your cart is waiting!"
    email.absolute_delay = 1.hour
    email.conditions = "{{user.cart.items.count}} > 0"
  end
end

Dynamic Email Templates Handling via Ruby

One of the standout features of open source MailyHerald library is its powerful templating system. Developers can define email templates with placeholders for dynamic content. This means you can create a single template for a specific type of notification and then populate it with user-specific details like names, order numbers, and purchased items at runtime. This significantly reduces redundancy and makes template updates much easier. Here is a simple example that shows how to use Liquid Templates to send email inside Ruby applications.

config.ad_hoc_mailing :welcome do |mailing|
  mailing.list = :newsletters
  mailing.subject = "Welcome, {{user.name}}!"
  mailing.template = "We're glad to have you on board."
  mailing.enable
end

Flexibility and Extensibility

While the MailyHerald library provides a solid foundation, it's also designed to be extensible. Developers can integrate it with various email delivery services (like SendGrid, Mailgun, or even standard SMTP) and customize its behavior to fit specific project requirements.