source-class-Mandrill_Users.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <meta name="generator" content="ApiGen 2.8.0" />
  6. <meta name="robots" content="noindex" />
  7. <title>File Mandrill/Users.php</title>
  8. <script type="text/javascript" src="resources/combined.js?394153670"></script>
  9. <script type="text/javascript" src="elementlist.js?882160656"></script>
  10. <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
  11. </head>
  12. <body>
  13. <div id="left">
  14. <div id="menu">
  15. <a href="index.html" title="Overview"><span>Overview</span></a>
  16. <div id="groups">
  17. <h3>Namespaces</h3>
  18. <ul>
  19. <li class="active"><a href="namespace-None.html">None</a>
  20. </li>
  21. <li><a href="namespace-PHP.html">PHP</a>
  22. </li>
  23. </ul>
  24. </div>
  25. <hr />
  26. <div id="elements">
  27. <h3>Classes</h3>
  28. <ul>
  29. <li><a href="class-Mandrill.html">Mandrill</a></li>
  30. <li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
  31. <li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
  32. <li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
  33. <li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
  34. <li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
  35. <li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
  36. <li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
  37. <li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
  38. <li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
  39. <li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
  40. <li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
  41. <li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
  42. <li class="active"><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
  43. <li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
  44. <li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
  45. </ul>
  46. <h3>Exceptions</h3>
  47. <ul>
  48. <li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
  49. <li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
  50. <li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
  51. <li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
  52. <li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
  53. <li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
  54. <li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
  55. <li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
  56. <li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
  57. <li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
  58. <li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
  59. <li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
  60. <li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
  61. <li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
  62. <li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
  63. <li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
  64. <li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
  65. <li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
  66. <li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
  67. <li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
  68. <li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
  69. <li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
  70. <li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
  71. <li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
  72. <li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
  73. <li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
  74. <li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
  75. <li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
  76. <li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
  77. <li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
  78. <li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
  79. </ul>
  80. </div>
  81. </div>
  82. </div>
  83. <div id="splitter"></div>
  84. <div id="right">
  85. <div id="rightInner">
  86. <form id="search">
  87. <input type="hidden" name="cx" value="" />
  88. <input type="hidden" name="ie" value="UTF-8" />
  89. <input type="text" name="q" class="text" />
  90. <input type="submit" value="Search" />
  91. </form>
  92. <div id="navigation">
  93. <ul>
  94. <li>
  95. <a href="index.html" title="Overview"><span>Overview</span></a>
  96. </li>
  97. <li>
  98. <a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
  99. </li>
  100. <li>
  101. <a href="class-Mandrill_Users.html" title="Summary of Mandrill_Users"><span>Class</span></a>
  102. </li>
  103. </ul>
  104. <ul>
  105. <li>
  106. <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
  107. </li>
  108. </ul>
  109. <ul>
  110. </ul>
  111. </div>
  112. <pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
  113. </span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
  114. </span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Users" href="#Mandrill_Users">Mandrill_Users</a> {
  115. </span><span id="4" class="l"><a class="l" href="#4"> 4: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(Mandrill <span class="php-var">$master</span>) {
  116. </span><span id="5" class="l"><a class="l" href="#5"> 5: </a> <span class="php-var">$this</span>-&gt;master = <span class="php-var">$master</span>;
  117. </span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
  118. </span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
  119. </span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
  120. </span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Return the information about the API-connected user
  121. </span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @return struct the user information including username, key, reputation, quota, and historical sending stats
  122. </span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * - username string the username of the user (used for SMTP authentication)
  123. </span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - created_at string the date and time that the user's Mandrill account was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  124. </span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * - public_id string a unique, permanent identifier for this user
  125. </span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - reputation integer the reputation of the user on a scale from 0 to 100, with 75 generally being a &quot;good&quot; reputation
  126. </span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * - hourly_quota integer the maximum number of emails Mandrill will deliver for this user each hour. Any emails beyond that will be accepted and queued for later delivery. Users with higher reputations will have higher hourly quotas
  127. </span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - backlog integer the number of emails that are queued for delivery due to exceeding your monthly or hourly quotas
  128. </span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - stats struct an aggregate summary of the account's sending stats
  129. </span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - today struct stats for this user so far today
  130. </span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - sent integer the number of emails sent for this user so far today
  131. </span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this user so far today
  132. </span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this user so far today
  133. </span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this user so far today
  134. </span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this user so far today
  135. </span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this user so far today
  136. </span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this user so far today
  137. </span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this user so far today
  138. </span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this user so far today
  139. </span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this user so far today
  140. </span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * - last_7_days struct stats for this user in the last 7 days
  141. </span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * - sent integer the number of emails sent for this user in the last 7 days
  142. </span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this user in the last 7 days
  143. </span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this user in the last 7 days
  144. </span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this user in the last 7 days
  145. </span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this user in the last 7 days
  146. </span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this user in the last 7 days
  147. </span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this user in the last 7 days
  148. </span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this user in the last 7 days
  149. </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this user in the last 7 days
  150. </span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this user in the last 7 days
  151. </span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * - last_30_days struct stats for this user in the last 30 days
  152. </span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * - sent integer the number of emails sent for this user in the last 30 days
  153. </span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this user in the last 30 days
  154. </span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this user in the last 30 days
  155. </span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this user in the last 30 days
  156. </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this user in the last 30 days
  157. </span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this user in the last 30 days
  158. </span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this user in the last 30 days
  159. </span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this user in the last 30 days
  160. </span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this user in the last 30 days
  161. </span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this user in the last 30 days
  162. </span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * - last_60_days struct stats for this user in the last 60 days
  163. </span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * - sent integer the number of emails sent for this user in the last 60 days
  164. </span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this user in the last 60 days
  165. </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this user in the last 60 days
  166. </span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this user in the last 60 days
  167. </span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this user in the last 60 days
  168. </span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this user in the last 60 days
  169. </span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this user in the last 60 days
  170. </span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this user in the last 60 days
  171. </span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this user in the last 60 days
  172. </span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this user in the last 60 days
  173. </span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - last_90_days struct stats for this user in the last 90 days
  174. </span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - sent integer the number of emails sent for this user in the last 90 days
  175. </span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this user in the last 90 days
  176. </span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this user in the last 90 days
  177. </span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this user in the last 90 days
  178. </span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this user in the last 90 days
  179. </span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this user in the last 90 days
  180. </span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this user in the last 90 days
  181. </span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this user in the last 90 days
  182. </span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this user in the last 90 days
  183. </span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this user in the last 90 days
  184. </span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - all_time struct stats for the lifetime of the user's account
  185. </span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * - sent integer the number of emails sent in the lifetime of the user's account
  186. </span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced in the lifetime of the user's account
  187. </span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced in the lifetime of the user's account
  188. </span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this user so far today
  189. </span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * - complaints integer the number of spam complaints in the lifetime of the user's account
  190. </span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes in the lifetime of the user's account
  191. </span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * - opens integer the number of times emails have been opened in the lifetime of the user's account
  192. </span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent in the lifetime of the user's account
  193. </span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked in the lifetime of the user's account
  194. </span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent in the lifetime of the user's account
  195. </span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> */</span>
  196. </span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>() {
  197. </span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
  198. </span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'users/info'</span>, <span class="php-var">$_params</span>);
  199. </span><span id="88" class="l"><a class="l" href="#88"> 88: </a> }
  200. </span><span id="89" class="l"><a class="l" href="#89"> 89: </a>
  201. </span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-comment">/**
  202. </span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * Validate an API key and respond to a ping
  203. </span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @return string the string &quot;PONG!&quot;
  204. </span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
  205. </span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_ping" href="#_ping">ping</a>() {
  206. </span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
  207. </span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'users/ping'</span>, <span class="php-var">$_params</span>);
  208. </span><span id="97" class="l"><a class="l" href="#97"> 97: </a> }
  209. </span><span id="98" class="l"><a class="l" href="#98"> 98: </a>
  210. </span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-comment">/**
  211. </span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * Validate an API key and respond to a ping (anal JSON parser version)
  212. </span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * @return struct a struct with one key &quot;PING&quot; with a static value &quot;PONG!&quot;
  213. </span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> */</span>
  214. </span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_ping2" href="#_ping2">ping2</a>() {
  215. </span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
  216. </span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'users/ping2'</span>, <span class="php-var">$_params</span>);
  217. </span><span id="106" class="l"><a class="l" href="#106">106: </a> }
  218. </span><span id="107" class="l"><a class="l" href="#107">107: </a>
  219. </span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-comment">/**
  220. </span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * Return the senders that have tried to use this account, both verified and unverified
  221. </span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * @return array an array of sender data, one for each sending addresses used by the account
  222. </span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * - return[] struct the information on each sending address in the account
  223. </span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * - address string the sender's email address
  224. </span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * - created_at string the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
  225. </span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * - sent integer the total number of messages sent by this sender
  226. </span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages by this sender
  227. </span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages by this sender
  228. </span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * - rejects integer the total number of rejected messages by this sender
  229. </span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages by this sender
  230. </span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages by this sender
  231. </span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * - opens integer the total number of times messages by this sender have been opened
  232. </span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages by this sender have been clicked
  233. </span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender
  234. </span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender
  235. </span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> */</span>
  236. </span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_senders" href="#_senders">senders</a>() {
  237. </span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
  238. </span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'users/senders'</span>, <span class="php-var">$_params</span>);
  239. </span><span id="128" class="l"><a class="l" href="#128">128: </a> }
  240. </span><span id="129" class="l"><a class="l" href="#129">129: </a>
  241. </span><span id="130" class="l"><a class="l" href="#130">130: </a>}
  242. </span><span id="131" class="l"><a class="l" href="#131">131: </a>
  243. </span><span id="132" class="l"><a class="l" href="#132">132: </a>
  244. </span><span id="133" class="l"><a class="l" href="#133">133: </a></span></code></pre>
  245. <div id="footer">
  246. API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
  247. </div>
  248. </div>
  249. </div>
  250. </body>
  251. </html>