Project

maileon

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby wrapper for Maileon email marketing software API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
~> 0.7.11
~> 2.2
~> 0.10
~> 0.2
~> 10.0
~> 3.2
~> 0.2
~> 1.4
~> 1.20

Runtime

~> 0.45.4
~> 1.8
 Project Readme

Maileon Build Status Gem Version Coverage Status

Ruby wrapper for Maileon email marketing software API.

  • Supported Ruby versions:
    • 2.2.3 (recommended)
    • 2.1.6
    • 2.0.0-p645

Installation

Add this line to your application's Gemfile:

gem 'maileon'

And then execute:

$ bundle

Or install it yourself as:

$ gem install maileon

Usage

Below API requests are currently supported by the gem:

Ping

api_key = "e30994fg0fig6t049u42j3gblgsr59043"
maileon = Maileon::API.new(api_key, true)
maileon.ping

Subscribe

api_key = "e30994fg0fig6t049u42j3gblgsr59043"
maileon = Maileon::API.new(api_key, true)
attribs = {
  :email => "subscriber@email.com"
}
body = {
  :email => "subscriber@email.com",
  :custom_fields => {
    :CUSTOM_FIELD_DEFINED_AT_MAILEON => "1"
  },
  :standard_fields => {
    :SALUTATION => "Herr",
    :GENDER => "m",
    :FIRSTNAME => "Max",
    :LASTNAME => "Mustermann",
    :LOCALE => "de_DE",
    :CITY => "Hamburg",
    :COUNTRY => "Germany",
    :ZIP => "22675",
    :ADDRESS => "Friedensallee",
    :HNR => "9"
  }
}
maileon.create_contact(attribs, body)

Unsubscribe

api_key = "e30994fg0fig6t049u42j3gblgsr59043"
maileon = Maileon::API.new(api_key, true)
attribs = {
  :email => "subscriber@email.com"
}
maileon.delete_contact(attribs)

Contributing

Bug reports, suggestions

  • File all your issues, feature requests here
  • If filing a bug report, follow the convention of Steps to reproduce / What happens? / What should happen?
  • If you're a developer, write a failing test instead of a bug report and send a Pull Request

Code

  1. Fork it ( https://github.com/[my-github-username]/maileon/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Develop your feature by concepts of TDD. Run guard in parallel to automatically run your tests
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Licence

Copyright © 2015 Interactive Pioneers GmbH. Licenced under GPLv3.