Home Explore Help
Sign In
bachir
/
materio-base-d7
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 4aed87ebd0
Branches Tags
materio-base...
/
sites
/
all
/
libraries
/
mandrill
/
mailchimp-mandrill-api-php-e1eda7352f24
/
docs
/
source-class-Mandrill_Ips.html

source-class-Mandrill_Ips.html 53 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417 
  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/Ips.php</title>
    9. 

  9. 

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

  11. 	<script type="text/javascript" src="elementlist.js?882160656"></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 class="active"><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_Metadata.html">Mandrill_Metadata</a></li>
    45. 

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

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

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

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

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

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

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

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

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

  54. 			</ul>
    55. 

  55. 

  56. 

  57. 

  58. 			<h3>Exceptions</h3>
    59. 

  59. 			<ul>
    60. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  82. 				<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
    83. 

  83. 				<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
    84. 

  84. 				<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
    85. 

  85. 				<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
    86. 

  86. 				<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
    87. 

  87. 				<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
    88. 

  88. 				<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
    89. 

  89. 				<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
    90. 

  90. 				<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
    91. 

  91. 			</ul>
    92. 

  92. 

  93. 

  94. 		</div>
    95. 

  95. 	</div>
    96. 

  96. </div>
    97. 

  97. 

  98. <div id="splitter"></div>
    99. 

  99. 

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

  101. <div id="rightInner">
    102. 

  102. 	<form id="search">
    103. 

  103. 		<input type="hidden" name="cx" value="" />
    104. 

  104. 		<input type="hidden" name="ie" value="UTF-8" />
    105. 

  105. 		<input type="text" name="q" class="text" />
    106. 

  106. 		<input type="submit" value="Search" />
    107. 

  107. 	</form>
    108. 

  108. 

  109. 	<div id="navigation">
    110. 

  110. 		<ul>
    111. 

  111. 			<li>
    112. 

  112. 				<a href="index.html" title="Overview"><span>Overview</span></a>
    113. 

  113. 			</li>
    114. 

  114. 			<li>
    115. 

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

  116. 			</li>
    117. 

  117. 			<li>
    118. 

  118. 				<a href="class-Mandrill_Ips.html" title="Summary of Mandrill_Ips"><span>Class</span></a>
    119. 

  119. 			</li>
    120. 

  120. 		</ul>
    121. 

  121. 		<ul>
    122. 

  122. 			<li>
    123. 

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

  124. 			</li>
    125. 

  125. 		</ul>
    126. 

  126. 		<ul>
    127. 

  127. 		</ul>
    128. 

  128. 	</div>
    129. 

  129. 

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

  131. </span><span id="2" class="l"><a class="l" href="#2">  2: </a>
    132. 

  132. </span><span id="3" class="l"><a class="l" href="#3">  3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Ips" href="#Mandrill_Ips">Mandrill_Ips</a> {
    133. 

  133. </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>) {
    134. 

  134. </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>;
    135. 

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

  136. </span><span id="7" class="l"><a class="l" href="#7">  7: </a>
    137. 

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

  138. </span></span><span id="9" class="l"><a class="l" href="#9">  9: </a><span class="php-comment">     * Lists your dedicated IPs.
    139. 

  139. </span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">     * @return array an array of structs for each dedicated IP
    140. 

  140. </span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">     *     - return[] struct information about a single dedicated IP
    141. 

  141. </span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">     *         - ip string the ip address
    142. 

  142. </span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">     *         - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    143. 

  143. </span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment">     *         - pool string the name of the pool that this dedicated IP belongs to
    144. 

  144. </span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment">     *         - domain string the domain name (reverse dns) of this dedicated IP
    145. 

  145. </span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">     *         - custom_dns struct information about the ip's custom dns, if it has been configured
    146. 

  146. </span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment">     *             - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    147. 

  147. </span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment">     *             - valid boolean whether the ip's custom dns is currently valid
    148. 

  148. </span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment">     *             - error string if the ip's custom dns is invalid, this will include details about the error
    149. 

  149. </span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment">     *         - warmup struct information about the ip's warmup status
    150. 

  150. </span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">     *             - warming_up boolean whether the ip is currently in warmup mode
    151. 

  151. </span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment">     *             - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    152. 

  152. </span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment">     *             - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    153. 

  153. </span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment">     */</span>
    154. 

  154. </span><span id="25" class="l"><a class="l" href="#25"> 25: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() {
    155. 

  155. </span><span id="26" class="l"><a class="l" href="#26"> 26: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
    156. 

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

  157. </span><span id="28" class="l"><a class="l" href="#28"> 28: </a>    }
    158. 

  158. </span><span id="29" class="l"><a class="l" href="#29"> 29: </a>
    159. 

  159. </span><span id="30" class="l"><a class="l" href="#30"> 30: </a>    <span class="php-comment">/**
    160. 

  160. </span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">     * Retrieves information about a single dedicated ip.
    161. 

  161. </span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment">     * @param string $ip a dedicated IP address
    162. 

  162. </span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment">     * @return struct Information about the dedicated ip
    163. 

  163. </span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment">     *     - ip string the ip address
    164. 

  164. </span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    165. 

  165. </span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
    166. 

  166. </span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
    167. 

  167. </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
    168. 

  168. </span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    169. 

  169. </span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
    170. 

  170. </span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
    171. 

  171. </span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
    172. 

  172. </span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
    173. 

  173. </span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    174. 

  174. </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    175. 

  175. </span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">     */</span>
    176. 

  176. </span><span id="47" class="l"><a class="l" href="#47"> 47: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$ip</span>) {
    177. 

  177. </span><span id="48" class="l"><a class="l" href="#48"> 48: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
    178. 

  178. </span><span id="49" class="l"><a class="l" href="#49"> 49: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/info'</span>, <span class="php-var">$_params</span>);
    179. 

  179. </span><span id="50" class="l"><a class="l" href="#50"> 50: </a>    }
    180. 

  180. </span><span id="51" class="l"><a class="l" href="#51"> 51: </a>
    181. 

  181. </span><span id="52" class="l"><a class="l" href="#52"> 52: </a>    <span class="php-comment">/**
    182. 

  182. </span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment">     * Requests an additional dedicated IP for your account. Accounts may
    183. 

  183. </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment">have one outstanding request at any time, and provisioning requests
    184. 

  184. </span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment">are processed within 24 hours.
    185. 

  185. </span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">     * @param boolean $warmup whether to enable warmup mode for the ip
    186. 

  186. </span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment">     * @param string $pool the id of the pool to add the dedicated ip to, or null to use your account's default pool
    187. 

  187. </span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment">     * @return struct a description of the provisioning request that was created
    188. 

  188. </span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment">     *     - requested_at string the date and time that the request was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
    189. 

  189. </span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment">     */</span>
    190. 

  190. </span><span id="61" class="l"><a class="l" href="#61"> 61: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_provision" href="#_provision">provision</a>(<span class="php-var">$warmup</span>=<span class="php-keyword1">false</span>, <span class="php-var">$pool</span>=<span class="php-keyword1">null</span>) {
    191. 

  191. </span><span id="62" class="l"><a class="l" href="#62"> 62: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;warmup&quot;</span> =&gt; <span class="php-var">$warmup</span>, <span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
    192. 

  192. </span><span id="63" class="l"><a class="l" href="#63"> 63: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/provision'</span>, <span class="php-var">$_params</span>);
    193. 

  193. </span><span id="64" class="l"><a class="l" href="#64"> 64: </a>    }
    194. 

  194. </span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
    195. 

  195. </span><span id="66" class="l"><a class="l" href="#66"> 66: </a>    <span class="php-comment">/**
    196. 

  196. </span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment">     * Begins the warmup process for a dedicated IP. During the warmup process,
    197. 

  197. </span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment">Mandrill will gradually increase the percentage of your mail that is sent over
    198. 

  198. </span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment">the warming-up IP, over a period of roughly 30 days. The rest of your mail
    199. 

  199. </span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment">will be sent over shared IPs or other dedicated IPs in the same pool.
    200. 

  200. </span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">     * @param string $ip a dedicated ip address
    201. 

  201. </span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment">     * @return struct Information about the dedicated IP
    202. 

  202. </span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment">     *     - ip string the ip address
    203. 

  203. </span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    204. 

  204. </span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
    205. 

  205. </span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
    206. 

  206. </span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
    207. 

  207. </span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    208. 

  208. </span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
    209. 

  209. </span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
    210. 

  210. </span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
    211. 

  211. </span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
    212. 

  212. </span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    213. 

  213. </span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    214. 

  214. </span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment">     */</span>
    215. 

  215. </span><span id="86" class="l"><a class="l" href="#86"> 86: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_startWarmup" href="#_startWarmup">startWarmup</a>(<span class="php-var">$ip</span>) {
    216. 

  216. </span><span id="87" class="l"><a class="l" href="#87"> 87: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
    217. 

  217. </span><span id="88" class="l"><a class="l" href="#88"> 88: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/start-warmup'</span>, <span class="php-var">$_params</span>);
    218. 

  218. </span><span id="89" class="l"><a class="l" href="#89"> 89: </a>    }
    219. 

  219. </span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
    220. 

  220. </span><span id="91" class="l"><a class="l" href="#91"> 91: </a>    <span class="php-comment">/**
    221. 

  221. </span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment">     * Cancels the warmup process for a dedicated IP.
    222. 

  222. </span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment">     * @param string $ip a dedicated ip address
    223. 

  223. </span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment">     * @return struct Information about the dedicated IP
    224. 

  224. </span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment">     *     - ip string the ip address
    225. 

  225. </span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    226. 

  226. </span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
    227. 

  227. </span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
    228. 

  228. </span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
    229. 

  229. </span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    230. 

  230. </span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
    231. 

  231. </span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
    232. 

  232. </span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
    233. 

  233. </span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
    234. 

  234. </span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    235. 

  235. </span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    236. 

  236. </span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment">     */</span>
    237. 

  237. </span><span id="108" class="l"><a class="l" href="#108">108: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_cancelWarmup" href="#_cancelWarmup">cancelWarmup</a>(<span class="php-var">$ip</span>) {
    238. 

  238. </span><span id="109" class="l"><a class="l" href="#109">109: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
    239. 

  239. </span><span id="110" class="l"><a class="l" href="#110">110: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/cancel-warmup'</span>, <span class="php-var">$_params</span>);
    240. 

  240. </span><span id="111" class="l"><a class="l" href="#111">111: </a>    }
    241. 

  241. </span><span id="112" class="l"><a class="l" href="#112">112: </a>
    242. 

  242. </span><span id="113" class="l"><a class="l" href="#113">113: </a>    <span class="php-comment">/**
    243. 

  243. </span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment">     * Moves a dedicated IP to a different pool.
    244. 

  244. </span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment">     * @param string $ip a dedicated ip address
    245. 

  245. </span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">     * @param string $pool the name of the new pool to add the dedicated ip to
    246. 

  246. </span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment">     * @param boolean $create_pool whether to create the pool if it does not exist; if false and the pool does not exist, an Unknown_Pool will be thrown.
    247. 

  247. </span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment">     * @return struct Information about the updated state of the dedicated IP
    248. 

  248. </span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment">     *     - ip string the ip address
    249. 

  249. </span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    250. 

  250. </span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
    251. 

  251. </span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
    252. 

  252. </span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
    253. 

  253. </span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    254. 

  254. </span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
    255. 

  255. </span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
    256. 

  256. </span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
    257. 

  257. </span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
    258. 

  258. </span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    259. 

  259. </span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    260. 

  260. </span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">     */</span>
    261. 

  261. </span><span id="132" class="l"><a class="l" href="#132">132: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setPool" href="#_setPool">setPool</a>(<span class="php-var">$ip</span>, <span class="php-var">$pool</span>, <span class="php-var">$create_pool</span>=<span class="php-keyword1">false</span>) {
    262. 

  262. </span><span id="133" class="l"><a class="l" href="#133">133: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>, <span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>, <span class="php-quote">&quot;create_pool&quot;</span> =&gt; <span class="php-var">$create_pool</span>);
    263. 

  263. </span><span id="134" class="l"><a class="l" href="#134">134: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/set-pool'</span>, <span class="php-var">$_params</span>);
    264. 

  264. </span><span id="135" class="l"><a class="l" href="#135">135: </a>    }
    265. 

  265. </span><span id="136" class="l"><a class="l" href="#136">136: </a>
    266. 

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

  267. </span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment">     * Deletes a dedicated IP. This is permanent and cannot be undone.
    268. 

  268. </span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment">     * @param string $ip the dedicated ip to remove from your account
    269. 

  269. </span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment">     * @return struct a description of the ip that was removed from your account.
    270. 

  270. </span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">     *     - ip string the ip address
    271. 

  271. </span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment">     *     - deleted string a boolean indicating whether the ip was successfully deleted
    272. 

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

  273. </span><span id="144" class="l"><a class="l" href="#144">144: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$ip</span>) {
    274. 

  274. </span><span id="145" class="l"><a class="l" href="#145">145: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
    275. 

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

  276. </span><span id="147" class="l"><a class="l" href="#147">147: </a>    }
    277. 

  277. </span><span id="148" class="l"><a class="l" href="#148">148: </a>
    278. 

  278. </span><span id="149" class="l"><a class="l" href="#149">149: </a>    <span class="php-comment">/**
    279. 

  279. </span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment">     * Lists your dedicated IP pools.
    280. 

  280. </span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment">     * @return array the dedicated IP pools for your account, up to a maximum of 1,000
    281. 

  281. </span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment">     *     - return[] struct information about each dedicated IP pool
    282. 

  282. </span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment">     *         - name string this pool's name
    283. 

  283. </span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment">     *         - created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
    284. 

  284. </span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment">     *         - ips array the dedicated IPs in this pool
    285. 

  285. </span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment">     *             - ips[] struct information about each dedicated IP
    286. 

  286. </span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment">     *                 - ip string the ip address
    287. 

  287. </span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment">     *                 - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    288. 

  288. </span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment">     *                 - pool string the name of the pool that this dedicated IP belongs to
    289. 

  289. </span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment">     *                 - domain string the domain name (reverse dns) of this dedicated IP
    290. 

  290. </span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment">     *                 - custom_dns struct information about the ip's custom dns, if it has been configured
    291. 

  291. </span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment">     *                     - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    292. 

  292. </span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment">     *                     - valid boolean whether the ip's custom dns is currently valid
    293. 

  293. </span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment">     *                     - error string if the ip's custom dns is invalid, this will include details about the error
    294. 

  294. </span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment">     *                 - warmup struct information about the ip's warmup status
    295. 

  295. </span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment">     *                     - warming_up boolean whether the ip is currently in warmup mode
    296. 

  296. </span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment">     *                     - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    297. 

  297. </span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment">     *                     - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    298. 

  298. </span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment">     */</span>
    299. 

  299. </span><span id="170" class="l"><a class="l" href="#170">170: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_listPools" href="#_listPools">listPools</a>() {
    300. 

  300. </span><span id="171" class="l"><a class="l" href="#171">171: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
    301. 

  301. </span><span id="172" class="l"><a class="l" href="#172">172: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/list-pools'</span>, <span class="php-var">$_params</span>);
    302. 

  302. </span><span id="173" class="l"><a class="l" href="#173">173: </a>    }
    303. 

  303. </span><span id="174" class="l"><a class="l" href="#174">174: </a>
    304. 

  304. </span><span id="175" class="l"><a class="l" href="#175">175: </a>    <span class="php-comment">/**
    305. 

  305. </span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment">     * Describes a single dedicated IP pool.
    306. 

  306. </span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment">     * @param string $pool a pool name
    307. 

  307. </span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment">     * @return struct Information about the dedicated ip pool
    308. 

  308. </span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment">     *     - name string this pool's name
    309. 

  309. </span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment">     *     - created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
    310. 

  310. </span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment">     *     - ips array the dedicated IPs in this pool
    311. 

  311. </span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment">     *         - ips[] struct information about each dedicated IP
    312. 

  312. </span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment">     *             - ip string the ip address
    313. 

  313. </span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment">     *             - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    314. 

  314. </span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment">     *             - pool string the name of the pool that this dedicated IP belongs to
    315. 

  315. </span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment">     *             - domain string the domain name (reverse dns) of this dedicated IP
    316. 

  316. </span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment">     *             - custom_dns struct information about the ip's custom dns, if it has been configured
    317. 

  317. </span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment">     *                 - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    318. 

  318. </span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment">     *                 - valid boolean whether the ip's custom dns is currently valid
    319. 

  319. </span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment">     *                 - error string if the ip's custom dns is invalid, this will include details about the error
    320. 

  320. </span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment">     *             - warmup struct information about the ip's warmup status
    321. 

  321. </span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment">     *                 - warming_up boolean whether the ip is currently in warmup mode
    322. 

  322. </span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment">     *                 - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    323. 

  323. </span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment">     *                 - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    324. 

  324. </span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment">     */</span>
    325. 

  325. </span><span id="196" class="l"><a class="l" href="#196">196: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_poolInfo" href="#_poolInfo">poolInfo</a>(<span class="php-var">$pool</span>) {
    326. 

  326. </span><span id="197" class="l"><a class="l" href="#197">197: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
    327. 

  327. </span><span id="198" class="l"><a class="l" href="#198">198: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/pool-info'</span>, <span class="php-var">$_params</span>);
    328. 

  328. </span><span id="199" class="l"><a class="l" href="#199">199: </a>    }
    329. 

  329. </span><span id="200" class="l"><a class="l" href="#200">200: </a>
    330. 

  330. </span><span id="201" class="l"><a class="l" href="#201">201: </a>    <span class="php-comment">/**
    331. 

  331. </span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment">     * Creates a pool and returns it. If a pool already exists with this
    332. 

  332. </span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment">name, no action will be performed.
    333. 

  333. </span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment">     * @param string $pool the name of a pool to create
    334. 

  334. </span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment">     * @return struct Information about the dedicated ip pool
    335. 

  335. </span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment">     *     - name string this pool's name
    336. 

  336. </span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment">     *     - created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
    337. 

  337. </span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment">     *     - ips array the dedicated IPs in this pool
    338. 

  338. </span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment">     *         - ips[] struct information about each dedicated IP
    339. 

  339. </span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment">     *             - ip string the ip address
    340. 

  340. </span></span><span id="211" class="l"><a class="l" href="#211">211: </a><span class="php-comment">     *             - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    341. 

  341. </span></span><span id="212" class="l"><a class="l" href="#212">212: </a><span class="php-comment">     *             - pool string the name of the pool that this dedicated IP belongs to
    342. 

  342. </span></span><span id="213" class="l"><a class="l" href="#213">213: </a><span class="php-comment">     *             - domain string the domain name (reverse dns) of this dedicated IP
    343. 

  343. </span></span><span id="214" class="l"><a class="l" href="#214">214: </a><span class="php-comment">     *             - custom_dns struct information about the ip's custom dns, if it has been configured
    344. 

  344. </span></span><span id="215" class="l"><a class="l" href="#215">215: </a><span class="php-comment">     *                 - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    345. 

  345. </span></span><span id="216" class="l"><a class="l" href="#216">216: </a><span class="php-comment">     *                 - valid boolean whether the ip's custom dns is currently valid
    346. 

  346. </span></span><span id="217" class="l"><a class="l" href="#217">217: </a><span class="php-comment">     *                 - error string if the ip's custom dns is invalid, this will include details about the error
    347. 

  347. </span></span><span id="218" class="l"><a class="l" href="#218">218: </a><span class="php-comment">     *             - warmup struct information about the ip's warmup status
    348. 

  348. </span></span><span id="219" class="l"><a class="l" href="#219">219: </a><span class="php-comment">     *                 - warming_up boolean whether the ip is currently in warmup mode
    349. 

  349. </span></span><span id="220" class="l"><a class="l" href="#220">220: </a><span class="php-comment">     *                 - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    350. 

  350. </span></span><span id="221" class="l"><a class="l" href="#221">221: </a><span class="php-comment">     *                 - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    351. 

  351. </span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment">     */</span>
    352. 

  352. </span><span id="223" class="l"><a class="l" href="#223">223: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_createPool" href="#_createPool">createPool</a>(<span class="php-var">$pool</span>) {
    353. 

  353. </span><span id="224" class="l"><a class="l" href="#224">224: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
    354. 

  354. </span><span id="225" class="l"><a class="l" href="#225">225: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/create-pool'</span>, <span class="php-var">$_params</span>);
    355. 

  355. </span><span id="226" class="l"><a class="l" href="#226">226: </a>    }
    356. 

  356. </span><span id="227" class="l"><a class="l" href="#227">227: </a>
    357. 

  357. </span><span id="228" class="l"><a class="l" href="#228">228: </a>    <span class="php-comment">/**
    358. 

  358. </span></span><span id="229" class="l"><a class="l" href="#229">229: </a><span class="php-comment">     * Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
    359. 

  359. </span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment">     * @param string $pool the name of the pool to delete
    360. 

  360. </span></span><span id="231" class="l"><a class="l" href="#231">231: </a><span class="php-comment">     * @return struct information about the status of the pool that was deleted
    361. 

  361. </span></span><span id="232" class="l"><a class="l" href="#232">232: </a><span class="php-comment">     *     - pool string the name of the pool
    362. 

  362. </span></span><span id="233" class="l"><a class="l" href="#233">233: </a><span class="php-comment">     *     - deleted boolean whether the pool was deleted
    363. 

  363. </span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment">     */</span>
    364. 

  364. </span><span id="235" class="l"><a class="l" href="#235">235: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deletePool" href="#_deletePool">deletePool</a>(<span class="php-var">$pool</span>) {
    365. 

  365. </span><span id="236" class="l"><a class="l" href="#236">236: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
    366. 

  366. </span><span id="237" class="l"><a class="l" href="#237">237: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/delete-pool'</span>, <span class="php-var">$_params</span>);
    367. 

  367. </span><span id="238" class="l"><a class="l" href="#238">238: </a>    }
    368. 

  368. </span><span id="239" class="l"><a class="l" href="#239">239: </a>
    369. 

  369. </span><span id="240" class="l"><a class="l" href="#240">240: </a>    <span class="php-comment">/**
    370. 

  370. </span></span><span id="241" class="l"><a class="l" href="#241">241: </a><span class="php-comment">     * Tests whether a domain name is valid for use as the custom reverse
    371. 

  371. </span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment">DNS for a dedicated IP.
    372. 

  372. </span></span><span id="243" class="l"><a class="l" href="#243">243: </a><span class="php-comment">     * @param string $ip a dedicated ip address
    373. 

  373. </span></span><span id="244" class="l"><a class="l" href="#244">244: </a><span class="php-comment">     * @param string $domain the domain name to test
    374. 

  374. </span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment">     * @return struct validation results for the domain
    375. 

  375. </span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment">     *     - valid string whether the domain name has a correctly-configured A record pointing to the ip address
    376. 

  376. </span></span><span id="247" class="l"><a class="l" href="#247">247: </a><span class="php-comment">     *     - error string if valid is false, this will contain details about why the domain's A record is incorrect
    377. 

  377. </span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment">     */</span>
    378. 

  378. </span><span id="249" class="l"><a class="l" href="#249">249: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_checkCustomDns" href="#_checkCustomDns">checkCustomDns</a>(<span class="php-var">$ip</span>, <span class="php-var">$domain</span>) {
    379. 

  379. </span><span id="250" class="l"><a class="l" href="#250">250: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>, <span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
    380. 

  380. </span><span id="251" class="l"><a class="l" href="#251">251: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/check-custom-dns'</span>, <span class="php-var">$_params</span>);
    381. 

  381. </span><span id="252" class="l"><a class="l" href="#252">252: </a>    }
    382. 

  382. </span><span id="253" class="l"><a class="l" href="#253">253: </a>
    383. 

  383. </span><span id="254" class="l"><a class="l" href="#254">254: </a>    <span class="php-comment">/**
    384. 

  384. </span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment">     * Configures the custom DNS name for a dedicated IP.
    385. 

  385. </span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment">     * @param string $ip a dedicated ip address
    386. 

  386. </span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment">     * @param string $domain a domain name to set as the dedicated IP's custom dns name.
    387. 

  387. </span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment">     * @return struct information about the dedicated IP's new configuration
    388. 

  388. </span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment">     *     - ip string the ip address
    389. 

  389. </span></span><span id="260" class="l"><a class="l" href="#260">260: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
    390. 

  390. </span></span><span id="261" class="l"><a class="l" href="#261">261: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
    391. 

  391. </span></span><span id="262" class="l"><a class="l" href="#262">262: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
    392. 

  392. </span></span><span id="263" class="l"><a class="l" href="#263">263: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
    393. 

  393. </span></span><span id="264" class="l"><a class="l" href="#264">264: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
    394. 

  394. </span></span><span id="265" class="l"><a class="l" href="#265">265: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
    395. 

  395. </span></span><span id="266" class="l"><a class="l" href="#266">266: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
    396. 

  396. </span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
    397. 

  397. </span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
    398. 

  398. </span></span><span id="269" class="l"><a class="l" href="#269">269: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    399. 

  399. </span></span><span id="270" class="l"><a class="l" href="#270">270: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
    400. 

  400. </span></span><span id="271" class="l"><a class="l" href="#271">271: </a><span class="php-comment">     */</span>
    401. 

  401. </span><span id="272" class="l"><a class="l" href="#272">272: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setCustomDns" href="#_setCustomDns">setCustomDns</a>(<span class="php-var">$ip</span>, <span class="php-var">$domain</span>) {
    402. 

  402. </span><span id="273" class="l"><a class="l" href="#273">273: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>, <span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
    403. 

  403. </span><span id="274" class="l"><a class="l" href="#274">274: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/set-custom-dns'</span>, <span class="php-var">$_params</span>);
    404. 

  404. </span><span id="275" class="l"><a class="l" href="#275">275: </a>    }
    405. 

  405. </span><span id="276" class="l"><a class="l" href="#276">276: </a>
    406. 

  406. </span><span id="277" class="l"><a class="l" href="#277">277: </a>}
    407. 

  407. </span><span id="278" class="l"><a class="l" href="#278">278: </a>
    408. 

  408. </span><span id="279" class="l"><a class="l" href="#279">279: </a>
    409. 

  409. </span><span id="280" class="l"><a class="l" href="#280">280: </a></span></code></pre>
    410. 

  410. 

  411. 	<div id="footer">
    412. 

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

  413. 	</div>
    414. 

  414. </div>
    415. 

  415. </div>
    416. 

  416. </body>
    417. 

  417. </html>
    418.