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

Provides access to the subscribers and info about subscribers associated with a Mailing List

Methods

active_subscribers   add_subscriber   bounced   new   remove_subscriber   unsubscribed  

Attributes

cm_client  [R] 
id  [R] 
name  [R] 

Public Class methods

new(id=nil, name=nil)

Example 

 @list = new List(12345)

Public Instance methods

active_subscribers(date)

Example 

 current_date = DateTime.new
 @list = new List(12345)
 @subscribers = @list.active_subscribers(current_date)

 for subscriber in @subscribers
   puts subscriber.email
 end
add_subscriber(email, name = nil)

Example 

 @list = new List(12345)
 result = @list.add_subscriber("ralph.wiggum@simpsons.net")

 if result.code == 0
   puts "Added Subscriber"
 end
bounced(date)

Example 

 current_date = DateTime.new
 @list = new List(12345)
 @subscribers = @list.bounced(current_date)

 for subscriber in @subscribers
   puts subscriber.email
 end
remove_subscriber(email)

Example 

 @list = new List(12345)
 result = @list.remove_subscriber("ralph.wiggum@simpsons.net")

 if result.code == 0
   puts "Deleted Subscriber"
 end
unsubscribed(date)

Example 

 current_date = DateTime.new
 @list = new List(12345)
 @subscribers = @list.unsubscribed(current_date)

 for subscriber in @subscribers
   puts subscriber.email
 end

[Validate]