Simple Email Sending Client for Mailgun & Sendgrid services in crystal

Mailer

This project aims to provide a common api for popular email providers. It currently supports

  • Mailgun
  • Sendgrid

I also plan to add a wrapper for SMTP

Installation

Add this to your application's shard.yml:

dependencies:
  mailer:
    github: crisward/mailer

Usage

require "mailer"

Mailer.config(provider: Mailer::Mailgun.new(key: ENV["MAILGUN_KEY"], domain: ENV["MAILGUN_DOMAIN"]))
email = Mailer::Message.new
email.to("them@somedomain.com","their_name")
email.from = "you@yourdomain.com"
email.subject = "Hello"
email.text = "Some plain text messaeg"
email.html = "<p>Some html message <img src='cid:logo.jpg'></p>"
email.attachment = Mailer::Attachment.new(filename: "test.pdf" , path: "./spec/test.pdf")
email.inline = Mailer::Attachment.new(filename: "logo.jpg" , path: "./spec/test.png")
email.send

To use sendgrid, swap the first line to

Mailer.config(provider: Mailer::Sendgrid.new(key: "your sendgrid api key"))

Testing Your App

While testing your app, you probably won't want to send real emails. You can use the built in Mock provider for this.

# eg for kemal
if ENV["KEMAL_ENV"]? != "test"
  Mailer.config(provider: Mailer::Mailgun.new(key: ENV["MAILGUN_KEY"], domain: ENV["MAILGUN_DOMAIN"]))
else
  Mailer.config(provider:Mailer::Mock.new())
end

Development

Running tests

# mock
crystal spec

#mailgun
MAILGUN_KEY="your-api-key" MAILGUN_DOMAIN="mailgun-domain" EMAIL="your@email.com" crystal spec

#sendgrid
SENDGRID_KEY="your-api-key" EMAIL="your@email.com" crystal spec

Todo

This library isn't full baked. It works, but there are some thing which need adding

  • [ ] Error Handling
  • [ ] Logging
  • [ ] Adding SMTP option

Contributing

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

Contributors

Github statistic:
  • 12
  • 1
  • 2
  • 0
  • 4 months ago

License:

MIT License

Links: