Class CampaignMonitor
In: lib/campaign_monitor.rb
Parent: Object

Methods

Classes and Modules

Class CampaignMonitor::Campaign
Class CampaignMonitor::Client
Class CampaignMonitor::List
Class CampaignMonitor::Result
Class CampaignMonitor::Subscriber
Class CampaignMonitor::SubscriberBounce
Class CampaignMonitor::SubscriberClick
Class CampaignMonitor::SubscriberOpen
Class CampaignMonitor::SubscriberUnsubscribe

Public Class methods

Public Instance methods

A quick method of adding a subscriber to a list. Returns a Result object

Example

 @cm = CampaignMonitor.new()
 result = @cm.add_subscriber(12345, "ralph.wiggum@simpsons.net", "Ralph Wiggum")

 if result.code == 0
   puts "Subscriber Added to List"
 end

Returns an array of Campaign objects associated with the specified Client ID

Example

 @cm = CampaignMonitor.new()
 @campaigns = @cm.campaigns(12345)

 for campaign in @campaigns
   puts campaign.subject
 end

Returns an array of Client objects associated with the API Key

Example

 @cm = CampaignMonitor.new()
 @clients = @cm.clients

 for client in @clients
   puts client.name
 end

Does an HTTP GET on a given URL and returns the response body

Returns an array of Subscriber Lists for the specified Client ID

Example

 @cm = CampaignMonitor.new()
 @lists = @cm.lists(12345)

 for list in @lists
   puts list.name
 end

By overriding the method_missing method, it is possible to easily support all of the methods available in the API

Takes a CampaignMonitor API method name and set of parameters; returns an XmlSimple object with the response

Takes a CampaignMonitor API method name and set of parameters; returns the correct URL for the REST API.

[Validate]