Project

mailerlite

0.04
No release in over a year
Ruby gem for MailerLite API v2
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 13.0
~> 3.12
~> 0.14
~> 1.44
~> 0.22
~> 3.18

Runtime

~> 2.0, >= 2.0.1
>= 4, < 6
 Project Readme

MailerLite API v1 Ruby wrapper

A Ruby gem which helps to communicate with MailerLite API.

Gem Version Coverage Status

Installation

Add this line to your application's Gemfile:

gem 'mailerlite'

Usage

Before making any request, you should authenticate first. Use the response object to make requests afterward. See create a campaign example.

Authentication

When you sign up for an account, you are given an API key. You authenticate to the MailerLite API by providing your API key in the request. You can find your API key in page: Integrations ยป Developer API.

client = MailerLite::Client.new(api_key: 'my-secret-api-key')

Example:

client.groups

Or create file under config/initializers/mailerlite.rb

MailerLite.configure do |config|
  config.api_key = 'my-secret-api-key'
  # config.timeout = 10
end

When you configured global settings in file, then you can request methods on MailerLite class directly.

Example:

MailerLite.campaigns

See more documentation in examples directory.

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

  • Ruby 2.7.0
  • Ruby 3.0.0
  • Ruby 3.1.0
  • Ruby 3.2.0
  • Truffleruby

License

The gem is available as open source under the terms of the MIT License.