class-Mandrill.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503
  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</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 class="active"><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><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</h1>
  112. <div class="info">
  113. <b>Located at</b> <a href="source-class-Mandrill.html#20-159" title="Go to source code">Mandrill.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.html#59-91" title="Go to source code">__construct</a>( <span>mixed <var>$apikey</var> = <span class="php-keyword1">null</span></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="__destruct" id="___destruct">
  132. <td class="attributes"><code>
  133. public
  134. </code>
  135. </td>
  136. <td class="name"><div>
  137. <a class="anchor" href="#___destruct">#</a>
  138. <code><a href="source-class-Mandrill.html#93-95" title="Go to source code">__destruct</a>( )</code>
  139. <div class="description short">
  140. </div>
  141. <div class="description detailed hidden">
  142. </div>
  143. </div></td>
  144. </tr>
  145. <tr data-order="call" id="_call">
  146. <td class="attributes"><code>
  147. public
  148. </code>
  149. </td>
  150. <td class="name"><div>
  151. <a class="anchor" href="#_call">#</a>
  152. <code><a href="source-class-Mandrill.html#97-136" title="Go to source code">call</a>( <span>mixed <var>$url</var></span>, <span>mixed <var>$params</var></span> )</code>
  153. <div class="description short">
  154. </div>
  155. <div class="description detailed hidden">
  156. </div>
  157. </div></td>
  158. </tr>
  159. <tr data-order="readConfigs" id="_readConfigs">
  160. <td class="attributes"><code>
  161. public
  162. </code>
  163. </td>
  164. <td class="name"><div>
  165. <a class="anchor" href="#_readConfigs">#</a>
  166. <code><a href="source-class-Mandrill.html#138-147" title="Go to source code">readConfigs</a>( )</code>
  167. <div class="description short">
  168. </div>
  169. <div class="description detailed hidden">
  170. </div>
  171. </div></td>
  172. </tr>
  173. <tr data-order="castError" id="_castError">
  174. <td class="attributes"><code>
  175. public
  176. </code>
  177. </td>
  178. <td class="name"><div>
  179. <a class="anchor" href="#_castError">#</a>
  180. <code><a href="source-class-Mandrill.html#149-154" title="Go to source code">castError</a>( <span>mixed <var>$result</var></span> )</code>
  181. <div class="description short">
  182. </div>
  183. <div class="description detailed hidden">
  184. </div>
  185. </div></td>
  186. </tr>
  187. <tr data-order="log" id="_log">
  188. <td class="attributes"><code>
  189. public
  190. </code>
  191. </td>
  192. <td class="name"><div>
  193. <a class="anchor" href="#_log">#</a>
  194. <code><a href="source-class-Mandrill.html#156-158" title="Go to source code">log</a>( <span>mixed <var>$msg</var></span> )</code>
  195. <div class="description short">
  196. </div>
  197. <div class="description detailed hidden">
  198. </div>
  199. </div></td>
  200. </tr>
  201. </table>
  202. <table class="summary" id="properties">
  203. <caption>Properties summary</caption>
  204. <tr data-order="apikey" id="$apikey">
  205. <td class="attributes"><code>
  206. public
  207. mixed
  208. </code></td>
  209. <td class="name">
  210. <a href="source-class-Mandrill.html#22" title="Go to source code"><var>$apikey</var></a>
  211. </td>
  212. <td class="value"><code></code></td>
  213. <td class="description"><div>
  214. <a href="#$apikey" class="anchor">#</a>
  215. <div class="description short">
  216. </div>
  217. <div class="description detailed hidden">
  218. </div>
  219. </div></td>
  220. </tr>
  221. <tr data-order="ch" id="$ch">
  222. <td class="attributes"><code>
  223. public
  224. mixed
  225. </code></td>
  226. <td class="name">
  227. <a href="source-class-Mandrill.html#23" title="Go to source code"><var>$ch</var></a>
  228. </td>
  229. <td class="value"><code></code></td>
  230. <td class="description"><div>
  231. <a href="#$ch" class="anchor">#</a>
  232. <div class="description short">
  233. </div>
  234. <div class="description detailed hidden">
  235. </div>
  236. </div></td>
  237. </tr>
  238. <tr data-order="root" id="$root">
  239. <td class="attributes"><code>
  240. public
  241. string
  242. </code></td>
  243. <td class="name">
  244. <a href="source-class-Mandrill.html#24" title="Go to source code"><var>$root</var></a>
  245. </td>
  246. <td class="value"><code><span class="php-quote">'https://mandrillapp.com/api/1.0'</span></code></td>
  247. <td class="description"><div>
  248. <a href="#$root" class="anchor">#</a>
  249. <div class="description short">
  250. </div>
  251. <div class="description detailed hidden">
  252. </div>
  253. </div></td>
  254. </tr>
  255. <tr data-order="debug" id="$debug">
  256. <td class="attributes"><code>
  257. public
  258. boolean
  259. </code></td>
  260. <td class="name">
  261. <a href="source-class-Mandrill.html#25" title="Go to source code"><var>$debug</var></a>
  262. </td>
  263. <td class="value"><code><span class="php-keyword1">false</span></code></td>
  264. <td class="description"><div>
  265. <a href="#$debug" class="anchor">#</a>
  266. <div class="description short">
  267. </div>
  268. <div class="description detailed hidden">
  269. </div>
  270. </div></td>
  271. </tr>
  272. <tr data-order="error_map" id="$error_map">
  273. <td class="attributes"><code>
  274. public static
  275. array
  276. </code></td>
  277. <td class="name">
  278. <a href="source-class-Mandrill.html#27-57" title="Go to source code"><var>$error_map</var></a>
  279. </td>
  280. <td class="value"><code><span class="php-keyword1">array</span>(
  281. <span class="php-quote">&quot;ValidationError&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_ValidationError&quot;</span>,
  282. <span class="php-quote">&quot;Invalid_Key&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Key&quot;</span>,
  283. <span class="php-quote">&quot;PaymentRequired&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_PaymentRequired&quot;</span>,
  284. <span class="php-quote">&quot;Unknown_Subaccount&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Subaccount&quot;</span>,
  285. <span class="php-quote">&quot;Unknown_Template&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Template&quot;</span>,
  286. <span class="php-quote">&quot;ServiceUnavailable&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_ServiceUnavailable&quot;</span>,
  287. <span class="php-quote">&quot;Unknown_Message&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Message&quot;</span>,
  288. <span class="php-quote">&quot;Invalid_Tag_Name&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Tag_Name&quot;</span>,
  289. <span class="php-quote">&quot;Invalid_Reject&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Reject&quot;</span>,
  290. <span class="php-quote">&quot;Unknown_Sender&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Sender&quot;</span>,
  291. <span class="php-quote">&quot;Unknown_Url&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Url&quot;</span>,
  292. <span class="php-quote">&quot;Unknown_TrackingDomain&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_TrackingDomain&quot;</span>,
  293. <span class="php-quote">&quot;Invalid_Template&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Template&quot;</span>,
  294. <span class="php-quote">&quot;Unknown_Webhook&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Webhook&quot;</span>,
  295. <span class="php-quote">&quot;Unknown_InboundDomain&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_InboundDomain&quot;</span>,
  296. <span class="php-quote">&quot;Unknown_InboundRoute&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_InboundRoute&quot;</span>,
  297. <span class="php-quote">&quot;Unknown_Export&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Export&quot;</span>,
  298. <span class="php-quote">&quot;IP_ProvisionLimit&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_IP_ProvisionLimit&quot;</span>,
  299. <span class="php-quote">&quot;Unknown_Pool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Pool&quot;</span>,
  300. <span class="php-quote">&quot;NoSendingHistory&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_NoSendingHistory&quot;</span>,
  301. <span class="php-quote">&quot;PoorReputation&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_PoorReputation&quot;</span>,
  302. <span class="php-quote">&quot;Unknown_IP&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_IP&quot;</span>,
  303. <span class="php-quote">&quot;Invalid_EmptyDefaultPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_EmptyDefaultPool&quot;</span>,
  304. <span class="php-quote">&quot;Invalid_DeleteDefaultPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_DeleteDefaultPool&quot;</span>,
  305. <span class="php-quote">&quot;Invalid_DeleteNonEmptyPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_DeleteNonEmptyPool&quot;</span>,
  306. <span class="php-quote">&quot;Invalid_CustomDNS&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_CustomDNS&quot;</span>,
  307. <span class="php-quote">&quot;Invalid_CustomDNSPending&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_CustomDNSPending&quot;</span>,
  308. <span class="php-quote">&quot;Metadata_FieldLimit&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Metadata_FieldLimit&quot;</span>,
  309. <span class="php-quote">&quot;Unknown_MetadataField&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_MetadataField&quot;</span>
  310. )</code></td>
  311. <td class="description"><div>
  312. <a href="#$error_map" class="anchor">#</a>
  313. <div class="description short">
  314. </div>
  315. <div class="description detailed hidden">
  316. </div>
  317. </div></td>
  318. </tr>
  319. </table>
  320. </div>
  321. <div id="footer">
  322. API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
  323. </div>
  324. </div>
  325. </div>
  326. </body>
  327. </html>