Mailer

This is a simple ruby application which sits and listens to a message queue for instructions to send particular email templates to the given address.

Using this app

Message format

Currently the message format expected is XML:

<sendEmail
        xmlns="http://schemas.blinkbox.com/books/emails/sending/v1"
        xmlns:r="http://schemas.blinkbox.com/books/routing/v1"
        r:originator="bookStore"
        r:instance="book-store.mobcast.co.uk"
        r:messageId="9678170f7c21-47dc-d8f3-a60f-c73e4c58">

  <template>receipt</template>

  <to>
    <!-- must contain at least one recipient element -->
    <recipient>
      <name>John Doe</name>
      <email>john.doe@example.com</email>
    </recipient>
  </to>

  <!-- cc and bcc are optional -->
  <cc>
    <!-- must contain at least one recipient element -->
    <recipient>
      <name>John Doe</name>
      <email>john.doe.alt.mail@example.com</email>
    </recipient>
  </cc>
  <bcc>
    <!-- must contain at least one recipient element -->
    <recipient>
      <name>Email Auditor</name>
      <email>email.audit@blinkbox.com</email>
    </recipient>
  </bcc>

  <templateVariables>
    <templateVariable>
      <key>salutation</key>
      <value>John</value>
    </templateVariable>

    <templateVariable>
      <key>bookTitle</key>
      <value>Moby Dick</value>
    </templateVariable>

    <templateVariable>
      <key>author</key>
      <value>Herman Melville</value>
    </templateVariable>

    <templateVariable>
      <key>price</key>
      <value>0.17</value>
    </templateVariable>
  </templateVariables>

</sendEmail>

Which produces the following hash:

{
  "template" => "receipt",
  "to" => [{ "name" => "John Doe", "email" => "john.doe@example.com" }],
  "cc" =>
    [
      { "name" => "John Doe", "email" => "john.doe.alt.mail@example.com" }],
  "bcc" =>
    [
      { "name" => "Email Auditor", "email" => "email.audit@blinkbox.com" }
    ],
  "templateVariables" =>
    { "salutation" => "John",
      "bookTitle" => "Moby Dick",
      "author" => "Herman Melville",
      "price" => "0.17" } 
    }
}

This will render the email templates welcome.erb and welcome.erb and will deliver a multipart email to the given email address.

Writing templates

Templates are named after the delivery methods defined in models.rb. Default options are set and the templates at method_name.text.erb and method_name.html.erb are rendered and delivered.

To access the variables sent in the message in a template you need to use ERB. Outputing a variable can be done with <%=@variables.name_of_variable%>, the @variables object will raise an error if the variable you're looking for isn't in the message (and thus prevent the email from being sent), so if you want to prevent this you need to rescue:

Hey there <%=(@variables.salutation rescue 'dude')%>,

Executing the app

1. Clone this repo
2. Ensure you have all the necessary gems bundle install --deployment
3. Copy the mailer.properties.production file to mailer.properties and edit to suit your set up
4. Execute the app with foreman start or by running bundle exec ruby bin/blinkbox-mailer
5. Push a message to the Emails.Outbound queue!