PageRenderTime 45ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/source-class-Mandrill_Whitelists.html

https://bitbucket.org/manuelxwhite/mandrill-api-php
HTML | 180 lines | 161 code | 19 blank | 0 comment | 0 complexity | 7e171cee52646e774f94345a7427af7b MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    5. 

  5. 	<meta name="generator" content="ApiGen 2.8.0" />
    6. 

  6. 	<meta name="robots" content="noindex" />
    7. 

  7. 

  8. 	<title>File Mandrill/Whitelists.php</title>
    9. 

  9. 

  10. 	<script type="text/javascript" src="resources/combined.js?394153670"></script>
    11. 

  11. 	<script type="text/javascript" src="elementlist.js?2667747206"></script>
    12. 

  12. 	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
    13. 

  13. 

  14. </head>
    15. 

  15. 

  16. <body>
    17. 

  17. <div id="left">
    18. 

  18. 	<div id="menu">
    19. 

  19. 		<a href="index.html" title="Overview"><span>Overview</span></a>
    20. 

  20. 

  21. 

  22. 		<div id="groups">
    23. 

  23. 			<h3>Namespaces</h3>
    24. 

  24. 			<ul>
    25. 

  25. 				<li class="active"><a href="namespace-None.html">None</a>
    26. 

  26. 						</li>
    27. 

  27. 				<li><a href="namespace-PHP.html">PHP</a>
    28. 

  28. 						</li>
    29. 

  29. 			</ul>
    30. 

  30. 		</div>
    31. 

  31. 

  32. 		<hr />
    33. 

  33. 

  34. 

  35. 		<div id="elements">
    36. 

  36. 			<h3>Classes</h3>
    37. 

  37. 			<ul>
    38. 

  38. 				<li><a href="class-Mandrill.html">Mandrill</a></li>
    39. 

  39. 				<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
    40. 

  40. 				<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
    41. 

  41. 				<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
    42. 

  42. 				<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
    43. 

  43. 				<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
    44. 

  44. 				<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
    45. 

  45. 				<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
    46. 

  46. 				<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
    47. 

  47. 				<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
    48. 

  48. 				<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
    49. 

  49. 				<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
    50. 

  50. 				<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
    51. 

  51. 				<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
    52. 

  52. 				<li class="active"><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
    53. 

  53. 			</ul>
    54. 

  54. 

  55. 

  56. 

  57. 			<h3>Exceptions</h3>
    58. 

  58. 			<ul>
    59. 

  59. 				<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
    60. 

  60. 				<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
    61. 

  61. 				<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
    62. 

  62. 				<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
    63. 

  63. 				<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
    64. 

  64. 				<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
    65. 

  65. 				<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
    66. 

  66. 				<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
    67. 

  67. 				<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
    68. 

  68. 				<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
    69. 

  69. 				<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
    70. 

  70. 				<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
    71. 

  71. 				<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
    72. 

  72. 				<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
    73. 

  73. 				<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
    74. 

  74. 				<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
    75. 

  75. 				<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
    76. 

  76. 				<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
    77. 

  77. 				<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
    78. 

  78. 				<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
    79. 

  79. 				<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
    80. 

  80. 				<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
    81. 

  81. 				<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
    82. 

  82. 			</ul>
    83. 

  83. 

  84. 

  85. 		</div>
    86. 

  86. 	</div>
    87. 

  87. </div>
    88. 

  88. 

  89. <div id="splitter"></div>
    90. 

  90. 

  91. <div id="right">
    92. 

  92. <div id="rightInner">
    93. 

  93. 	<form id="search">
    94. 

  94. 		<input type="hidden" name="cx" value="" />
    95. 

  95. 		<input type="hidden" name="ie" value="UTF-8" />
    96. 

  96. 		<input type="text" name="q" class="text" />
    97. 

  97. 		<input type="submit" value="Search" />
    98. 

  98. 	</form>
    99. 

  99. 

  100. 	<div id="navigation">
    101. 

  101. 		<ul>
    102. 

  102. 			<li>
    103. 

  103. 				<a href="index.html" title="Overview"><span>Overview</span></a>
    104. 

  104. 			</li>
    105. 

  105. 			<li>
    106. 

  106. 				<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
    107. 

  107. 			</li>
    108. 

  108. 			<li>
    109. 

  109. 				<a href="class-Mandrill_Whitelists.html" title="Summary of Mandrill_Whitelists"><span>Class</span></a>
    110. 

  110. 			</li>
    111. 

  111. 		</ul>
    112. 

  112. 		<ul>
    113. 

  113. 			<li>
    114. 

  114. 				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
    115. 

  115. 			</li>
    116. 

  116. 		</ul>
    117. 

  117. 		<ul>
    118. 

  118. 		</ul>
    119. 

  119. 	</div>
    120. 

  120. 

  121. <pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
    122. 

  122. </span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
    123. 

  123. </span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Whitelists" href="#Mandrill_Whitelists">Mandrill_Whitelists</a> {
    124. 

  124. </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>) {
    125. 

  125. </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>;
    126. 

  126. </span><span id="6" class="l"><a class="l" href="#6"> 6: </a>    }
    127. 

  127. </span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
    128. 

  128. </span><span id="8" class="l"><a class="l" href="#8"> 8: </a>    <span class="php-comment">/**
    129. 

  129. </span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment">     * Adds an email to your email rejection whitelist. If the address is
    130. 

  130. </span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment">currently on your blacklist, that blacklist entry will be removed
    131. 

  131. </span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment">automatically.
    132. 

  132. </span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment">     * @param string $email an email address to add to the whitelist
    133. 

  133. </span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment">     * @return struct a status object containing the address and the result of the operation
    134. 

  134. </span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment">     *     - email string the email address you provided
    135. 

  135. </span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment">     *     - whether boolean the operation succeeded
    136. 

  136. </span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment">     */</span>
    137. 

  137. </span><span id="17" class="l"><a class="l" href="#17">17: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add" href="#_add">add</a>(<span class="php-var">$email</span>) {
    138. 

  138. </span><span id="18" class="l"><a class="l" href="#18">18: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;email&quot;</span> =&gt; <span class="php-var">$email</span>);
    139. 

  139. </span><span id="19" class="l"><a class="l" href="#19">19: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'whitelists/add'</span>, <span class="php-var">$_params</span>);
    140. 

  140. </span><span id="20" class="l"><a class="l" href="#20">20: </a>    }
    141. 

  141. </span><span id="21" class="l"><a class="l" href="#21">21: </a>
    142. 

  142. </span><span id="22" class="l"><a class="l" href="#22">22: </a>    <span class="php-comment">/**
    143. 

  143. </span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment">     * Retrieves your email rejection whitelist. You can provide an email
    144. 

  144. </span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment">address or search prefix to limit the results. Returns up to 1000 results.
    145. 

  145. </span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment">     * @param string $email an optional email address or prefix to search by
    146. 

  146. </span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment">     * @return array up to 1000 whitelist entries
    147. 

  147. </span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment">     *     - return[] struct the information for each whitelist entry
    148. 

  148. </span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment">     *         - email string the email that is whitelisted
    149. 

  149. </span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment">     *         - detail string a description of why the email was whitelisted
    150. 

  150. </span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment">     *         - created_at string when the email was added to the whitelist
    151. 

  151. </span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment">     */</span>
    152. 

  152. </span><span id="32" class="l"><a class="l" href="#32">32: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>(<span class="php-var">$email</span>=<span class="php-keyword1">null</span>) {
    153. 

  153. </span><span id="33" class="l"><a class="l" href="#33">33: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;email&quot;</span> =&gt; <span class="php-var">$email</span>);
    154. 

  154. </span><span id="34" class="l"><a class="l" href="#34">34: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'whitelists/list'</span>, <span class="php-var">$_params</span>);
    155. 

  155. </span><span id="35" class="l"><a class="l" href="#35">35: </a>    }
    156. 

  156. </span><span id="36" class="l"><a class="l" href="#36">36: </a>
    157. 

  157. </span><span id="37" class="l"><a class="l" href="#37">37: </a>    <span class="php-comment">/**
    158. 

  158. </span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment">     * Removes an email address from the whitelist.
    159. 

  159. </span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment">     * @param string $email the email address to remove from the whitelist
    160. 

  160. </span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment">     * @return struct a status object containing the address and whether the deletion succeeded
    161. 

  161. </span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment">     *     - email string the email address that was removed from the blacklist
    162. 

  162. </span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment">     *     - deleted boolean whether the address was deleted successfully
    163. 

  163. </span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment">     */</span>
    164. 

  164. </span><span id="44" class="l"><a class="l" href="#44">44: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$email</span>) {
    165. 

  165. </span><span id="45" class="l"><a class="l" href="#45">45: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;email&quot;</span> =&gt; <span class="php-var">$email</span>);
    166. 

  166. </span><span id="46" class="l"><a class="l" href="#46">46: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'whitelists/delete'</span>, <span class="php-var">$_params</span>);
    167. 

  167. </span><span id="47" class="l"><a class="l" href="#47">47: </a>    }
    168. 

  168. </span><span id="48" class="l"><a class="l" href="#48">48: </a>
    169. 

  169. </span><span id="49" class="l"><a class="l" href="#49">49: </a>}
    170. 

  170. </span><span id="50" class="l"><a class="l" href="#50">50: </a>
    171. 

  171. </span><span id="51" class="l"><a class="l" href="#51">51: </a>
    172. 

  172. </span><span id="52" class="l"><a class="l" href="#52">52: </a></span></code></pre>
    173. 

  173. 

  174. 	<div id="footer">
    175. 

  175. 		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
    176. 

  176. 	</div>
    177. 

  177. </div>
    178. 

  178. </div>
    179. 

  179. </body>
    180. 

  180. </html>
    181. 

  181.