campaign_monitor 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. data/CHANGELOG +3 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README +30 -0
  4. data/TODO +3 -0
  5. data/doc/classes/CMCampaignSummary.html +170 -0
  6. data/doc/classes/CMCampaignSummary.src/M000003.html +22 -0
  7. data/doc/classes/CMClient.html +111 -0
  8. data/doc/classes/CMResult.html +155 -0
  9. data/doc/classes/CMResult.src/M000004.html +19 -0
  10. data/doc/classes/CampaignMonitor.html +355 -0
  11. data/doc/classes/CampaignMonitor.src/M000001.html +20 -0
  12. data/doc/classes/CampaignMonitor.src/M000002.html +20 -0
  13. data/doc/classes/CampaignMonitor.src/M000003.html +19 -0
  14. data/doc/classes/CampaignMonitor.src/M000004.html +20 -0
  15. data/doc/classes/CampaignMonitor.src/M000005.html +18 -0
  16. data/doc/classes/CampaignMonitor.src/M000006.html +18 -0
  17. data/doc/classes/CampaignMonitor.src/M000007.html +23 -0
  18. data/doc/classes/CampaignMonitor.src/M000008.html +23 -0
  19. data/doc/classes/CampaignMonitor.src/M000009.html +23 -0
  20. data/doc/classes/CampaignMonitor.src/M000010.html +19 -0
  21. data/doc/classes/CampaignMonitor.src/M000011.html +19 -0
  22. data/doc/classes/CampaignMonitor.src/M000012.html +18 -0
  23. data/doc/classes/CampaignMonitor.src/M000013.html +18 -0
  24. data/doc/classes/CampaignMonitor.src/M000014.html +18 -0
  25. data/doc/classes/CampaignMonitor.src/M000015.html +19 -0
  26. data/doc/classes/CampaignMonitor.src/M000016.html +18 -0
  27. data/doc/classes/CampaignMonitor.src/M000017.html +18 -0
  28. data/doc/classes/CampaignMonitor.src/M000018.html +18 -0
  29. data/doc/classes/CampaignMonitor.src/M000019.html +18 -0
  30. data/doc/classes/CampaignMonitor.src/M000020.html +18 -0
  31. data/doc/classes/CampaignMonitor.src/M000021.html +18 -0
  32. data/doc/classes/CampaignMonitor.src/M000022.html +18 -0
  33. data/doc/classes/CampaignMonitor.src/M000023.html +18 -0
  34. data/doc/classes/CampaignMonitor.src/M000024.html +29 -0
  35. data/doc/classes/CampaignMonitor.src/M000025.html +19 -0
  36. data/doc/classes/CampaignMonitor.src/M000026.html +21 -0
  37. data/doc/classes/CampaignMonitor.src/M000027.html +20 -0
  38. data/doc/classes/CampaignMonitor.src/M000028.html +19 -0
  39. data/doc/classes/CampaignMonitor.src/M000029.html +20 -0
  40. data/doc/classes/CampaignMonitor.src/M000030.html +18 -0
  41. data/doc/classes/CampaignMonitor.src/M000031.html +18 -0
  42. data/doc/classes/CampaignMonitor.src/M000032.html +23 -0
  43. data/doc/classes/CampaignMonitor.src/M000033.html +23 -0
  44. data/doc/classes/CampaignMonitor.src/M000034.html +23 -0
  45. data/doc/classes/CampaignMonitor.src/M000035.html +19 -0
  46. data/doc/classes/CampaignMonitor/Campaign.html +387 -0
  47. data/doc/classes/CampaignMonitor/Campaign.src/M000027.html +22 -0
  48. data/doc/classes/CampaignMonitor/Campaign.src/M000028.html +22 -0
  49. data/doc/classes/CampaignMonitor/Campaign.src/M000029.html +23 -0
  50. data/doc/classes/CampaignMonitor/Campaign.src/M000030.html +23 -0
  51. data/doc/classes/CampaignMonitor/Campaign.src/M000031.html +23 -0
  52. data/doc/classes/CampaignMonitor/Campaign.src/M000032.html +23 -0
  53. data/doc/classes/CampaignMonitor/Campaign.src/M000033.html +18 -0
  54. data/doc/classes/CampaignMonitor/Campaign.src/M000034.html +18 -0
  55. data/doc/classes/CampaignMonitor/Campaign.src/M000035.html +18 -0
  56. data/doc/classes/CampaignMonitor/Campaign.src/M000036.html +18 -0
  57. data/doc/classes/CampaignMonitor/Campaign.src/M000037.html +18 -0
  58. data/doc/classes/CampaignMonitor/Campaign.src/M000053.html +22 -0
  59. data/doc/classes/CampaignMonitor/Campaign.src/M000054.html +23 -0
  60. data/doc/classes/CampaignMonitor/Campaign.src/M000055.html +23 -0
  61. data/doc/classes/CampaignMonitor/Campaign.src/M000056.html +23 -0
  62. data/doc/classes/CampaignMonitor/Campaign.src/M000057.html +23 -0
  63. data/doc/classes/CampaignMonitor/Campaign.src/M000058.html +18 -0
  64. data/doc/classes/CampaignMonitor/Campaign.src/M000059.html +18 -0
  65. data/doc/classes/CampaignMonitor/Campaign.src/M000060.html +18 -0
  66. data/doc/classes/CampaignMonitor/Campaign.src/M000061.html +18 -0
  67. data/doc/classes/CampaignMonitor/Campaign.src/M000062.html +18 -0
  68. data/doc/classes/CampaignMonitor/Client.html +226 -0
  69. data/doc/classes/CampaignMonitor/Client.src/M000016.html +20 -0
  70. data/doc/classes/CampaignMonitor/Client.src/M000017.html +20 -0
  71. data/doc/classes/CampaignMonitor/Client.src/M000018.html +23 -0
  72. data/doc/classes/CampaignMonitor/Client.src/M000019.html +23 -0
  73. data/doc/classes/CampaignMonitor/Client.src/M000042.html +20 -0
  74. data/doc/classes/CampaignMonitor/Client.src/M000043.html +23 -0
  75. data/doc/classes/CampaignMonitor/Client.src/M000044.html +23 -0
  76. data/doc/classes/CampaignMonitor/List.html +308 -0
  77. data/doc/classes/CampaignMonitor/List.src/M000021.html +20 -0
  78. data/doc/classes/CampaignMonitor/List.src/M000022.html +20 -0
  79. data/doc/classes/CampaignMonitor/List.src/M000023.html +19 -0
  80. data/doc/classes/CampaignMonitor/List.src/M000024.html +19 -0
  81. data/doc/classes/CampaignMonitor/List.src/M000025.html +23 -0
  82. data/doc/classes/CampaignMonitor/List.src/M000026.html +23 -0
  83. data/doc/classes/CampaignMonitor/List.src/M000027.html +23 -0
  84. data/doc/classes/CampaignMonitor/List.src/M000047.html +20 -0
  85. data/doc/classes/CampaignMonitor/List.src/M000048.html +19 -0
  86. data/doc/classes/CampaignMonitor/List.src/M000049.html +19 -0
  87. data/doc/classes/CampaignMonitor/List.src/M000050.html +23 -0
  88. data/doc/classes/CampaignMonitor/List.src/M000051.html +23 -0
  89. data/doc/classes/CampaignMonitor/List.src/M000052.html +23 -0
  90. data/doc/classes/CampaignMonitor/Result.html +162 -0
  91. data/doc/classes/CampaignMonitor/Result.src/M000020.html +19 -0
  92. data/doc/classes/CampaignMonitor/Result.src/M000021.html +19 -0
  93. data/doc/classes/CampaignMonitor/Result.src/M000046.html +19 -0
  94. data/doc/classes/CampaignMonitor/Subscriber.html +212 -0
  95. data/doc/classes/CampaignMonitor/Subscriber.src/M000012.html +21 -0
  96. data/doc/classes/CampaignMonitor/Subscriber.src/M000013.html +21 -0
  97. data/doc/classes/CampaignMonitor/Subscriber.src/M000014.html +19 -0
  98. data/doc/classes/CampaignMonitor/Subscriber.src/M000015.html +19 -0
  99. data/doc/classes/CampaignMonitor/Subscriber.src/M000038.html +21 -0
  100. data/doc/classes/CampaignMonitor/Subscriber.src/M000039.html +19 -0
  101. data/doc/classes/CampaignMonitor/Subscriber.src/M000040.html +19 -0
  102. data/doc/classes/CampaignMonitor/SubscriberBounce.html +166 -0
  103. data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html +20 -0
  104. data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000020.html +20 -0
  105. data/doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html +20 -0
  106. data/doc/classes/CampaignMonitor/SubscriberClick.html +166 -0
  107. data/doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html +20 -0
  108. data/doc/classes/CampaignMonitor/SubscriberClick.src/M000011.html +20 -0
  109. data/doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html +20 -0
  110. data/doc/classes/CampaignMonitor/SubscriberOpen.html +166 -0
  111. data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html +20 -0
  112. data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000012.html +20 -0
  113. data/doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html +20 -0
  114. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.html +161 -0
  115. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html +19 -0
  116. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000016.html +19 -0
  117. data/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html +19 -0
  118. data/doc/classes/CampaignMonitorTest.html +137 -0
  119. data/doc/classes/CampaignMonitorTest.src/M000001.html +18 -0
  120. data/doc/classes/Hash.html +137 -0
  121. data/doc/classes/Hash.src/M000002.html +18 -0
  122. data/doc/classes/Symbol.html +143 -0
  123. data/doc/classes/Symbol.src/M000001.html +18 -0
  124. data/doc/created.rid +1 -0
  125. data/doc/files/campaign_monitor_old_rb.html +119 -0
  126. data/doc/files/init_rb.html +108 -0
  127. data/doc/files/install_rb.html +101 -0
  128. data/doc/files/lib/campaign_monitor_rb.html +184 -0
  129. data/doc/files/test/campaign_monitor_test_rb.html +101 -0
  130. data/doc/fr_class_index.html +37 -0
  131. data/doc/fr_file_index.html +28 -0
  132. data/doc/fr_method_index.html +63 -0
  133. data/doc/index.html +24 -0
  134. data/doc/rdoc-style.css +208 -0
  135. data/lib/campaign_monitor.rb +503 -0
  136. data/test/campaign_monitor_test.rb +6 -0
  137. metadata +175 -0
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 171</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
16
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
17
+ <span class="ruby-ivar">@cm_client</span> = <span class="ruby-constant">CampaignMonitor</span>.<span class="ruby-identifier">new</span>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 216</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
16
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
17
+ <span class="ruby-ivar">@cm_client</span> = <span class="ruby-constant">CampaignMonitor</span>.<span class="ruby-identifier">new</span>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>add_subscriber (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 229</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_subscriber</span>(<span class="ruby-identifier">email</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscriber_Add</span>(<span class="ruby-value str">&quot;ListID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">&quot;Email&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">email</span>, <span class="ruby-value str">&quot;Name&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>)
16
+ <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>], <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span>)
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>remove_subscriber (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 241</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove_subscriber</span>(<span class="ruby-identifier">email</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscriber_Unsubscribe</span>(<span class="ruby-value str">&quot;ListID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">&quot;Email&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">email</span>)
16
+ <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>], <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span>)
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
@@ -0,0 +1,23 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>active_subscribers (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 254</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">active_subscribers</span>(<span class="ruby-identifier">date</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscribers_GetActive</span>(<span class="ruby-value str">'ListID'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">&quot;Date&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%Y-%m-%d %H:%M:%S&quot;</span>))
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Subscriber&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;EmailAddress&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Name&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Date&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
@@ -0,0 +1,23 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>unsubscribed (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 271</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unsubscribed</span>(<span class="ruby-identifier">date</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscribers_GetUnsubscribed</span>(<span class="ruby-value str">'ListID'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">'Date'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%Y-%m-%d %H:%M:%S&quot;</span>))
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Subscriber&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;EmailAddress&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Name&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Date&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
@@ -0,0 +1,23 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>bounced (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 288</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bounced</span>(<span class="ruby-identifier">date</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscribers_GetBounced</span>(<span class="ruby-value str">'ListID'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">'Date'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%Y-%m-%d %H:%M:%S&quot;</span>))
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Subscriber&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;EmailAddress&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Name&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Date&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 173</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
16
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
17
+ <span class="ruby-ivar">@cm_client</span> = <span class="ruby-constant">CampaignMonitor</span>.<span class="ruby-identifier">new</span>
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>add_subscriber (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 179</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_subscriber</span>(<span class="ruby-identifier">email</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscriber_Add</span>(<span class="ruby-value str">&quot;ListID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">&quot;Email&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">email</span>, <span class="ruby-value str">&quot;Name&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>)
16
+ <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>], <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span>)
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>remove_subscriber (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 184</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove_subscriber</span>(<span class="ruby-identifier">email</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscriber_Unsubscribe</span>(<span class="ruby-value str">&quot;ListID&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">&quot;Email&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">email</span>)
16
+ <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>], <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span>)
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>
@@ -0,0 +1,23 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>active_subscribers (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 189</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">active_subscribers</span>(<span class="ruby-identifier">date</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscribers_GetActive</span>(<span class="ruby-value str">'ListID'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">&quot;Date&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%Y-%m-%d %H:%M:%S&quot;</span>))
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Subscriber&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;EmailAddress&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Name&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Date&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
@@ -0,0 +1,23 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>unsubscribed (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 198</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unsubscribed</span>(<span class="ruby-identifier">date</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscribers_GetUnsubscribed</span>(<span class="ruby-value str">'ListID'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">'Date'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%Y-%m-%d %H:%M:%S&quot;</span>))
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Subscriber&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;EmailAddress&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Name&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Date&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
@@ -0,0 +1,23 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>bounced (CampaignMonitor::List)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/campaign_monitor.rb, line 207</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bounced</span>(<span class="ruby-identifier">date</span>)
15
+ <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@cm_client</span>.<span class="ruby-constant">Subscribers_GetBounced</span>(<span class="ruby-value str">'ListID'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@id</span>, <span class="ruby-value str">'Date'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">&quot;%Y-%m-%d %H:%M:%S&quot;</span>))
16
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span>
17
+ <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Subscriber&quot;</span>].<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;EmailAddress&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Name&quot;</span>], <span class="ruby-identifier">s</span>[<span class="ruby-value str">&quot;Date&quot;</span>])}
18
+ <span class="ruby-keyword kw">else</span>
19
+ <span class="ruby-identifier">raise</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Code&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot; - &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">response</span>[<span class="ruby-value str">&quot;Message&quot;</span>]
20
+ <span class="ruby-keyword kw">end</span>
21
+ <span class="ruby-keyword kw">end</span></pre>
22
+ </body>
23
+ </html>
@@ -0,0 +1,162 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: CampaignMonitor::Result</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">CampaignMonitor::Result</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/campaign_monitor_rb.html">
59
+ lib/campaign_monitor.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ Encapsulates the response received from the <a
84
+ href="../CampaignMonitor.html">CampaignMonitor</a> webservice.
85
+ </p>
86
+
87
+ </div>
88
+
89
+
90
+ </div>
91
+
92
+ <div id="method-list">
93
+ <h3 class="section-bar">Methods</h3>
94
+
95
+ <div class="name-list">
96
+ <a href="#M000021">new</a>&nbsp;&nbsp;
97
+ </div>
98
+ </div>
99
+
100
+ </div>
101
+
102
+
103
+ <!-- if includes -->
104
+
105
+ <div id="section">
106
+
107
+
108
+
109
+
110
+
111
+ <div id="attribute-list">
112
+ <h3 class="section-bar">Attributes</h3>
113
+
114
+ <div class="name-list">
115
+ <table>
116
+ <tr class="top-aligned-row context-row">
117
+ <td class="context-item-name">code</td>
118
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
119
+ <td class="context-item-desc"></td>
120
+ </tr>
121
+ <tr class="top-aligned-row context-row">
122
+ <td class="context-item-name">message</td>
123
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
124
+ <td class="context-item-desc"></td>
125
+ </tr>
126
+ </table>
127
+ </div>
128
+ </div>
129
+
130
+
131
+
132
+ <!-- if method_list -->
133
+ <div id="methods">
134
+ <h3 class="section-bar">Public Class methods</h3>
135
+
136
+ <div id="method-M000021" class="method-detail">
137
+ <a name="M000021"></a>
138
+
139
+ <div class="method-heading">
140
+ <a href="Result.src/M000021.html" target="Code" class="method-signature"
141
+ onclick="popupCode('Result.src/M000021.html');return false;">
142
+ <span class="method-name">new</span><span class="method-args">(message, code)</span>
143
+ </a>
144
+ </div>
145
+
146
+ <div class="method-description">
147
+ </div>
148
+ </div>
149
+
150
+
151
+ </div>
152
+
153
+
154
+ </div>
155
+
156
+
157
+ <div id="validator-badges">
158
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
159
+ </div>
160
+
161
+ </body>
162
+ </html>