This is the Mailgun Ruby Message utilities.
The below assumes you've already installed the Mailgun Gem. If not, go back to the master README for instructions.
There are two utilities included, Message Builder and Batch Message.
Message Builder: Allows you to build a message object by calling methods for each attribute. Batch Message: Inherits Message Builder and allows you to iterate through recipients from a list. Messages will fire after the 1,000th recipient has been added.
Here's how to use Message Builder to build your Message.
# First, instantiate the Mailgun Client with your API key
mg_client = Mailgun::Client.new("your-api-key")
mb_obj = Mailgun::MessageBuilder.new()
# Define the from address.
mb_obj.set_from_address("[email protected]", {"first"=>"Ruby", "last" => "SDK"});
# Define a to recipient.
mb_obj.add_recipient(:to, "[email protected]", {"first" => "John", "last" => "Doe"});
# Define a cc recipient.
mb_obj.add_recipient(:cc, "[email protected]", {"first" => "Sally", "last" => "Doe"});
# Define the subject.
mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
# Define the body of the message.
mb_obj.set_text_body("This is the text body of the message!");
# Set the Message-Id header, provide a valid Message-Id.
mb_obj.set_message_id("<[email protected]>")
# Or clear the Message-Id header, provide nil or empty string.
mb_obj.set_message_id(nil)
mb_obj.set_message_id('')
# Campaign and other headers.
mb_obj.add_campaign_id("My-Awesome-Campaign");
mb_obj.add_custom_parameter("h:Customer-Id", "12345");
# Attach a file and rename it.
mb_obj.add_attachment("/path/to/file/receipt_123491820.pdf", "Receipt.pdf");
# Schedule message in the future
mb_obj.set_delivery_time("tomorrow 8:00AM", "PST");
# Finally, send your message using the client
result = mg_client.send_message("sending_domain.com", mb_obj)
puts result.body.to_sHere's how to use Batch Message to easily handle batch sending jobs.
# First, instantiate the Mailgun Client with your API key
mg_client = Mailgun::Client.new("your-api-key")
# Create a Batch Message object, pass in the client and your domain.
mb_obj = Mailgun::BatchMessage.new(mg_client, "example.com")
# Define the from address.
mb_obj.set_from_address("[email protected]", {"first"=>"Ruby", "last" => "SDK"});
# Define the subject.
mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
# Define the body of the message.
mb_obj.set_text_body("This is the text body of the message!");
# Loop through all of your recipients
mb_obj.add_recipient(:to, "[email protected]", {"first" => "John", "last" => "Doe"});
mb_obj.add_recipient(:to, "[email protected]", {"first" => "Jane", "last" => "Doe"});
mb_obj.add_recipient(:to, "[email protected]", {"first" => "Bob", "last" => "Doe"});
...
mb_obj.add_recipient(:to, "[email protected]", {"first" => "Sally", "last" => "Doe"});
# Call finalize to get a list of message ids and totals.
message_ids = mb_obj.finalize
# {'[email protected]' => 1000, '[email protected]' => 15}See the official Mailgun Docs for more information.