Mailjet is an email platform for teams to send transactional & marketing emails. It is a GDPR compliant and ISO 27001 certified Email Service Provider.

This is the unofficial Crystal shard for Mailjet. The majority of the API is covered, but some parts still need to be added.

To use the Mailjet API client, you will need a free Mailjet account.

1. Add the dependency to your shard.yml:

dependencies:
  mailjet:
    github: wout/mailjet.cr

2. Run shards install

require "mailjet"

Mailjet.configure do |settings|
  settings.api_key = "your-api-key"
  settings.secret_key = "your-secret-key"
  settings.default_from = "[email protected]"
end

response = Mailjet::SendV3_1.message({
  From: {
    Email: "[email protected]",
    Name:  "Me",
  },
  To: [
    {
      Email: "[email protected]",
      Name:  "You",
    },
  ],
  Subject:  "My first Mailjet Email!",
  TextPart: "Greetings from Mailjet!",
  HTMLPart: <<-HTML
    <h3>
      Dear passenger 1, welcome to
      <a href='https://www.mailjet.com/'>Mailjet</a>!
    </h3>
    <br />
    May the delivery force be with you!
  HTML
})

puts response.status
# => "success"

response = Mailjet::SendV3_1.messages([
  {...},
  {...}
])

puts response.first.status
# => "success"

Now, let’s view the status of the sent message and its configuration specifics.

message = Mailjet::Message.find(576460754655154659)
puts message.status
# => "opened"

You can track important events linked to the sent emails, for example whether the recipient opened the message, or clicked on a link within.

events = Mailjet::Messagehistory.all(576460754655154659)
puts events.first.event_type
# => "sent"
puts events.last.event_type
# => "opened"

The Mailjet API also has a variety of resources that help retrieve aggregated statistics for key performance indicators like opens, clicks, unsubscribes, etc.

Let's take a look at just one of those resources to give you a sample of the data you can read - we’ll retrieve total aggregated statistics for your API key.

counters = Mailjet::Statcounters.by_api_key({
  counter_timing:     "event",
  counter_resolution: "hour",
  from_ts:            Time.local.at_beginning_of_day.to_unix,
  to_ts:              Time.local.to_unix,
})
puts counters.first.event_opened_count
# => 28

Mailjet.temp_config(api_version: Mailjet::Api::V3_1) do
  # ... do something ...
end

If you want to use this shard in a Lucky app, you can use the carbon_mailjet_adapter.

• Shard API Docs

Most of the API is covered, but the following endpoints are not:

• All Message Events
• Bulk contact management and CSV import
• Parse
• Settings
• SMS
• Statistics (only statcounters is done)
• Webhook

1. Fork it (https://github.com/wout/mailjet.cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'feat: add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

• wout - creator and maintainer