class-Mandrill_Senders.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680
  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. <title>Class Mandrill_Senders</title>
  7. <script type="text/javascript" src="resources/combined.js?394153670"></script>
  8. <script type="text/javascript" src="elementlist.js?882160656"></script>
  9. <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
  10. </head>
  11. <body>
  12. <div id="left">
  13. <div id="menu">
  14. <a href="index.html" title="Overview"><span>Overview</span></a>
  15. <div id="groups">
  16. <h3>Namespaces</h3>
  17. <ul>
  18. <li class="active"><a href="namespace-None.html">None</a>
  19. </li>
  20. <li><a href="namespace-PHP.html">PHP</a>
  21. </li>
  22. </ul>
  23. </div>
  24. <hr />
  25. <div id="elements">
  26. <h3>Classes</h3>
  27. <ul>
  28. <li><a href="class-Mandrill.html">Mandrill</a></li>
  29. <li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
  30. <li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
  31. <li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
  32. <li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
  33. <li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
  34. <li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
  35. <li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
  36. <li class="active"><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
  37. <li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
  38. <li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
  39. <li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
  40. <li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
  41. <li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
  42. <li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
  43. <li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
  44. </ul>
  45. <h3>Exceptions</h3>
  46. <ul>
  47. <li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
  48. <li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
  49. <li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
  50. <li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
  51. <li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
  52. <li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
  53. <li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
  54. <li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
  55. <li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
  56. <li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
  57. <li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
  58. <li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
  59. <li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
  60. <li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
  61. <li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
  62. <li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
  63. <li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
  64. <li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
  65. <li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
  66. <li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
  67. <li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
  68. <li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
  69. <li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
  70. <li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
  71. <li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
  72. <li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
  73. <li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
  74. <li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
  75. <li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
  76. <li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
  77. <li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
  78. </ul>
  79. </div>
  80. </div>
  81. </div>
  82. <div id="splitter"></div>
  83. <div id="right">
  84. <div id="rightInner">
  85. <form id="search">
  86. <input type="hidden" name="cx" value="" />
  87. <input type="hidden" name="ie" value="UTF-8" />
  88. <input type="text" name="q" class="text" />
  89. <input type="submit" value="Search" />
  90. </form>
  91. <div id="navigation">
  92. <ul>
  93. <li>
  94. <a href="index.html" title="Overview"><span>Overview</span></a>
  95. </li>
  96. <li>
  97. <a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
  98. </li>
  99. <li class="active">
  100. <span>Class</span> </li>
  101. </ul>
  102. <ul>
  103. <li>
  104. <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
  105. </li>
  106. </ul>
  107. <ul>
  108. </ul>
  109. </div>
  110. <div id="content" class="class">
  111. <h1>Class Mandrill_Senders</h1>
  112. <div class="info">
  113. <b>Located at</b> <a href="source-class-Mandrill_Senders.html#3-216" title="Go to source code">Mandrill/Senders.php</a><br />
  114. </div>
  115. <table class="summary" id="methods">
  116. <caption>Methods summary</caption>
  117. <tr data-order="__construct" id="___construct">
  118. <td class="attributes"><code>
  119. public
  120. </code>
  121. </td>
  122. <td class="name"><div>
  123. <a class="anchor" href="#___construct">#</a>
  124. <code><a href="source-class-Mandrill_Senders.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
  125. <div class="description short">
  126. </div>
  127. <div class="description detailed hidden">
  128. </div>
  129. </div></td>
  130. </tr>
  131. <tr data-order="getList" id="_getList">
  132. <td class="attributes"><code>
  133. public
  134. array
  135. </code>
  136. </td>
  137. <td class="name"><div>
  138. <a class="anchor" href="#_getList">#</a>
  139. <code><a href="source-class-Mandrill_Senders.html#8-28" title="Go to source code">getList</a>( )</code>
  140. <div class="description short">
  141. <p>Return the senders that have tried to use this account.</p>
  142. </div>
  143. <div class="description detailed hidden">
  144. <p>Return the senders that have tried to use this account.</p>
  145. <h4>Returns</h4>
  146. <div class="list">
  147. <code>array</code><br>an array of sender data, one for each sending addresses used by the account -
  148. return[] struct the information on each sending address in the account - address
  149. string the sender's email address - created_at string the date and time that the
  150. sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS
  151. format - sent integer the total number of messages sent by this sender -
  152. hard_bounces integer the total number of hard bounces by messages by this sender
  153. - soft_bounces integer the total number of soft bounces by messages by this
  154. sender - rejects integer the total number of rejected messages by this sender -
  155. complaints integer the total number of spam complaints received for messages by
  156. this sender - unsubs integer the total number of unsubscribe requests received
  157. for messages by this sender - opens integer the total number of times messages
  158. by this sender have been opened - clicks integer the total number of times
  159. tracked URLs in messages by this sender have been clicked - unique_opens integer
  160. the number of unique opens for emails sent for this sender - unique_clicks
  161. integer the number of unique clicks for emails sent for this sender<br />
  162. </div>
  163. </div>
  164. </div></td>
  165. </tr>
  166. <tr data-order="domains" id="_domains">
  167. <td class="attributes"><code>
  168. public
  169. array
  170. </code>
  171. </td>
  172. <td class="name"><div>
  173. <a class="anchor" href="#_domains">#</a>
  174. <code><a href="source-class-Mandrill_Senders.html#30-51" title="Go to source code">domains</a>( )</code>
  175. <div class="description short">
  176. <p>Returns the sender domains that have been added to this account.</p>
  177. </div>
  178. <div class="description detailed hidden">
  179. <p>Returns the sender domains that have been added to this account.</p>
  180. <h4>Returns</h4>
  181. <div class="list">
  182. <code>array</code><br>an array of sender domain data, one for each sending domain used by the account
  183. - return[] struct the information on each sending domain for the account -
  184. domain string the sender domain name - created_at string the date and time that
  185. the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
  186. - last_tested_at string when the domain's DNS settings were last tested as a UTC
  187. string in YYYY-MM-DD HH:MM:SS format - spf struct details about the domain's SPF
  188. record - valid boolean whether the domain's SPF record is valid for use with
  189. Mandrill - valid_after string when the domain's SPF record will be considered
  190. valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If
  191. set, this indicates that the record is valid now, but was previously invalid,
  192. and Mandrill will wait until the record's TTL elapses to start using it. - error
  193. string an error describing the spf record, or null if the record is correct -
  194. dkim struct details about the domain's DKIM record - valid boolean whether the
  195. domain's DKIM record is valid for use with Mandrill - valid_after string when
  196. the domain's DKIM record will be considered valid for use with Mandrill as a UTC
  197. string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is
  198. valid now, but was previously invalid, and Mandrill will wait until the record's
  199. TTL elapses to start using it. - error string an error describing the DKIM
  200. record, or null if the record is correct - verified_at string if the domain has
  201. been verified, this indicates when that verification occurred as a UTC string in
  202. YYYY-MM-DD HH:MM:SS format - valid_signing boolean whether this domain can be
  203. used to authenticate mail, either for itself or as a custom signing domain. If
  204. this is false but spf and dkim are both valid, you will need to verify the
  205. domain before using it to authenticate mail<br />
  206. </div>
  207. </div>
  208. </div></td>
  209. </tr>
  210. <tr data-order="addDomain" id="_addDomain">
  211. <td class="attributes"><code>
  212. public
  213. struct
  214. </code>
  215. </td>
  216. <td class="name"><div>
  217. <a class="anchor" href="#_addDomain">#</a>
  218. <code><a href="source-class-Mandrill_Senders.html#53-75" title="Go to source code">addDomain</a>( <span>string <var>$domain</var></span> )</code>
  219. <div class="description short">
  220. <p>Adds a sender domain to your account. Sender domains are added automatically
  221. as you send, but you can use this call to add them ahead of time.</p>
  222. </div>
  223. <div class="description detailed hidden">
  224. <p>Adds a sender domain to your account. Sender domains are added automatically
  225. as you send, but you can use this call to add them ahead of time.</p>
  226. <h4>Parameters</h4>
  227. <div class="list"><dl>
  228. <dt><var>$domain</var></dt>
  229. <dd><code>string</code><br>$domain a domain name</dd>
  230. </dl></div>
  231. <h4>Returns</h4>
  232. <div class="list">
  233. <code>struct</code><br>information about the domain - domain string the sender domain name - created_at
  234. string the date and time that the sending domain was first seen as a UTC string
  235. in YYYY-MM-DD HH:MM:SS format - last_tested_at string when the domain's DNS
  236. settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format - spf
  237. struct details about the domain's SPF record - valid boolean whether the
  238. domain's SPF record is valid for use with Mandrill - valid_after string when the
  239. domain's SPF record will be considered valid for use with Mandrill as a UTC
  240. string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is
  241. valid now, but was previously invalid, and Mandrill will wait until the record's
  242. TTL elapses to start using it. - error string an error describing the spf
  243. record, or null if the record is correct - dkim struct details about the
  244. domain's DKIM record - valid boolean whether the domain's DKIM record is valid
  245. for use with Mandrill - valid_after string when the domain's DKIM record will be
  246. considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS
  247. format. If set, this indicates that the record is valid now, but was previously
  248. invalid, and Mandrill will wait until the record's TTL elapses to start using
  249. it. - error string an error describing the DKIM record, or null if the record is
  250. correct - verified_at string if the domain has been verified, this indicates
  251. when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format -
  252. valid_signing boolean whether this domain can be used to authenticate mail,
  253. either for itself or as a custom signing domain. If this is false but spf and
  254. dkim are both valid, you will need to verify the domain before using it to
  255. authenticate mail<br />
  256. </div>
  257. </div>
  258. </div></td>
  259. </tr>
  260. <tr data-order="checkDomain" id="_checkDomain">
  261. <td class="attributes"><code>
  262. public
  263. struct
  264. </code>
  265. </td>
  266. <td class="name"><div>
  267. <a class="anchor" href="#_checkDomain">#</a>
  268. <code><a href="source-class-Mandrill_Senders.html#77-99" title="Go to source code">checkDomain</a>( <span>string <var>$domain</var></span> )</code>
  269. <div class="description short">
  270. <p>Checks the SPF and DKIM settings for a domain. If you haven't already added
  271. this domain to your account, it will be added automatically.</p>
  272. </div>
  273. <div class="description detailed hidden">
  274. <p>Checks the SPF and DKIM settings for a domain. If you haven't already added
  275. this domain to your account, it will be added automatically.</p>
  276. <h4>Parameters</h4>
  277. <div class="list"><dl>
  278. <dt><var>$domain</var></dt>
  279. <dd><code>string</code><br>$domain a domain name</dd>
  280. </dl></div>
  281. <h4>Returns</h4>
  282. <div class="list">
  283. <code>struct</code><br>information about the sender domain - domain string the sender domain name -
  284. created_at string the date and time that the sending domain was first seen as a
  285. UTC string in YYYY-MM-DD HH:MM:SS format - last_tested_at string when the
  286. domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS
  287. format - spf struct details about the domain's SPF record - valid boolean
  288. whether the domain's SPF record is valid for use with Mandrill - valid_after
  289. string when the domain's SPF record will be considered valid for use with
  290. Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates
  291. that the record is valid now, but was previously invalid, and Mandrill will wait
  292. until the record's TTL elapses to start using it. - error string an error
  293. describing the spf record, or null if the record is correct - dkim struct
  294. details about the domain's DKIM record - valid boolean whether the domain's DKIM
  295. record is valid for use with Mandrill - valid_after string when the domain's
  296. DKIM record will be considered valid for use with Mandrill as a UTC string in
  297. YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now,
  298. but was previously invalid, and Mandrill will wait until the record's TTL
  299. elapses to start using it. - error string an error describing the DKIM record,
  300. or null if the record is correct - verified_at string if the domain has been
  301. verified, this indicates when that verification occurred as a UTC string in
  302. YYYY-MM-DD HH:MM:SS format - valid_signing boolean whether this domain can be
  303. used to authenticate mail, either for itself or as a custom signing domain. If
  304. this is false but spf and dkim are both valid, you will need to verify the
  305. domain before using it to authenticate mail<br />
  306. </div>
  307. </div>
  308. </div></td>
  309. </tr>
  310. <tr data-order="verifyDomain" id="_verifyDomain">
  311. <td class="attributes"><code>
  312. public
  313. struct
  314. </code>
  315. </td>
  316. <td class="name"><div>
  317. <a class="anchor" href="#_verifyDomain">#</a>
  318. <code><a href="source-class-Mandrill_Senders.html#101-117" title="Go to source code">verifyDomain</a>( <span>string <var>$domain</var></span>, <span>string <var>$mailbox</var></span> )</code>
  319. <div class="description short">
  320. <p>Sends a verification email in order to verify ownership of a domain. Domain
  321. verification is an optional step to confirm ownership of a domain. Once a domain
  322. has been verified in a Mandrill account, other accounts may not have their
  323. messages signed by that domain unless they also verify the domain. This prevents
  324. other Mandrill accounts from sending mail signed by your domain.</p>
  325. </div>
  326. <div class="description detailed hidden">
  327. <p>Sends a verification email in order to verify ownership of a domain. Domain
  328. verification is an optional step to confirm ownership of a domain. Once a domain
  329. has been verified in a Mandrill account, other accounts may not have their
  330. messages signed by that domain unless they also verify the domain. This prevents
  331. other Mandrill accounts from sending mail signed by your domain.</p>
  332. <h4>Parameters</h4>
  333. <div class="list"><dl>
  334. <dt><var>$domain</var></dt>
  335. <dd><code>string</code><br>$domain a domain name at which you can receive email</dd>
  336. <dt><var>$mailbox</var></dt>
  337. <dd><code>string</code><br>$mailbox a mailbox at the domain where the verification email should be sent</dd>
  338. </dl></div>
  339. <h4>Returns</h4>
  340. <div class="list">
  341. <code>struct</code><br>information about the verification that was sent - status string "sent"
  342. indicates that the verification has been sent, "already_verified" indicates that
  343. the domain has already been verified with your account - domain string the
  344. domain name you provided - email string the email address the verification email
  345. was sent to<br />
  346. </div>
  347. </div>
  348. </div></td>
  349. </tr>
  350. <tr data-order="info" id="_info">
  351. <td class="attributes"><code>
  352. public
  353. struct
  354. </code>
  355. </td>
  356. <td class="name"><div>
  357. <a class="anchor" href="#_info">#</a>
  358. <code><a href="source-class-Mandrill_Senders.html#119-193" title="Go to source code">info</a>( <span>string <var>$address</var></span> )</code>
  359. <div class="description short">
  360. <p>Return more detailed information about a single sender, including aggregates
  361. of recent stats</p>
  362. </div>
  363. <div class="description detailed hidden">
  364. <p>Return more detailed information about a single sender, including aggregates
  365. of recent stats</p>
  366. <h4>Parameters</h4>
  367. <div class="list"><dl>
  368. <dt><var>$address</var></dt>
  369. <dd><code>string</code><br>$address the email address of the sender</dd>
  370. </dl></div>
  371. <h4>Returns</h4>
  372. <div class="list">
  373. <code>struct</code><br>the detailed information on the sender - address string the sender's email
  374. address - created_at string the date and time that the sender was first seen by
  375. Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent integer the
  376. total number of messages sent by this sender - hard_bounces integer the total
  377. number of hard bounces by messages by this sender - soft_bounces integer the
  378. total number of soft bounces by messages by this sender - rejects integer the
  379. total number of rejected messages by this sender - complaints integer the total
  380. number of spam complaints received for messages by this sender - unsubs integer
  381. the total number of unsubscribe requests received for messages by this sender -
  382. opens integer the total number of times messages by this sender have been opened
  383. - clicks integer the total number of times tracked URLs in messages by this
  384. sender have been clicked - stats struct an aggregate summary of the sender's
  385. sending stats - today struct stats for this sender so far today - sent integer
  386. the number of emails sent for this sender so far today - hard_bounces integer
  387. the number of emails hard bounced for this sender so far today - soft_bounces
  388. integer the number of emails soft bounced for this sender so far today - rejects
  389. integer the number of emails rejected for sending this sender so far today -
  390. complaints integer the number of spam complaints for this sender so far today -
  391. unsubs integer the number of unsubscribes for this sender so far today - opens
  392. integer the number of times emails have been opened for this sender so far today
  393. - unique_opens integer the number of unique opens for emails sent for this
  394. sender so far today - clicks integer the number of URLs that have been clicked
  395. for this sender so far today - unique_clicks integer the number of unique clicks
  396. for emails sent for this sender so far today - last<sub>7</sub>_days struct
  397. stats for this sender in the last 7 days - sent integer the number of emails
  398. sent for this sender in the last 7 days - hard_bounces integer the number of
  399. emails hard bounced for this sender in the last 7 days - soft_bounces integer
  400. the number of emails soft bounced for this sender in the last 7 days - rejects
  401. integer the number of emails rejected for sending this sender in the last 7 days
  402. - complaints integer the number of spam complaints for this sender in the last 7
  403. days - unsubs integer the number of unsubscribes for this sender in the last 7
  404. days - opens integer the number of times emails have been opened for this sender
  405. in the last 7 days - unique_opens integer the number of unique opens for emails
  406. sent for this sender in the last 7 days - clicks integer the number of URLs that
  407. have been clicked for this sender in the last 7 days - unique_clicks integer the
  408. number of unique clicks for emails sent for this sender in the last 7 days -
  409. last<sub>30</sub>_days struct stats for this sender in the last 30 days - sent
  410. integer the number of emails sent for this sender in the last 30 days -
  411. hard_bounces integer the number of emails hard bounced for this sender in the
  412. last 30 days - soft_bounces integer the number of emails soft bounced for this
  413. sender in the last 30 days - rejects integer the number of emails rejected for
  414. sending this sender in the last 30 days - complaints integer the number of spam
  415. complaints for this sender in the last 30 days - unsubs integer the number of
  416. unsubscribes for this sender in the last 30 days - opens integer the number of
  417. times emails have been opened for this sender in the last 30 days - unique_opens
  418. integer the number of unique opens for emails sent for this sender in the last
  419. 30 days - clicks integer the number of URLs that have been clicked for this
  420. sender in the last 30 days - unique_clicks integer the number of unique clicks
  421. for emails sent for this sender in the last 30 days - last<sub>60</sub>_days
  422. struct stats for this sender in the last 60 days - sent integer the number of
  423. emails sent for this sender in the last 60 days - hard_bounces integer the
  424. number of emails hard bounced for this sender in the last 60 days - soft_bounces
  425. integer the number of emails soft bounced for this sender in the last 60 days -
  426. rejects integer the number of emails rejected for sending this sender in the
  427. last 60 days - complaints integer the number of spam complaints for this sender
  428. in the last 60 days - unsubs integer the number of unsubscribes for this sender
  429. in the last 60 days - opens integer the number of times emails have been opened
  430. for this sender in the last 60 days - unique_opens integer the number of unique
  431. opens for emails sent for this sender in the last 60 days - clicks integer the
  432. number of URLs that have been clicked for this sender in the last 60 days -
  433. unique_clicks integer the number of unique clicks for emails sent for this
  434. sender in the last 60 days - last<sub>90</sub>_days struct stats for this sender
  435. in the last 90 days - sent integer the number of emails sent for this sender in
  436. the last 90 days - hard_bounces integer the number of emails hard bounced for
  437. this sender in the last 90 days - soft_bounces integer the number of emails soft
  438. bounced for this sender in the last 90 days - rejects integer the number of
  439. emails rejected for sending this sender in the last 90 days - complaints integer
  440. the number of spam complaints for this sender in the last 90 days - unsubs
  441. integer the number of unsubscribes for this sender in the last 90 days - opens
  442. integer the number of times emails have been opened for this sender in the last
  443. 90 days - unique_opens integer the number of unique opens for emails sent for
  444. this sender in the last 90 days - clicks integer the number of URLs that have
  445. been clicked for this sender in the last 90 days - unique_clicks integer the
  446. number of unique clicks for emails sent for this sender in the last 90 days<br />
  447. </div>
  448. </div>
  449. </div></td>
  450. </tr>
  451. <tr data-order="timeSeries" id="_timeSeries">
  452. <td class="attributes"><code>
  453. public
  454. array
  455. </code>
  456. </td>
  457. <td class="name"><div>
  458. <a class="anchor" href="#_timeSeries">#</a>
  459. <code><a href="source-class-Mandrill_Senders.html#195-214" title="Go to source code">timeSeries</a>( <span>string <var>$address</var></span> )</code>
  460. <div class="description short">
  461. <p>Return the recent history (hourly stats for the last 30 days) for a
  462. sender</p>
  463. </div>
  464. <div class="description detailed hidden">
  465. <p>Return the recent history (hourly stats for the last 30 days) for a
  466. sender</p>
  467. <h4>Parameters</h4>
  468. <div class="list"><dl>
  469. <dt><var>$address</var></dt>
  470. <dd><code>string</code><br>$address the email address of the sender</dd>
  471. </dl></div>
  472. <h4>Returns</h4>
  473. <div class="list">
  474. <code>array</code><br>the array of history information - return[] struct the stats for a single hour -
  475. time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent
  476. integer the number of emails that were sent during the hour - hard_bounces
  477. integer the number of emails that hard bounced during the hour - soft_bounces
  478. integer the number of emails that soft bounced during the hour - rejects integer
  479. the number of emails that were rejected during the hour - complaints integer the
  480. number of spam complaints received during the hour - opens integer the number of
  481. emails opened during the hour - unique_opens integer the number of unique opens
  482. generated by messages sent during the hour - clicks integer the number of
  483. tracked URLs clicked during the hour - unique_clicks integer the number of
  484. unique clicks generated by messages sent during the hour<br />
  485. </div>
  486. </div>
  487. </div></td>
  488. </tr>
  489. </table>
  490. </div>
  491. <div id="footer">
  492. API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
  493. </div>
  494. </div>
  495. </div>
  496. </body>
  497. </html>