source-class-Mandrill_Exports.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  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/Exports.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 class="active"><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><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_Exports.html" title="Summary of Mandrill_Exports"><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_Exports" href="#Mandrill_Exports">Mandrill_Exports</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"> * Returns information about an export job. If the export job's state is 'complete',
  121. </span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">the returned data will include a URL you can use to fetch the results. Every export
  122. </span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">job produces a zip archive, but the format of the archive is distinct for each job
  123. </span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">type. The api calls that initiate exports include more details about the output format
  124. </span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">for that job type.
  125. </span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @param string $id an export job identifier
  126. </span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @return struct the information about the export
  127. </span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
  128. </span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  129. </span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - type string the type of the export job - activity, reject, or whitelist
  130. </span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format
  131. </span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - state string the export job's state - waiting, working, complete, error, or expired.
  132. </span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is completed.
  133. </span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> */</span>
  134. </span><span id="23" class="l"><a class="l" href="#23"> 23: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$id</span>) {
  135. </span><span id="24" class="l"><a class="l" href="#24"> 24: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
  136. </span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/info'</span>, <span class="php-var">$_params</span>);
  137. </span><span id="26" class="l"><a class="l" href="#26"> 26: </a> }
  138. </span><span id="27" class="l"><a class="l" href="#27"> 27: </a>
  139. </span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-comment">/**
  140. </span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * Returns a list of your exports.
  141. </span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * @return array the account's exports
  142. </span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * - return[] struct the individual export info
  143. </span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
  144. </span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  145. </span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - type string the type of the export job - activity, reject, or whitelist
  146. </span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format
  147. </span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - state string the export job's state - waiting, working, complete, error, or expired.
  148. </span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is completed.
  149. </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
  150. </span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() {
  151. </span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
  152. </span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/list'</span>, <span class="php-var">$_params</span>);
  153. </span><span id="42" class="l"><a class="l" href="#42"> 42: </a> }
  154. </span><span id="43" class="l"><a class="l" href="#43"> 43: </a>
  155. </span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-comment">/**
  156. </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive
  157. </span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">containing a single file named rejects.csv that includes the following fields: email,
  158. </span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment">reason, detail, created_at, expires_at, last_event_at, expires_at.
  159. </span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * @param string $notify_email an optional email address to notify when the export job has finished.
  160. </span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @return struct information about the rejects export job that was started
  161. </span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
  162. </span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  163. </span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * - type string the type of the export job
  164. </span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
  165. </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * - state string the export job's state
  166. </span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is complete
  167. </span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> */</span>
  168. </span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_rejects" href="#_rejects">rejects</a>(<span class="php-var">$notify_email</span>=<span class="php-keyword1">null</span>) {
  169. </span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;notify_email&quot;</span> =&gt; <span class="php-var">$notify_email</span>);
  170. </span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/rejects'</span>, <span class="php-var">$_params</span>);
  171. </span><span id="60" class="l"><a class="l" href="#60"> 60: </a> }
  172. </span><span id="61" class="l"><a class="l" href="#61"> 61: </a>
  173. </span><span id="62" class="l"><a class="l" href="#62"> 62: </a> <span class="php-comment">/**
  174. </span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive
  175. </span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment">containing a single file named whitelist.csv that includes the following fields:
  176. </span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment">email, detail, created_at.
  177. </span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * @param string $notify_email an optional email address to notify when the export job has finished.
  178. </span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * @return struct information about the whitelist export job that was started
  179. </span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
  180. </span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  181. </span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * - type string the type of the export job
  182. </span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
  183. </span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * - state string the export job's state
  184. </span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is complete
  185. </span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> */</span>
  186. </span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_whitelist" href="#_whitelist">whitelist</a>(<span class="php-var">$notify_email</span>=<span class="php-keyword1">null</span>) {
  187. </span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;notify_email&quot;</span> =&gt; <span class="php-var">$notify_email</span>);
  188. </span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/whitelist'</span>, <span class="php-var">$_params</span>);
  189. </span><span id="78" class="l"><a class="l" href="#78"> 78: </a> }
  190. </span><span id="79" class="l"><a class="l" href="#79"> 79: </a>
  191. </span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-comment">/**
  192. </span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * Begins an export of your activity history. The activity will be exported to a zip archive
  193. </span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment">containing a single file named activity.csv in the same format as you would be able to export
  194. </span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment">from your account's activity view. It includes the following fields: Date, Email Address,
  195. </span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment">Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom
  196. </span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment">metadata fields, they will be included in the exported data.
  197. </span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * @param string $notify_email an optional email address to notify when the export job has finished
  198. </span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @param string $date_from start date as a UTC string in YYYY-MM-DD HH:MM:SS format
  199. </span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * @param string $date_to end date as a UTC string in YYYY-MM-DD HH:MM:SS format
  200. </span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * @param array $tags an array of tag names to narrow the export to; will match messages that contain ANY of the tags
  201. </span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * - tags[] string a tag name
  202. </span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @param array $senders an array of senders to narrow the export to
  203. </span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - senders[] string a sender address
  204. </span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * @param array $states an array of states to narrow the export to; messages with ANY of the states will be included
  205. </span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - states[] string a message state
  206. </span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * @param array $api_keys an array of api keys to narrow the export to; messsagse sent with ANY of the keys will be included
  207. </span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - api_keys[] string an API key associated with your account
  208. </span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * @return struct information about the activity export job that was started
  209. </span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
  210. </span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  211. </span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * - type string the type of the export job
  212. </span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
  213. </span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * - state string the export job's state
  214. </span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is complete
  215. </span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> */</span>
  216. </span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_activity" href="#_activity">activity</a>(<span class="php-var">$notify_email</span>=<span class="php-keyword1">null</span>, <span class="php-var">$date_from</span>=<span class="php-keyword1">null</span>, <span class="php-var">$date_to</span>=<span class="php-keyword1">null</span>, <span class="php-var">$tags</span>=<span class="php-keyword1">null</span>, <span class="php-var">$senders</span>=<span class="php-keyword1">null</span>, <span class="php-var">$states</span>=<span class="php-keyword1">null</span>, <span class="php-var">$api_keys</span>=<span class="php-keyword1">null</span>) {
  217. </span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;notify_email&quot;</span> =&gt; <span class="php-var">$notify_email</span>, <span class="php-quote">&quot;date_from&quot;</span> =&gt; <span class="php-var">$date_from</span>, <span class="php-quote">&quot;date_to&quot;</span> =&gt; <span class="php-var">$date_to</span>, <span class="php-quote">&quot;tags&quot;</span> =&gt; <span class="php-var">$tags</span>, <span class="php-quote">&quot;senders&quot;</span> =&gt; <span class="php-var">$senders</span>, <span class="php-quote">&quot;states&quot;</span> =&gt; <span class="php-var">$states</span>, <span class="php-quote">&quot;api_keys&quot;</span> =&gt; <span class="php-var">$api_keys</span>);
  218. </span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/activity'</span>, <span class="php-var">$_params</span>);
  219. </span><span id="108" class="l"><a class="l" href="#108">108: </a> }
  220. </span><span id="109" class="l"><a class="l" href="#109">109: </a>
  221. </span><span id="110" class="l"><a class="l" href="#110">110: </a>}
  222. </span><span id="111" class="l"><a class="l" href="#111">111: </a>
  223. </span><span id="112" class="l"><a class="l" href="#112">112: </a>
  224. </span><span id="113" class="l"><a class="l" href="#113">113: </a></span></code></pre>
  225. <div id="footer">
  226. API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
  227. </div>
  228. </div>
  229. </div>
  230. </body>
  231. </html>