hailgun: Mailgun REST api interface for Haskell.

[ library, mit, network ] [ Propose Tags ]

Mailgun is an online service that sends emails. It is a great point of integration for many SaaS services and this Haskell library cleanly interfaces with Mailgun so that you can send emails from your Haskell applications.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.1.0, 0.2.0.0, 0.2.1.0, 0.3.0.0, 0.4.0.0, 0.4.0.1, 0.4.0.2, 0.4.0.3, 0.4.0.4, 0.4.0.5, 0.4.1.0, 0.4.1.1, 0.4.1.2, 0.4.1.3, 0.4.1.4, 0.4.1.5, 0.4.1.6, 0.4.1.7, 0.4.1.8, 0.4.2
Dependencies aeson (==0.7.*), base (==4.6.*), bytestring (>=0.9 && <=0.11), configurator (==0.3.*), email-validate (==2.0.*), hailgun, http-client (==0.3.*), http-client-tls (==0.2.*), http-types (==0.8.*), text (==0.11.*), transformers (==0.3.*) [details]
License MIT
Copyright (c) 2014 Robert Massaioli
Author Robert Massaioli
Maintainer robertmassaioli@gmail.com
Category Network
Uploaded by RobertMassaioli at Tue Jul 15 13:53:45 UTC 2014
Distributions LTSHaskell:0.4.2, NixOS:0.4.2
Executables hailgun-send
Downloads 7876 total (189 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Successful builds reported [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hailgun-0.1.0.0

[back to package description]

Hailgun

The hailgun library is a Haskell library that integrates with Mailgun. Mailgun is a service that allows controlled sending of emails. The intial focus of the API is on sending emails rather than recieving them.

This library was implimented based upon the information provided on the Mailgun API Reference. The goal of this library is match this API 1-1.

Building this library

This library just uses cabal to build itself. To do so for development then follow the following steps:

cabal sandbox init
cabal install --only-dependencies
cabal build

At that point in time you should have a working version of the library so you could run the example hailgun-send command by:

cabal run hailgun-send -- --help

And you can continue trying this libary from here.

Trying this library

You probably want to know that this library works to prove that it would be a good choice for your project. Follow these steps to get started with the library and Mailgun and send a test email:

  1. Sign up for Mailgun.
  2. Mailgun will give you options to use Curl to send emails to yourself right after signup. You should do so to test that your account works. (Optional)
  3. Grab the sandbox domain that was generated and the API key by visiting the Mailgun control panel.
  4. Create a file caled hailgun.send.conf in the current directory and put the API Key and the mailgun sandbox domain in the file. You can copy the hailgun.send.conf.default file to see the correct format.
  5. Now you may use hailgun-send to send emails by passing in the correct command line arguments. You can see the command line argument options with cabal run hailgun-send -- --help

If you are lucky this has only taken you a few minutes to get working and you are now sending emails through the Mailgun API from the terminal.