FINAL suepr merge step : added all modules to this super repos

This commit is contained in:
Bachir Soussi Chiadmi
2015-04-19 16:46:59 +02:00
7585 changed files with 1723356 additions and 18 deletions

View File

@@ -0,0 +1,13 @@
Copyright 2013 The Rocket Science Group, LLC.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@@ -0,0 +1,18 @@
{
"name": "mandrill/mandrill",
"type": "library",
"version": "1.0.52",
"description": "API client library for the Mandrill email as a service platform",
"keywords": ["email", "api"],
"homepage": "https://bitbucket.org/mailchimp/mandrill-api-php",
"license": "Apache-2.0",
"authors": [{"name": "Mandrill Devs", "email": "community@mandrill.com", "homepage": "http://mandrill.com", "role": "Developer"}],
"require": {
"php": ">=5.2.0"
},
"autoload": {
"psr-0": {
"Mandrill": "src/"
}
}
}

View File

@@ -0,0 +1,142 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>Page not found</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Exception.html">Exception</a></li>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content">
<h1>Page not found</h1>
<p>The requested page could not be found.</p>
<p>You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.</p>
<p>To continue please try to find requested page in the menu, take a look at <a href="tree.html">the tree view</a> of the whole project or use search field on the top.</p>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,525 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Exception</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li><a href="namespace-None.html">None</a>
</li>
<li class="active"><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Exceptions</h3>
<ul>
<li class="active"><a href="class-Exception.html">Exception</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-PHP.html" title="Summary of PHP"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Exception</h1>
<div>
<h4>Direct known subclasses</h4>
<a href="class-Mandrill_Error.html">Mandrill_Error</a>
</div>
<div>
<h4>Indirect known subclasses</h4>
<a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a>,
<a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a>,
<a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a>,
<a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a>,
<a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a>,
<a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a>,
<a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a>,
<a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a>,
<a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a>,
<a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a>,
<a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a>,
<a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a>,
<a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a>,
<a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a>,
<a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a>,
<a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a>,
<a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a>,
<a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a>,
<a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a>,
<a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a>,
<a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a>,
<a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a>,
<a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a>,
<a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a>,
<a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a>,
<a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a>,
<a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a>,
<a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a>,
<a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a>,
<a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a>
</div>
<div class="info">
<b>PHP Extension:</b> <a href="http://php.net/manual" title="Go to PHP documentation">Core</a><br />
<b>Documented at</b> <a href="http://php.net/manual/class.exception.php" title="Go to PHP documentation">php.net</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="http://php.net/manual/exception.construct.php" title="Go to PHP documentation">__construct</a>( <span>mixed <var>$message</var></span>, <span>mixed <var>$code</var></span>, <span>mixed <var>$previous</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getMessage" id="_getMessage">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getMessage">#</a>
<code><a href="http://php.net/manual/exception.getmessage.php" title="Go to PHP documentation">getMessage</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getCode" id="_getCode">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getCode">#</a>
<code><a href="http://php.net/manual/exception.getcode.php" title="Go to PHP documentation">getCode</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getFile" id="_getFile">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getFile">#</a>
<code><a href="http://php.net/manual/exception.getfile.php" title="Go to PHP documentation">getFile</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getLine" id="_getLine">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getLine">#</a>
<code><a href="http://php.net/manual/exception.getline.php" title="Go to PHP documentation">getLine</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getTrace" id="_getTrace">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getTrace">#</a>
<code><a href="http://php.net/manual/exception.gettrace.php" title="Go to PHP documentation">getTrace</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getPrevious" id="_getPrevious">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getPrevious">#</a>
<code><a href="http://php.net/manual/exception.getprevious.php" title="Go to PHP documentation">getPrevious</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getTraceAsString" id="_getTraceAsString">
<td class="attributes"><code>
final public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getTraceAsString">#</a>
<code><a href="http://php.net/manual/exception.gettraceasstring.php" title="Go to PHP documentation">getTraceAsString</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="__toString" id="___toString">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___toString">#</a>
<code><a href="http://php.net/manual/exception.tostring.php" title="Go to PHP documentation">__toString</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="message" id="$message">
<td class="attributes"><code>
protected
string
</code></td>
<td class="name">
<a href="http://php.net/manual/class.exception.php#exception.props.message" title="Go to PHP documentation"><var>$message</var></a>
</td>
<td class="value"><code><span class="php-quote">''</span></code></td>
<td class="description"><div>
<a href="#$message" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="code" id="$code">
<td class="attributes"><code>
protected
integer
</code></td>
<td class="name">
<a href="http://php.net/manual/class.exception.php#exception.props.code" title="Go to PHP documentation"><var>$code</var></a>
</td>
<td class="value"><code><span class="php-num">0</span></code></td>
<td class="description"><div>
<a href="#$code" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="file" id="$file">
<td class="attributes"><code>
protected
mixed
</code></td>
<td class="name">
<a href="http://php.net/manual/class.exception.php#exception.props.file" title="Go to PHP documentation"><var>$file</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$file" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="line" id="$line">
<td class="attributes"><code>
protected
mixed
</code></td>
<td class="name">
<a href="http://php.net/manual/class.exception.php#exception.props.line" title="Go to PHP documentation"><var>$line</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$line" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,503 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill.html#20-159" title="Go to source code">Mandrill.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<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>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="__destruct" id="___destruct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___destruct">#</a>
<code><a href="source-class-Mandrill.html#93-95" title="Go to source code">__destruct</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="call" id="_call">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_call">#</a>
<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>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="readConfigs" id="_readConfigs">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_readConfigs">#</a>
<code><a href="source-class-Mandrill.html#138-147" title="Go to source code">readConfigs</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="castError" id="_castError">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_castError">#</a>
<code><a href="source-class-Mandrill.html#149-154" title="Go to source code">castError</a>( <span>mixed <var>$result</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="log" id="_log">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_log">#</a>
<code><a href="source-class-Mandrill.html#156-158" title="Go to source code">log</a>( <span>mixed <var>$msg</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary" id="properties">
<caption>Properties summary</caption>
<tr data-order="apikey" id="$apikey">
<td class="attributes"><code>
public
mixed
</code></td>
<td class="name">
<a href="source-class-Mandrill.html#22" title="Go to source code"><var>$apikey</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$apikey" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="ch" id="$ch">
<td class="attributes"><code>
public
mixed
</code></td>
<td class="name">
<a href="source-class-Mandrill.html#23" title="Go to source code"><var>$ch</var></a>
</td>
<td class="value"><code></code></td>
<td class="description"><div>
<a href="#$ch" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="root" id="$root">
<td class="attributes"><code>
public
string
</code></td>
<td class="name">
<a href="source-class-Mandrill.html#24" title="Go to source code"><var>$root</var></a>
</td>
<td class="value"><code><span class="php-quote">'https://mandrillapp.com/api/1.0'</span></code></td>
<td class="description"><div>
<a href="#$root" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="debug" id="$debug">
<td class="attributes"><code>
public
boolean
</code></td>
<td class="name">
<a href="source-class-Mandrill.html#25" title="Go to source code"><var>$debug</var></a>
</td>
<td class="value"><code><span class="php-keyword1">false</span></code></td>
<td class="description"><div>
<a href="#$debug" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="error_map" id="$error_map">
<td class="attributes"><code>
public static
array
</code></td>
<td class="name">
<a href="source-class-Mandrill.html#27-57" title="Go to source code"><var>$error_map</var></a>
</td>
<td class="value"><code><span class="php-keyword1">array</span>(
<span class="php-quote">&quot;ValidationError&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_ValidationError&quot;</span>,
<span class="php-quote">&quot;Invalid_Key&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Key&quot;</span>,
<span class="php-quote">&quot;PaymentRequired&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_PaymentRequired&quot;</span>,
<span class="php-quote">&quot;Unknown_Subaccount&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Subaccount&quot;</span>,
<span class="php-quote">&quot;Unknown_Template&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Template&quot;</span>,
<span class="php-quote">&quot;ServiceUnavailable&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_ServiceUnavailable&quot;</span>,
<span class="php-quote">&quot;Unknown_Message&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Message&quot;</span>,
<span class="php-quote">&quot;Invalid_Tag_Name&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Tag_Name&quot;</span>,
<span class="php-quote">&quot;Invalid_Reject&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Reject&quot;</span>,
<span class="php-quote">&quot;Unknown_Sender&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Sender&quot;</span>,
<span class="php-quote">&quot;Unknown_Url&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Url&quot;</span>,
<span class="php-quote">&quot;Unknown_TrackingDomain&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_TrackingDomain&quot;</span>,
<span class="php-quote">&quot;Invalid_Template&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Template&quot;</span>,
<span class="php-quote">&quot;Unknown_Webhook&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Webhook&quot;</span>,
<span class="php-quote">&quot;Unknown_InboundDomain&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_InboundDomain&quot;</span>,
<span class="php-quote">&quot;Unknown_InboundRoute&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_InboundRoute&quot;</span>,
<span class="php-quote">&quot;Unknown_Export&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Export&quot;</span>,
<span class="php-quote">&quot;IP_ProvisionLimit&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_IP_ProvisionLimit&quot;</span>,
<span class="php-quote">&quot;Unknown_Pool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Pool&quot;</span>,
<span class="php-quote">&quot;NoSendingHistory&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_NoSendingHistory&quot;</span>,
<span class="php-quote">&quot;PoorReputation&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_PoorReputation&quot;</span>,
<span class="php-quote">&quot;Unknown_IP&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_IP&quot;</span>,
<span class="php-quote">&quot;Invalid_EmptyDefaultPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_EmptyDefaultPool&quot;</span>,
<span class="php-quote">&quot;Invalid_DeleteDefaultPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_DeleteDefaultPool&quot;</span>,
<span class="php-quote">&quot;Invalid_DeleteNonEmptyPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_DeleteNonEmptyPool&quot;</span>,
<span class="php-quote">&quot;Invalid_CustomDNS&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_CustomDNS&quot;</span>,
<span class="php-quote">&quot;Invalid_CustomDNSPending&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_CustomDNSPending&quot;</span>,
<span class="php-quote">&quot;Metadata_FieldLimit&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Metadata_FieldLimit&quot;</span>,
<span class="php-quote">&quot;Unknown_MetadataField&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_MetadataField&quot;</span>
)</code></td>
<td class="description"><div>
<a href="#$error_map" class="anchor">#</a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,252 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Error</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li class="active"><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Error</h1>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Error</span></b>
</dd>
</dl>
<div>
<h4>Direct known subclasses</h4>
<a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a>,
<a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a>,
<a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a>,
<a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a>,
<a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a>,
<a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a>,
<a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a>,
<a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a>,
<a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a>,
<a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a>,
<a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a>,
<a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a>,
<a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a>,
<a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a>,
<a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a>,
<a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a>,
<a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a>,
<a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a>,
<a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a>,
<a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a>,
<a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a>,
<a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a>,
<a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a>,
<a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a>,
<a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a>,
<a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a>,
<a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a>,
<a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a>,
<a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a>,
<a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a>
</div>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Error.html#3" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,499 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Exports</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li class="active"><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Exports</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Exports.html#3-110" title="Go to source code">Mandrill/Exports.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Exports.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Exports.html#8-26" title="Go to source code">info</a>( <span>string <var>$id</var></span> )</code>
<div class="description short">
<p>Returns information about an export job. If the export job's state is
'complete', the returned data will include a URL you can use to fetch the
results. Every export job produces a zip archive, but the format of the archive
is distinct for each job type. The api calls that initiate exports include more
details about the output format for that job type.</p>
</div>
<div class="description detailed hidden">
<p>Returns information about an export job. If the export job's state is
'complete', the returned data will include a URL you can use to fetch the
results. Every export job produces a zip archive, but the format of the archive
is distinct for each job type. The api calls that initiate exports include more
details about the output format for that job type.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id an export job identifier</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information about the export - id string the unique identifier for this
Export. Use this identifier when checking the export job's status - created_at
string the date and time that the export job was created as a UTC string in
YYYY-MM-DD HH:MM:SS format - type string the type of the export job - activity,
reject, or whitelist - finished_at string the date and time that the export job
was finished as a UTC string in YYYY-MM-DD HH:MM:SS format - state string the
export job's state - waiting, working, complete, error, or expired. - result_url
string the url for the export job's results, if the job is completed.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Exports.html#28-42" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Returns a list of your exports.</p>
</div>
<div class="description detailed hidden">
<p>Returns a list of your exports.</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the account's exports - return[] struct the individual export info - id string
the unique identifier for this Export. Use this identifier when checking the
export job's status - created_at string the date and time that the export job
was created as a UTC string in YYYY-MM-DD HH:MM:SS format - type string the type
of the export job - activity, reject, or whitelist - finished_at string the date
and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS
format - state string the export job's state - waiting, working, complete,
error, or expired. - result_url string the url for the export job's results, if
the job is completed.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="rejects" id="_rejects">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_rejects">#</a>
<code><a href="source-class-Mandrill_Exports.html#44-60" title="Go to source code">rejects</a>( <span>string <var>$notify_email</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Begins an export of your rejection blacklist. The blacklist will be exported
to a zip archive containing a single file named rejects.csv that includes the
following fields: email, reason, detail, created_at, expires_at, last_event_at,
expires_at.</p>
</div>
<div class="description detailed hidden">
<p>Begins an export of your rejection blacklist. The blacklist will be exported
to a zip archive containing a single file named rejects.csv that includes the
following fields: email, reason, detail, created_at, expires_at, last_event_at,
expires_at.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$notify_email</var></dt>
<dd><code>string</code><br>$notify_email an optional email address to notify when the export job has
finished.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the rejects export job that was started - id string the unique
identifier for this Export. Use this identifier when checking the export job's
status - created_at string the date and time that the export job was created as
a UTC string in YYYY-MM-DD HH:MM:SS format - type string the type of the export
job - finished_at string the date and time that the export job was finished as a
UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run -
state string the export job's state - result_url string the url for the export
job's results, if the job is complete<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="whitelist" id="_whitelist">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_whitelist">#</a>
<code><a href="source-class-Mandrill_Exports.html#62-78" title="Go to source code">whitelist</a>( <span>string <var>$notify_email</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Begins an export of your rejection whitelist. The whitelist will be exported
to a zip archive containing a single file named whitelist.csv that includes the
following fields: email, detail, created_at.</p>
</div>
<div class="description detailed hidden">
<p>Begins an export of your rejection whitelist. The whitelist will be exported
to a zip archive containing a single file named whitelist.csv that includes the
following fields: email, detail, created_at.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$notify_email</var></dt>
<dd><code>string</code><br>$notify_email an optional email address to notify when the export job has
finished.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the whitelist export job that was started - id string the
unique identifier for this Export. Use this identifier when checking the export
job's status - created_at string the date and time that the export job was
created as a UTC string in YYYY-MM-DD HH:MM:SS format - type string the type of
the export job - finished_at string the date and time that the export job was
finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that
have not run - state string the export job's state - result_url string the url
for the export job's results, if the job is complete<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="activity" id="_activity">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_activity">#</a>
<code><a href="source-class-Mandrill_Exports.html#80-108" title="Go to source code">activity</a>( <span>string <var>$notify_email</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$date_from</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$date_to</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$tags</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$senders</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$states</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$api_keys</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Begins an export of your activity history. The activity will be exported to a
zip archive containing a single file named activity.csv in the same format as
you would be able to export from your account's activity view. It includes the
following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens,
Clicks, Bounce Detail. If you have configured any custom metadata fields, they
will be included in the exported data.</p>
</div>
<div class="description detailed hidden">
<p>Begins an export of your activity history. The activity will be exported to a
zip archive containing a single file named activity.csv in the same format as
you would be able to export from your account's activity view. It includes the
following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens,
Clicks, Bounce Detail. If you have configured any custom metadata fields, they
will be included in the exported data.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$notify_email</var></dt>
<dd><code>string</code><br>$notify_email an optional email address to notify when the export job has
finished</dd>
<dt><var>$date_from</var></dt>
<dd><code>string</code><br>$date_from start date as a UTC string in YYYY-MM-DD HH:MM:SS format</dd>
<dt><var>$date_to</var></dt>
<dd><code>string</code><br>$date_to end date as a UTC string in YYYY-MM-DD HH:MM:SS format</dd>
<dt><var>$tags</var></dt>
<dd><code>array</code><br>$tags an array of tag names to narrow the export to; will match messages that
contain ANY of the tags - tags[] string a tag name</dd>
<dt><var>$senders</var></dt>
<dd><code>array</code><br>$senders an array of senders to narrow the export to - senders[] string a sender
address</dd>
<dt><var>$states</var></dt>
<dd><code>array</code><br>$states an array of states to narrow the export to; messages with ANY of the
states will be included - states[] string a message state</dd>
<dt><var>$api_keys</var></dt>
<dd><code>array</code><br>$api_keys an array of api keys to narrow the export to; messsagse sent with ANY
of the keys will be included - api_keys[] string an API key associated with your
account</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the activity export job that was started - id string the
unique identifier for this Export. Use this identifier when checking the export
job's status - created_at string the date and time that the export job was
created as a UTC string in YYYY-MM-DD HH:MM:SS format - type string the type of
the export job - finished_at string the date and time that the export job was
finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that
have not run - state string the export job's state - result_url string the url
for the export job's results, if the job is complete<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,226 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_HttpError</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li class="active"><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_HttpError</h1>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_HttpError</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_HttpError.html#4" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_IP_ProvisionLimit</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li class="active"><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_IP_ProvisionLimit</h1>
<div class="description">
<p>A dedicated IP cannot be provisioned while another request is pending.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_IP_ProvisionLimit</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_IP_ProvisionLimit.html#91-94" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,641 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Inbound</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li class="active"><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Inbound</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Inbound.html#3-136" title="Go to source code">Mandrill/Inbound.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Inbound.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="domains" id="_domains">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_domains">#</a>
<code><a href="source-class-Mandrill_Inbound.html#8-19" title="Go to source code">domains</a>( )</code>
<div class="description short">
<p>List the domains that have been configured for inbound delivery</p>
</div>
<div class="description detailed hidden">
<p>List the domains that have been configured for inbound delivery</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the inbound domains associated with the account - return[] struct the individual
domain info - domain string the domain name that is accepting mail - created_at
string the date and time that the inbound domain was added as a UTC string in
YYYY-MM-DD HH:MM:SS format - valid_mx boolean true if this inbound domain has
successfully set up an MX record to deliver mail to the Mandrill servers<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="addDomain" id="_addDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_addDomain">#</a>
<code><a href="source-class-Mandrill_Inbound.html#21-32" title="Go to source code">addDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Add an inbound domain to your account</p>
</div>
<div class="description detailed hidden">
<p>Add an inbound domain to your account</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain a domain name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the domain - domain string the domain name that is accepting
mail - created_at string the date and time that the inbound domain was added as
a UTC string in YYYY-MM-DD HH:MM:SS format - valid_mx boolean true if this
inbound domain has successfully set up an MX record to deliver mail to the
Mandrill servers<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="checkDomain" id="_checkDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_checkDomain">#</a>
<code><a href="source-class-Mandrill_Inbound.html#34-45" title="Go to source code">checkDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Check the MX settings for an inbound domain. The domain must have already
been added with the add-domain call</p>
</div>
<div class="description detailed hidden">
<p>Check the MX settings for an inbound domain. The domain must have already
been added with the add-domain call</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain an existing inbound domain</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the inbound domain - domain string the domain name that is
accepting mail - created_at string the date and time that the inbound domain was
added as a UTC string in YYYY-MM-DD HH:MM:SS format - valid_mx boolean true if
this inbound domain has successfully set up an MX record to deliver mail to the
Mandrill servers<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="deleteDomain" id="_deleteDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deleteDomain">#</a>
<code><a href="source-class-Mandrill_Inbound.html#47-58" title="Go to source code">deleteDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Delete an inbound domain from the account. All mail will stop routing for
this domain immediately.</p>
</div>
<div class="description detailed hidden">
<p>Delete an inbound domain from the account. All mail will stop routing for
this domain immediately.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain an existing inbound domain</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the deleted domain - domain string the domain name that is
accepting mail - created_at string the date and time that the inbound domain was
added as a UTC string in YYYY-MM-DD HH:MM:SS format - valid_mx boolean true if
this inbound domain has successfully set up an MX record to deliver mail to the
Mandrill servers<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="routes" id="_routes">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_routes">#</a>
<code><a href="source-class-Mandrill_Inbound.html#60-72" title="Go to source code">routes</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>List the mailbox routes defined for an inbound domain</p>
</div>
<div class="description detailed hidden">
<p>List the mailbox routes defined for an inbound domain</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain the domain to check</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the routes associated with the domain - return[] struct the individual mailbox
route - id string the unique identifier of the route - pattern string the search
pattern that the mailbox name should match - url string the webhook URL where
inbound messages will be published<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="addRoute" id="_addRoute">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_addRoute">#</a>
<code><a href="source-class-Mandrill_Inbound.html#74-87" title="Go to source code">addRoute</a>( <span>string <var>$domain</var></span>, <span>string <var>$pattern</var></span>, <span>string <var>$url</var></span> )</code>
<div class="description short">
<p>Add a new mailbox route to an inbound domain</p>
</div>
<div class="description detailed hidden">
<p>Add a new mailbox route to an inbound domain</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain an existing inbound domain</dd>
<dt><var>$pattern</var></dt>
<dd><code>string</code><br>$pattern the search pattern that the mailbox name should match</dd>
<dt><var>$url</var></dt>
<dd><code>string</code><br>$url the webhook URL where the inbound messages will be published</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the added mailbox route information - id string the unique identifier of the
route - pattern string the search pattern that the mailbox name should match -
url string the webhook URL where inbound messages will be published<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="updateRoute" id="_updateRoute">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_updateRoute">#</a>
<code><a href="source-class-Mandrill_Inbound.html#89-102" title="Go to source code">updateRoute</a>( <span>string <var>$id</var></span>, <span>string <var>$pattern</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$url</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Update the pattern or webhook of an existing inbound mailbox route. If null
is provided for any fields, the values will remain unchanged.</p>
</div>
<div class="description detailed hidden">
<p>Update the pattern or webhook of an existing inbound mailbox route. If null
is provided for any fields, the values will remain unchanged.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of an existing mailbox route</dd>
<dt><var>$pattern</var></dt>
<dd><code>string</code><br>$pattern the search pattern that the mailbox name should match</dd>
<dt><var>$url</var></dt>
<dd><code>string</code><br>$url the webhook URL where the inbound messages will be published</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the updated mailbox route information - id string the unique identifier of the
route - pattern string the search pattern that the mailbox name should match -
url string the webhook URL where inbound messages will be published<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="deleteRoute" id="_deleteRoute">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deleteRoute">#</a>
<code><a href="source-class-Mandrill_Inbound.html#104-115" title="Go to source code">deleteRoute</a>( <span>string <var>$id</var></span> )</code>
<div class="description short">
<p>Delete an existing inbound mailbox route</p>
</div>
<div class="description detailed hidden">
<p>Delete an existing inbound mailbox route</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of an existing route</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the deleted mailbox route information - id string the unique identifier of the
route - pattern string the search pattern that the mailbox name should match -
url string the webhook URL where inbound messages will be published<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="sendRaw" id="_sendRaw">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_sendRaw">#</a>
<code><a href="source-class-Mandrill_Inbound.html#117-134" title="Go to source code">sendRaw</a>( <span>string <var>$raw_message</var></span>, <span>array|null <var>$to</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$mail_from</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$helo</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$client_address</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Take a raw MIME document destined for a domain with inbound domains set up,
and send it to the inbound hook exactly as if it had been sent over SMTP</p>
</div>
<div class="description detailed hidden">
<p>Take a raw MIME document destined for a domain with inbound domains set up,
and send it to the inbound hook exactly as if it had been sent over SMTP</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$raw_message</var></dt>
<dd><code>string</code><br>$raw_message the full MIME document of an email message</dd>
<dt><var>$to</var></dt>
<dd><code>array|null</code><br>$to optionally define the recipients to receive the message - otherwise we'll
use the To, Cc, and Bcc headers provided in the document - to[] string the email
address of the recipient</dd>
<dt><var>$mail_from</var></dt>
<dd><code>string</code><br>$mail_from the address specified in the MAIL FROM stage of the SMTP
conversation. Required for the SPF check.</dd>
<dt><var>$helo</var></dt>
<dd><code>string</code><br>$helo the identification provided by the client mta in the MTA state of the SMTP
conversation. Required for the SPF check.</dd>
<dt><var>$client_address</var></dt>
<dd><code>string</code><br>$client_address the remote MTA's ip address. Optional; required for the SPF
check.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>an array of the information for each recipient in the message (usually one) that
matched an inbound route - return[] struct the individual recipient information
- email string the email address of the matching recipient - pattern string the
mailbox route pattern that the recipient matched - url string the webhook URL
that the message was posted to<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,210 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Internal</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li class="active"><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Internal</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Internal.html#3-8" title="Go to source code">Mandrill/Internal.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Internal.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,232 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_CustomDNS</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li class="active"><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_CustomDNS</h1>
<div class="description">
<p>The domain name is not configured for use as the dedicated IP's custom
reverse DNS.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_CustomDNS</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_CustomDNS.html#131-134" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_CustomDNSPending</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li class="active"><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_CustomDNSPending</h1>
<div class="description">
<p>A custom DNS change for this dedicated IP is currently pending.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_CustomDNSPending</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_CustomDNSPending.html#136-139" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_DeleteDefaultPool</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li class="active"><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_DeleteDefaultPool</h1>
<div class="description">
<p>The default pool cannot be deleted.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_DeleteDefaultPool</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_DeleteDefaultPool.html#121-124" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_DeleteNonEmptyPool</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li class="active"><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_DeleteNonEmptyPool</h1>
<div class="description">
<p>Non-empty pools cannot be deleted.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_DeleteNonEmptyPool</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_DeleteNonEmptyPool.html#126-129" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_EmptyDefaultPool</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li class="active"><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_EmptyDefaultPool</h1>
<div class="description">
<p>You cannot remove the last IP from your default IP pool.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_EmptyDefaultPool</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_EmptyDefaultPool.html#116-119" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_Key</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_Key</h1>
<div class="description">
<p>The provided API key is not a valid Mandrill API key</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_Key</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_Key.html#11-14" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_Reject</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_Reject</h1>
<div class="description">
<p>The requested email is not in the rejection list</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_Reject</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_Reject.html#46-49" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_Tag_Name</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_Tag_Name</h1>
<div class="description">
<p>The requested tag does not exist or contains invalid characters</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_Tag_Name</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_Tag_Name.html#41-44" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Invalid_Template</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Invalid_Template</h1>
<div class="description">
<p>The given template name already exists or contains invalid characters</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Invalid_Template</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Invalid_Template.html#66-69" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,900 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Ips</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li class="active"><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Ips</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Ips.html#3-277" title="Go to source code">Mandrill/Ips.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Ips.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Ips.html#8-28" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Lists your dedicated IPs.</p>
</div>
<div class="description detailed hidden">
<p>Lists your dedicated IPs.</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>an array of structs for each dedicated IP - return[] struct information about a
single dedicated IP - ip string the ip address - 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 - pool string the name of the pool that this dedicated IP belongs to -
domain string the domain name (reverse dns) of this dedicated IP - custom_dns
struct information about the ip's custom dns, if it has been configured -
enabled boolean a boolean indicating whether custom dns has been configured for
this ip - valid boolean whether the ip's custom dns is currently valid - error
string if the ip's custom dns is invalid, this will include details about the
error - warmup struct information about the ip's warmup status - warming_up
boolean whether the ip is currently in warmup mode - start_at string the start
time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format -
end_at string the end date and time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Ips.html#30-50" title="Go to source code">info</a>( <span>string <var>$ip</var></span> )</code>
<div class="description short">
<p>Retrieves information about a single dedicated ip.</p>
</div>
<div class="description detailed hidden">
<p>Retrieves information about a single dedicated ip.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip a dedicated IP address</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>Information about the dedicated ip - ip string the ip address - 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 - pool string the name of the pool that this
dedicated IP belongs to - domain string the domain name (reverse dns) of this
dedicated IP - custom_dns struct information about the ip's custom dns, if it
has been configured - enabled boolean a boolean indicating whether custom dns
has been configured for this ip - valid boolean whether the ip's custom dns is
currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="provision" id="_provision">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_provision">#</a>
<code><a href="source-class-Mandrill_Ips.html#52-64" title="Go to source code">provision</a>( <span>boolean <var>$warmup</var> = <span class="php-keyword1">false</span></span>, <span>string <var>$pool</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Requests an additional dedicated IP for your account. Accounts may have one
outstanding request at any time, and provisioning requests are processed within
24 hours.</p>
</div>
<div class="description detailed hidden">
<p>Requests an additional dedicated IP for your account. Accounts may have one
outstanding request at any time, and provisioning requests are processed within
24 hours.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$warmup</var></dt>
<dd><code>boolean</code><br>$warmup whether to enable warmup mode for the ip</dd>
<dt><var>$pool</var></dt>
<dd><code>string</code><br>$pool the id of the pool to add the dedicated ip to, or null to use your
account's default pool</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a description of the provisioning request that was created - requested_at string
the date and time that the request was created as a UTC timestamp in YYYY-MM-DD
HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="startWarmup" id="_startWarmup">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_startWarmup">#</a>
<code><a href="source-class-Mandrill_Ips.html#66-89" title="Go to source code">startWarmup</a>( <span>string <var>$ip</var></span> )</code>
<div class="description short">
<p>Begins the warmup process for a dedicated IP. During the warmup process,
Mandrill will gradually increase the percentage of your mail that is sent over
the warming-up IP, over a period of roughly 30 days. The rest of your mail will
be sent over shared IPs or other dedicated IPs in the same pool.</p>
</div>
<div class="description detailed hidden">
<p>Begins the warmup process for a dedicated IP. During the warmup process,
Mandrill will gradually increase the percentage of your mail that is sent over
the warming-up IP, over a period of roughly 30 days. The rest of your mail will
be sent over shared IPs or other dedicated IPs in the same pool.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip a dedicated ip address</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>Information about the dedicated IP - ip string the ip address - 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 - pool string the name of the pool that this
dedicated IP belongs to - domain string the domain name (reverse dns) of this
dedicated IP - custom_dns struct information about the ip's custom dns, if it
has been configured - enabled boolean a boolean indicating whether custom dns
has been configured for this ip - valid boolean whether the ip's custom dns is
currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="cancelWarmup" id="_cancelWarmup">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_cancelWarmup">#</a>
<code><a href="source-class-Mandrill_Ips.html#91-111" title="Go to source code">cancelWarmup</a>( <span>string <var>$ip</var></span> )</code>
<div class="description short">
<p>Cancels the warmup process for a dedicated IP.</p>
</div>
<div class="description detailed hidden">
<p>Cancels the warmup process for a dedicated IP.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip a dedicated ip address</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>Information about the dedicated IP - ip string the ip address - 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 - pool string the name of the pool that this
dedicated IP belongs to - domain string the domain name (reverse dns) of this
dedicated IP - custom_dns struct information about the ip's custom dns, if it
has been configured - enabled boolean a boolean indicating whether custom dns
has been configured for this ip - valid boolean whether the ip's custom dns is
currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="setPool" id="_setPool">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setPool">#</a>
<code><a href="source-class-Mandrill_Ips.html#113-135" title="Go to source code">setPool</a>( <span>string <var>$ip</var></span>, <span>string <var>$pool</var></span>, <span>boolean <var>$create_pool</var> = <span class="php-keyword1">false</span></span> )</code>
<div class="description short">
<p>Moves a dedicated IP to a different pool.</p>
</div>
<div class="description detailed hidden">
<p>Moves a dedicated IP to a different pool.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip a dedicated ip address</dd>
<dt><var>$pool</var></dt>
<dd><code>string</code><br>$pool the name of the new pool to add the dedicated ip to</dd>
<dt><var>$create_pool</var></dt>
<dd><code>boolean</code><br>$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.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>Information about the updated state of the dedicated IP - ip string the ip
address - 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 - pool string the name of the pool
that this dedicated IP belongs to - domain string the domain name (reverse dns)
of this dedicated IP - custom_dns struct information about the ip's custom dns,
if it has been configured - enabled boolean a boolean indicating whether custom
dns has been configured for this ip - valid boolean whether the ip's custom dns
is currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Ips.html#137-147" title="Go to source code">delete</a>( <span>string <var>$ip</var></span> )</code>
<div class="description short">
<p>Deletes a dedicated IP. This is permanent and cannot be undone.</p>
</div>
<div class="description detailed hidden">
<p>Deletes a dedicated IP. This is permanent and cannot be undone.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip the dedicated ip to remove from your account</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a description of the ip that was removed from your account. - ip string the ip
address - deleted string a boolean indicating whether the ip was successfully
deleted<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="listPools" id="_listPools">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_listPools">#</a>
<code><a href="source-class-Mandrill_Ips.html#149-173" title="Go to source code">listPools</a>( )</code>
<div class="description short">
<p>Lists your dedicated IP pools.</p>
</div>
<div class="description detailed hidden">
<p>Lists your dedicated IP pools.</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the dedicated IP pools for your account, up to a maximum of 1,000 - return[]
struct information about each dedicated IP pool - name string this pool's name -
created_at string the date and time that this pool was created as a UTC
timestamp in YYYY-MM-DD HH:MM:SS format - ips array the dedicated IPs in this
pool - ips[] struct information about each dedicated IP - ip string the ip
address - 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 - pool string the name of the pool
that this dedicated IP belongs to - domain string the domain name (reverse dns)
of this dedicated IP - custom_dns struct information about the ip's custom dns,
if it has been configured - enabled boolean a boolean indicating whether custom
dns has been configured for this ip - valid boolean whether the ip's custom dns
is currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="poolInfo" id="_poolInfo">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_poolInfo">#</a>
<code><a href="source-class-Mandrill_Ips.html#175-199" title="Go to source code">poolInfo</a>( <span>string <var>$pool</var></span> )</code>
<div class="description short">
<p>Describes a single dedicated IP pool.</p>
</div>
<div class="description detailed hidden">
<p>Describes a single dedicated IP pool.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$pool</var></dt>
<dd><code>string</code><br>$pool a pool name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>Information about the dedicated ip pool - name string this pool's name -
created_at string the date and time that this pool was created as a UTC
timestamp in YYYY-MM-DD HH:MM:SS format - ips array the dedicated IPs in this
pool - ips[] struct information about each dedicated IP - ip string the ip
address - 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 - pool string the name of the pool
that this dedicated IP belongs to - domain string the domain name (reverse dns)
of this dedicated IP - custom_dns struct information about the ip's custom dns,
if it has been configured - enabled boolean a boolean indicating whether custom
dns has been configured for this ip - valid boolean whether the ip's custom dns
is currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="createPool" id="_createPool">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_createPool">#</a>
<code><a href="source-class-Mandrill_Ips.html#201-226" title="Go to source code">createPool</a>( <span>string <var>$pool</var></span> )</code>
<div class="description short">
<p>Creates a pool and returns it. If a pool already exists with this name, no
action will be performed.</p>
</div>
<div class="description detailed hidden">
<p>Creates a pool and returns it. If a pool already exists with this name, no
action will be performed.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$pool</var></dt>
<dd><code>string</code><br>$pool the name of a pool to create</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>Information about the dedicated ip pool - name string this pool's name -
created_at string the date and time that this pool was created as a UTC
timestamp in YYYY-MM-DD HH:MM:SS format - ips array the dedicated IPs in this
pool - ips[] struct information about each dedicated IP - ip string the ip
address - 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 - pool string the name of the pool
that this dedicated IP belongs to - domain string the domain name (reverse dns)
of this dedicated IP - custom_dns struct information about the ip's custom dns,
if it has been configured - enabled boolean a boolean indicating whether custom
dns has been configured for this ip - valid boolean whether the ip's custom dns
is currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="deletePool" id="_deletePool">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deletePool">#</a>
<code><a href="source-class-Mandrill_Ips.html#228-238" title="Go to source code">deletePool</a>( <span>string <var>$pool</var></span> )</code>
<div class="description short">
<p>Deletes a pool. A pool must be empty before you can delete it, and you cannot
delete your default pool.</p>
</div>
<div class="description detailed hidden">
<p>Deletes a pool. A pool must be empty before you can delete it, and you cannot
delete your default pool.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$pool</var></dt>
<dd><code>string</code><br>$pool the name of the pool to delete</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the status of the pool that was deleted - pool string the name
of the pool - deleted boolean whether the pool was deleted<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="checkCustomDns" id="_checkCustomDns">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_checkCustomDns">#</a>
<code><a href="source-class-Mandrill_Ips.html#240-252" title="Go to source code">checkCustomDns</a>( <span>string <var>$ip</var></span>, <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Tests whether a domain name is valid for use as the custom reverse DNS for a
dedicated IP.</p>
</div>
<div class="description detailed hidden">
<p>Tests whether a domain name is valid for use as the custom reverse DNS for a
dedicated IP.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip a dedicated ip address</dd>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain the domain name to test</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>validation results for the domain - valid string whether the domain name has a
correctly-configured A record pointing to the ip address - error string if valid
is false, this will contain details about why the domain's A record is incorrect<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="setCustomDns" id="_setCustomDns">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setCustomDns">#</a>
<code><a href="source-class-Mandrill_Ips.html#254-275" title="Go to source code">setCustomDns</a>( <span>string <var>$ip</var></span>, <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Configures the custom DNS name for a dedicated IP.</p>
</div>
<div class="description detailed hidden">
<p>Configures the custom DNS name for a dedicated IP.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$ip</var></dt>
<dd><code>string</code><br>$ip a dedicated ip address</dd>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain a domain name to set as the dedicated IP's custom dns name.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the dedicated IP's new configuration - ip string the ip
address - 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 - pool string the name of the pool
that this dedicated IP belongs to - domain string the domain name (reverse dns)
of this dedicated IP - custom_dns struct information about the ip's custom dns,
if it has been configured - enabled boolean a boolean indicating whether custom
dns has been configured for this ip - valid boolean whether the ip's custom dns
is currently valid - error string if the ip's custom dns is invalid, this will
include details about the error - warmup struct information about the ip's
warmup status - warming_up boolean whether the ip is currently in warmup mode -
start_at string the start time for the warmup process as a UTC string in
YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup
process as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,396 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Metadata</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li class="active"><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Metadata</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Metadata.html#3-62" title="Go to source code">Mandrill/Metadata.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Metadata.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Metadata.html#8-19" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Get the list of custom metadata fields indexed for the account.</p>
</div>
<div class="description detailed hidden">
<p>Get the list of custom metadata fields indexed for the account.</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the custom metadata fields for the account - return[] struct the individual
custom metadata field info - name string the unique identifier of the metadata
field to update - state string the current state of the metadata field, one of
"active", "delete", or "index" - view_template string Mustache template to
control how the metadata is rendered in your activity log<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="add" id="_add">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_add">#</a>
<code><a href="source-class-Mandrill_Metadata.html#21-33" title="Go to source code">add</a>( <span>string <var>$name</var></span>, <span>string <var>$view_template</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Add a new custom metadata field to be indexed for the account.</p>
</div>
<div class="description detailed hidden">
<p>Add a new custom metadata field to be indexed for the account.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name a unique identifier for the metadata field</dd>
<dt><var>$view_template</var></dt>
<dd><code>string</code><br>$view_template optional Mustache template to control how the metadata is
rendered in your activity log</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information saved about the new metadata field - name string the unique
identifier of the metadata field to update - state string the current state of
the metadata field, one of "active", "delete", or "index" - view_template string
Mustache template to control how the metadata is rendered in your activity log<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="update" id="_update">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_update">#</a>
<code><a href="source-class-Mandrill_Metadata.html#35-47" title="Go to source code">update</a>( <span>string <var>$name</var></span>, <span>string <var>$view_template</var></span> )</code>
<div class="description short">
<p>Update an existing custom metadata field.</p>
</div>
<div class="description detailed hidden">
<p>Update an existing custom metadata field.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the unique identifier of the metadata field to update</dd>
<dt><var>$view_template</var></dt>
<dd><code>string</code><br>$view_template optional Mustache template to control how the metadata is
rendered in your activity log</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the updated metadata field - name string the unique
identifier of the metadata field to update - state string the current state of
the metadata field, one of "active", "delete", or "index" - view_template string
Mustache template to control how the metadata is rendered in your activity log<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Metadata.html#49-60" title="Go to source code">delete</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Delete an existing custom metadata field. Deletion isn't instataneous, and
/metadata/list will continue to return the field until the asynchronous deletion
process is complete.</p>
</div>
<div class="description detailed hidden">
<p>Delete an existing custom metadata field. Deletion isn't instataneous, and
/metadata/list will continue to return the field until the asynchronous deletion
process is complete.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the unique identifier of the metadata field to update</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the deleted metadata field - name string the unique
identifier of the metadata field to update - state string the current state of
the metadata field, one of "active", "delete", or "index" - view_template string
Mustache template to control how the metadata is rendered in your activity log<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Metadata_FieldLimit</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li class="active"><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Metadata_FieldLimit</h1>
<div class="description">
<p>Custom metadata field limit reached.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Metadata_FieldLimit</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Metadata_FieldLimit.html#141-144" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_NoSendingHistory</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li class="active"><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_NoSendingHistory</h1>
<div class="description">
<p>The user hasn't started sending yet.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_NoSendingHistory</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_NoSendingHistory.html#101-104" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_PaymentRequired</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li class="active"><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_PaymentRequired</h1>
<div class="description">
<p>The requested feature requires payment.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_PaymentRequired</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_PaymentRequired.html#16-19" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_PoorReputation</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li class="active"><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_PoorReputation</h1>
<div class="description">
<p>The user's reputation is too low to continue.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_PoorReputation</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_PoorReputation.html#106-109" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,394 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Rejects</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li class="active"><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Rejects</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Rejects.html#3-78" title="Go to source code">Mandrill/Rejects.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Rejects.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="add" id="_add">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_add">#</a>
<code><a href="source-class-Mandrill_Rejects.html#8-23" title="Go to source code">add</a>( <span>string <var>$email</var></span>, <span>string <var>$comment</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$subaccount</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Adds an email to your email rejection blacklist. Addresses that you add
manually will never expire and there is no reputation penalty for removing them
from your blacklist. Attempting to blacklist an address that has been
whitelisted will have no effect.</p>
</div>
<div class="description detailed hidden">
<p>Adds an email to your email rejection blacklist. Addresses that you add
manually will never expire and there is no reputation penalty for removing them
from your blacklist. Attempting to blacklist an address that has been
whitelisted will have no effect.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$email</var></dt>
<dd><code>string</code><br>$email an email address to block</dd>
<dt><var>$comment</var></dt>
<dd><code>string</code><br>$comment an optional comment describing the rejection</dd>
<dt><var>$subaccount</var></dt>
<dd><code>string</code><br>$subaccount an optional unique identifier for the subaccount to limit the
blacklist entry</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a status object containing the address and the result of the operation - email
string the email address you provided - added boolean whether the operation
succeeded<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Rejects.html#25-60" title="Go to source code">getList</a>( <span>string <var>$email</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$include_expired</var> = <span class="php-keyword1">false</span></span>, <span>string <var>$subaccount</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Retrieves your email rejection blacklist. You can provide an email address to
limit the results. Returns up to 1000 results. By default, entries that have
expired are excluded from the results; set include_expired to true to include
them.</p>
</div>
<div class="description detailed hidden">
<p>Retrieves your email rejection blacklist. You can provide an email address to
limit the results. Returns up to 1000 results. By default, entries that have
expired are excluded from the results; set include_expired to true to include
them.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$email</var></dt>
<dd><code>string</code><br>$email an optional email address to search by</dd>
<dt><var>$include_expired</var></dt>
<dd><code>boolean</code><br>$include_expired whether to include rejections that have already expired.</dd>
<dt><var>$subaccount</var></dt>
<dd><code>string</code><br>$subaccount an optional unique identifier for the subaccount to limit the
blacklist</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>Up to 1000 rejection entries - return[] struct the information for each
rejection blacklist entry - email string the email that is blocked - reason
string the type of event (hard-bounce, soft-bounce, spam, unsub) that caused
this rejection - detail string extended details about the event, such as the
SMTP diagnostic for bounces or the comment for manually-created rejections -
created_at string when the email was added to the blacklist - last_event_at
string the timestamp of the most recent event that either created or renewed
this rejection - expires_at string when the blacklist entry will expire (this
may be in the past) - expired boolean whether the blacklist entry has expired -
sender struct the sender that this blacklist entry applies to, or null if none.
- address string the sender's email address - created_at string the date and
time that the sender was first seen by Mandrill as a UTC date string in
YYYY-MM-DD HH:MM:SS format - sent integer the total number of messages sent by
this sender - hard_bounces integer the total number of hard bounces by messages
by this sender - soft_bounces integer the total number of soft bounces by
messages by this sender - rejects integer the total number of rejected messages
by this sender - complaints integer the total number of spam complaints received
for messages by this sender - unsubs integer the total number of unsubscribe
requests received for messages by this sender - opens integer the total number
of times messages by this sender have been opened - clicks integer the total
number of times tracked URLs in messages by this sender have been clicked -
unique_opens integer the number of unique opens for emails sent for this sender
- unique_clicks integer the number of unique clicks for emails sent for this
sender - subaccount string the subaccount that this blacklist entry applies to,
or null if none.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Rejects.html#62-76" title="Go to source code">delete</a>( <span>string <var>$email</var></span>, <span>string <var>$subaccount</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Deletes an email rejection. There is no limit to how many rejections you can
remove from your blacklist, but keep in mind that each deletion has an affect on
your reputation.</p>
</div>
<div class="description detailed hidden">
<p>Deletes an email rejection. There is no limit to how many rejections you can
remove from your blacklist, but keep in mind that each deletion has an affect on
your reputation.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$email</var></dt>
<dd><code>string</code><br>$email an email address</dd>
<dt><var>$subaccount</var></dt>
<dd><code>string</code><br>$subaccount an optional unique identifier for the subaccount to limit the
blacklist deletion</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a status object containing the address and whether the deletion succeeded. -
email string the email address that was removed from the blacklist - deleted
boolean whether the address was deleted successfully. - subaccount string the
subaccount blacklist that the address was removed from, if any<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,680 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Senders</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li class="active"><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Senders</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Senders.html#3-216" title="Go to source code">Mandrill/Senders.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Senders.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Senders.html#8-28" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Return the senders that have tried to use this account.</p>
</div>
<div class="description detailed hidden">
<p>Return the senders that have tried to use this account.</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>an array of sender data, one for each sending addresses used by the account -
return[] struct the information on each sending address in the account - address
string the sender's email address - created_at string the date and time that the
sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS
format - sent integer the total number of messages sent by this sender -
hard_bounces integer the total number of hard bounces by messages by this sender
- soft_bounces integer the total number of soft bounces by messages by this
sender - rejects integer the total number of rejected messages by this sender -
complaints integer the total number of spam complaints received for messages by
this sender - unsubs integer the total number of unsubscribe requests received
for messages by this sender - opens integer the total number of times messages
by this sender have been opened - clicks integer the total number of times
tracked URLs in messages by this sender have been clicked - unique_opens integer
the number of unique opens for emails sent for this sender - unique_clicks
integer the number of unique clicks for emails sent for this sender<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="domains" id="_domains">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_domains">#</a>
<code><a href="source-class-Mandrill_Senders.html#30-51" title="Go to source code">domains</a>( )</code>
<div class="description short">
<p>Returns the sender domains that have been added to this account.</p>
</div>
<div class="description detailed hidden">
<p>Returns the sender domains that have been added to this account.</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>an array of sender domain data, one for each sending domain used by the account
- return[] struct the information on each sending domain for the account -
domain string the sender domain name - created_at string the date and time that
the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
- last_tested_at string when the domain's DNS settings were last tested as a UTC
string in YYYY-MM-DD HH:MM:SS format - spf struct details about the domain's SPF
record - valid boolean whether the domain's SPF record is valid for use with
Mandrill - valid_after string when the domain's SPF record will be considered
valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If
set, this indicates that the record is valid now, but was previously invalid,
and Mandrill will wait until the record's TTL elapses to start using it. - error
string an error describing the spf record, or null if the record is correct -
dkim struct details about the domain's DKIM record - valid boolean whether the
domain's DKIM record is valid for use with Mandrill - valid_after string when
the domain's DKIM record will be considered valid for use with Mandrill as a UTC
string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is
valid now, but was previously invalid, and Mandrill will wait until the record's
TTL elapses to start using it. - error string an error describing the DKIM
record, or null if the record is correct - verified_at string if the domain has
been verified, this indicates when that verification occurred as a UTC string in
YYYY-MM-DD HH:MM:SS format - valid_signing boolean whether this domain can be
used to authenticate mail, either for itself or as a custom signing domain. If
this is false but spf and dkim are both valid, you will need to verify the
domain before using it to authenticate mail<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="addDomain" id="_addDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_addDomain">#</a>
<code><a href="source-class-Mandrill_Senders.html#53-75" title="Go to source code">addDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Adds a sender domain to your account. Sender domains are added automatically
as you send, but you can use this call to add them ahead of time.</p>
</div>
<div class="description detailed hidden">
<p>Adds a sender domain to your account. Sender domains are added automatically
as you send, but you can use this call to add them ahead of time.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain a domain name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the domain - domain string the sender domain name - created_at
string the date and time that the sending domain was first seen as a UTC string
in YYYY-MM-DD HH:MM:SS format - last_tested_at string when the domain's DNS
settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format - spf
struct details about the domain's SPF record - valid boolean whether the
domain's SPF record is valid for use with Mandrill - valid_after string when the
domain's SPF record will be considered valid for use with Mandrill as a UTC
string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is
valid now, but was previously invalid, and Mandrill will wait until the record's
TTL elapses to start using it. - error string an error describing the spf
record, or null if the record is correct - dkim struct details about the
domain's DKIM record - valid boolean whether the domain's DKIM record is valid
for use with Mandrill - valid_after string when the domain's DKIM record will be
considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS
format. If set, this indicates that the record is valid now, but was previously
invalid, and Mandrill will wait until the record's TTL elapses to start using
it. - error string an error describing the DKIM record, or null if the record is
correct - verified_at string if the domain has been verified, this indicates
when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format -
valid_signing boolean whether this domain can be used to authenticate mail,
either for itself or as a custom signing domain. If this is false but spf and
dkim are both valid, you will need to verify the domain before using it to
authenticate mail<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="checkDomain" id="_checkDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_checkDomain">#</a>
<code><a href="source-class-Mandrill_Senders.html#77-99" title="Go to source code">checkDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Checks the SPF and DKIM settings for a domain. If you haven't already added
this domain to your account, it will be added automatically.</p>
</div>
<div class="description detailed hidden">
<p>Checks the SPF and DKIM settings for a domain. If you haven't already added
this domain to your account, it will be added automatically.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain a domain name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the sender domain - domain string the sender domain name -
created_at string the date and time that the sending domain was first seen as a
UTC string in YYYY-MM-DD HH:MM:SS format - last_tested_at string when the
domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS
format - spf struct details about the domain's SPF record - valid boolean
whether the domain's SPF record is valid for use with Mandrill - valid_after
string when the domain's SPF record will be considered valid for use with
Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates
that the record is valid now, but was previously invalid, and Mandrill will wait
until the record's TTL elapses to start using it. - error string an error
describing the spf record, or null if the record is correct - dkim struct
details about the domain's DKIM record - valid boolean whether the domain's DKIM
record is valid for use with Mandrill - valid_after string when the domain's
DKIM record will be considered valid for use with Mandrill as a UTC string in
YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now,
but was previously invalid, and Mandrill will wait until the record's TTL
elapses to start using it. - error string an error describing the DKIM record,
or null if the record is correct - verified_at string if the domain has been
verified, this indicates when that verification occurred as a UTC string in
YYYY-MM-DD HH:MM:SS format - valid_signing boolean whether this domain can be
used to authenticate mail, either for itself or as a custom signing domain. If
this is false but spf and dkim are both valid, you will need to verify the
domain before using it to authenticate mail<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="verifyDomain" id="_verifyDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_verifyDomain">#</a>
<code><a href="source-class-Mandrill_Senders.html#101-117" title="Go to source code">verifyDomain</a>( <span>string <var>$domain</var></span>, <span>string <var>$mailbox</var></span> )</code>
<div class="description short">
<p>Sends a verification email in order to verify ownership of a domain. Domain
verification is an optional step to confirm ownership of a domain. Once a domain
has been verified in a Mandrill account, other accounts may not have their
messages signed by that domain unless they also verify the domain. This prevents
other Mandrill accounts from sending mail signed by your domain.</p>
</div>
<div class="description detailed hidden">
<p>Sends a verification email in order to verify ownership of a domain. Domain
verification is an optional step to confirm ownership of a domain. Once a domain
has been verified in a Mandrill account, other accounts may not have their
messages signed by that domain unless they also verify the domain. This prevents
other Mandrill accounts from sending mail signed by your domain.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain a domain name at which you can receive email</dd>
<dt><var>$mailbox</var></dt>
<dd><code>string</code><br>$mailbox a mailbox at the domain where the verification email should be sent</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the verification that was sent - status string "sent"
indicates that the verification has been sent, "already_verified" indicates that
the domain has already been verified with your account - domain string the
domain name you provided - email string the email address the verification email
was sent to<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Senders.html#119-193" title="Go to source code">info</a>( <span>string <var>$address</var></span> )</code>
<div class="description short">
<p>Return more detailed information about a single sender, including aggregates
of recent stats</p>
</div>
<div class="description detailed hidden">
<p>Return more detailed information about a single sender, including aggregates
of recent stats</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$address</var></dt>
<dd><code>string</code><br>$address the email address of the sender</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the detailed information on the sender - address string the sender's email
address - created_at string the date and time that the sender was first seen by
Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent integer the
total number of messages sent by this sender - hard_bounces integer the total
number of hard bounces by messages by this sender - soft_bounces integer the
total number of soft bounces by messages by this sender - rejects integer the
total number of rejected messages by this sender - complaints integer the total
number of spam complaints received for messages by this sender - unsubs integer
the total number of unsubscribe requests received for messages by this sender -
opens integer the total number of times messages by this sender have been opened
- clicks integer the total number of times tracked URLs in messages by this
sender have been clicked - stats struct an aggregate summary of the sender's
sending stats - today struct stats for this sender so far today - sent integer
the number of emails sent for this sender so far today - hard_bounces integer
the number of emails hard bounced for this sender so far today - soft_bounces
integer the number of emails soft bounced for this sender so far today - rejects
integer the number of emails rejected for sending this sender so far today -
complaints integer the number of spam complaints for this sender so far today -
unsubs integer the number of unsubscribes for this sender so far today - opens
integer the number of times emails have been opened for this sender so far today
- unique_opens integer the number of unique opens for emails sent for this
sender so far today - clicks integer the number of URLs that have been clicked
for this sender so far today - unique_clicks integer the number of unique clicks
for emails sent for this sender so far today - last<sub>7</sub>_days struct
stats for this sender in the last 7 days - sent integer the number of emails
sent for this sender in the last 7 days - hard_bounces integer the number of
emails hard bounced for this sender in the last 7 days - soft_bounces integer
the number of emails soft bounced for this sender in the last 7 days - rejects
integer the number of emails rejected for sending this sender in the last 7 days
- complaints integer the number of spam complaints for this sender in the last 7
days - unsubs integer the number of unsubscribes for this sender in the last 7
days - opens integer the number of times emails have been opened for this sender
in the last 7 days - unique_opens integer the number of unique opens for emails
sent for this sender in the last 7 days - clicks integer the number of URLs that
have been clicked for this sender in the last 7 days - unique_clicks integer the
number of unique clicks for emails sent for this sender in the last 7 days -
last<sub>30</sub>_days struct stats for this sender in the last 30 days - sent
integer the number of emails sent for this sender in the last 30 days -
hard_bounces integer the number of emails hard bounced for this sender in the
last 30 days - soft_bounces integer the number of emails soft bounced for this
sender in the last 30 days - rejects integer the number of emails rejected for
sending this sender in the last 30 days - complaints integer the number of spam
complaints for this sender in the last 30 days - unsubs integer the number of
unsubscribes for this sender in the last 30 days - opens integer the number of
times emails have been opened for this sender in the last 30 days - unique_opens
integer the number of unique opens for emails sent for this sender in the last
30 days - clicks integer the number of URLs that have been clicked for this
sender in the last 30 days - unique_clicks integer the number of unique clicks
for emails sent for this sender in the last 30 days - last<sub>60</sub>_days
struct stats for this sender in the last 60 days - sent integer the number of
emails sent for this sender in the last 60 days - hard_bounces integer the
number of emails hard bounced for this sender in the last 60 days - soft_bounces
integer the number of emails soft bounced for this sender in the last 60 days -
rejects integer the number of emails rejected for sending this sender in the
last 60 days - complaints integer the number of spam complaints for this sender
in the last 60 days - unsubs integer the number of unsubscribes for this sender
in the last 60 days - opens integer the number of times emails have been opened
for this sender in the last 60 days - unique_opens integer the number of unique
opens for emails sent for this sender in the last 60 days - clicks integer the
number of URLs that have been clicked for this sender in the last 60 days -
unique_clicks integer the number of unique clicks for emails sent for this
sender in the last 60 days - last<sub>90</sub>_days struct stats for this sender
in the last 90 days - sent integer the number of emails sent for this sender in
the last 90 days - hard_bounces integer the number of emails hard bounced for
this sender in the last 90 days - soft_bounces integer the number of emails soft
bounced for this sender in the last 90 days - rejects integer the number of
emails rejected for sending this sender in the last 90 days - complaints integer
the number of spam complaints for this sender in the last 90 days - unsubs
integer the number of unsubscribes for this sender in the last 90 days - opens
integer the number of times emails have been opened for this sender in the last
90 days - unique_opens integer the number of unique opens for emails sent for
this sender in the last 90 days - clicks integer the number of URLs that have
been clicked for this sender in the last 90 days - unique_clicks integer the
number of unique clicks for emails sent for this sender in the last 90 days<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="timeSeries" id="_timeSeries">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_timeSeries">#</a>
<code><a href="source-class-Mandrill_Senders.html#195-214" title="Go to source code">timeSeries</a>( <span>string <var>$address</var></span> )</code>
<div class="description short">
<p>Return the recent history (hourly stats for the last 30 days) for a
sender</p>
</div>
<div class="description detailed hidden">
<p>Return the recent history (hourly stats for the last 30 days) for a
sender</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$address</var></dt>
<dd><code>string</code><br>$address the email address of the sender</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the array of history information - return[] struct the stats for a single hour -
time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent
integer the number of emails that were sent during the hour - hard_bounces
integer the number of emails that hard bounced during the hour - soft_bounces
integer the number of emails that soft bounced during the hour - rejects integer
the number of emails that were rejected during the hour - complaints integer the
number of spam complaints received during the hour - opens integer the number of
emails opened during the hour - unique_opens integer the number of unique opens
generated by messages sent during the hour - clicks integer the number of
tracked URLs clicked during the hour - unique_clicks integer the number of
unique clicks generated by messages sent during the hour<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_ServiceUnavailable</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li class="active"><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_ServiceUnavailable</h1>
<div class="description">
<p>The subsystem providing this API call is down for maintenance</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_ServiceUnavailable</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_ServiceUnavailable.html#31-34" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,634 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Subaccounts</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li class="active"><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Subaccounts</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Subaccounts.html#3-169" title="Go to source code">Mandrill/Subaccounts.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#8-27" title="Go to source code">getList</a>( <span>string <var>$q</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Get the list of subaccounts defined for the account, optionally filtered by a
prefix</p>
</div>
<div class="description detailed hidden">
<p>Get the list of subaccounts defined for the account, optionally filtered by a
prefix</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$q</var></dt>
<dd><code>string</code><br>$q an optional prefix to filter the subaccounts' ids and names</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the subaccounts for the account, up to a maximum of 1,000 - return[] struct the
individual subaccount info - id string a unique indentifier for the subaccount -
name string an optional display name for the subaccount - custom_quota integer
an optional manual hourly quota for the subaccount. If not specified, the hourly
quota will be managed based on reputation - status string the current sending
status of the subaccount, one of "active" or "paused" - reputation integer the
subaccount's current reputation on a scale from 0 to 100 - created_at string the
date and time that the subaccount was created as a UTC string in YYYY-MM-DD
HH:MM:SS format - first_sent_at string the date and time that the subaccount
first sent as a UTC string in YYYY-MM-DD HH:MM:SS format - sent_weekly integer
the number of emails the subaccount has sent so far this week (weeks start on
midnight Monday, UTC) - sent_monthly integer the number of emails the subaccount
has sent so far this month (months start on midnight of the 1st, UTC) -
sent_total integer the number of emails the subaccount has sent since it was
created<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="add" id="_add">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_add">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#29-50" title="Go to source code">add</a>( <span>string <var>$id</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$notes</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$custom_quota</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Add a new subaccount</p>
</div>
<div class="description detailed hidden">
<p>Add a new subaccount</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id a unique identifier for the subaccount to be used in sending calls</dd>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name an optional display name to further identify the subaccount</dd>
<dt><var>$notes</var></dt>
<dd><code>string</code><br>$notes optional extra text to associate with the subaccount</dd>
<dt><var>$custom_quota</var></dt>
<dd><code>integer</code><br>$custom_quota an optional manual hourly quota for the subaccount. If not
specified, Mandrill will manage this based on reputation</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information saved about the new subaccount - id string a unique indentifier
for the subaccount - name string an optional display name for the subaccount -
custom_quota integer an optional manual hourly quota for the subaccount. If not
specified, the hourly quota will be managed based on reputation - status string
the current sending status of the subaccount, one of "active" or "paused" -
reputation integer the subaccount's current reputation on a scale from 0 to 100
- created_at string the date and time that the subaccount was created as a UTC
string in YYYY-MM-DD HH:MM:SS format - first_sent_at string the date and time
that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format -
sent_weekly integer the number of emails the subaccount has sent so far this
week (weeks start on midnight Monday, UTC) - sent_monthly integer the number of
emails the subaccount has sent so far this month (months start on midnight of
the 1st, UTC) - sent_total integer the number of emails the subaccount has sent
since it was created<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#52-84" title="Go to source code">info</a>( <span>string <var>$id</var></span> )</code>
<div class="description short">
<p>Given the ID of an existing subaccount, return the data about it</p>
</div>
<div class="description detailed hidden">
<p>Given the ID of an existing subaccount, return the data about it</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of the subaccount to query</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information about the subaccount - id string a unique indentifier for the
subaccount - name string an optional display name for the subaccount - notes
string optional extra text to associate with the subaccount - custom_quota
integer an optional manual hourly quota for the subaccount. If not specified,
the hourly quota will be managed based on reputation - status string the current
sending status of the subaccount, one of "active" or "paused" - reputation
integer the subaccount's current reputation on a scale from 0 to 100 -
created_at string the date and time that the subaccount was created as a UTC
string in YYYY-MM-DD HH:MM:SS format - first_sent_at string the date and time
that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format -
sent_weekly integer the number of emails the subaccount has sent so far this
week (weeks start on midnight Monday, UTC) - sent_monthly integer the number of
emails the subaccount has sent so far this month (months start on midnight of
the 1st, UTC) - sent_total integer the number of emails the subaccount has sent
since it was created - sent_hourly integer the number of emails the subaccount
has sent in the last hour - hourly_quota integer the current hourly quota for
the subaccount, either manual or reputation-based - last<sub>30</sub>_days
struct stats for this subaccount in the last 30 days - sent integer the number
of emails sent for this subaccount in the last 30 days - hard_bounces integer
the number of emails hard bounced for this subaccount in the last 30 days -
soft_bounces integer the number of emails soft bounced for this subaccount in
the last 30 days - rejects integer the number of emails rejected for sending
this subaccount in the last 30 days - complaints integer the number of spam
complaints for this subaccount in the last 30 days - unsubs integer the number
of unsbuscribes for this subaccount in the last 30 days - opens integer the
number of times emails have been opened for this subaccount in the last 30 days
- unique_opens integer the number of unique opens for emails sent for this
subaccount in the last 30 days - clicks integer the number of URLs that have
been clicked for this subaccount in the last 30 days - unique_clicks integer the
number of unique clicks for emails sent for this subaccount in the last 30 days<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="update" id="_update">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_update">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#86-107" title="Go to source code">update</a>( <span>string <var>$id</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$notes</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$custom_quota</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Update an existing subaccount</p>
</div>
<div class="description detailed hidden">
<p>Update an existing subaccount</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of the subaccount to update</dd>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name an optional display name to further identify the subaccount</dd>
<dt><var>$notes</var></dt>
<dd><code>string</code><br>$notes optional extra text to associate with the subaccount</dd>
<dt><var>$custom_quota</var></dt>
<dd><code>integer</code><br>$custom_quota an optional manual hourly quota for the subaccount. If not
specified, Mandrill will manage this based on reputation</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the updated subaccount - id string a unique indentifier for
the subaccount - name string an optional display name for the subaccount -
custom_quota integer an optional manual hourly quota for the subaccount. If not
specified, the hourly quota will be managed based on reputation - status string
the current sending status of the subaccount, one of "active" or "paused" -
reputation integer the subaccount's current reputation on a scale from 0 to 100
- created_at string the date and time that the subaccount was created as a UTC
string in YYYY-MM-DD HH:MM:SS format - first_sent_at string the date and time
that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format -
sent_weekly integer the number of emails the subaccount has sent so far this
week (weeks start on midnight Monday, UTC) - sent_monthly integer the number of
emails the subaccount has sent so far this month (months start on midnight of
the 1st, UTC) - sent_total integer the number of emails the subaccount has sent
since it was created<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#109-127" title="Go to source code">delete</a>( <span>string <var>$id</var></span> )</code>
<div class="description short">
<p>Delete an existing subaccount. Any email related to the subaccount will be
saved, but stats will be removed and any future sending calls to this subaccount
will fail.</p>
</div>
<div class="description detailed hidden">
<p>Delete an existing subaccount. Any email related to the subaccount will be
saved, but stats will be removed and any future sending calls to this subaccount
will fail.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of the subaccount to delete</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the deleted subaccount - id string a unique indentifier for
the subaccount - name string an optional display name for the subaccount -
custom_quota integer an optional manual hourly quota for the subaccount. If not
specified, the hourly quota will be managed based on reputation - status string
the current sending status of the subaccount, one of "active" or "paused" -
reputation integer the subaccount's current reputation on a scale from 0 to 100
- created_at string the date and time that the subaccount was created as a UTC
string in YYYY-MM-DD HH:MM:SS format - first_sent_at string the date and time
that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format -
sent_weekly integer the number of emails the subaccount has sent so far this
week (weeks start on midnight Monday, UTC) - sent_monthly integer the number of
emails the subaccount has sent so far this month (months start on midnight of
the 1st, UTC) - sent_total integer the number of emails the subaccount has sent
since it was created<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="pause" id="_pause">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_pause">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#129-147" title="Go to source code">pause</a>( <span>string <var>$id</var></span> )</code>
<div class="description short">
<p>Pause a subaccount's sending. Any future emails delivered to this subaccount
will be queued for a maximum of 3 days until the subaccount is resumed.</p>
</div>
<div class="description detailed hidden">
<p>Pause a subaccount's sending. Any future emails delivered to this subaccount
will be queued for a maximum of 3 days until the subaccount is resumed.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of the subaccount to pause</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the paused subaccount - id string a unique indentifier for
the subaccount - name string an optional display name for the subaccount -
custom_quota integer an optional manual hourly quota for the subaccount. If not
specified, the hourly quota will be managed based on reputation - status string
the current sending status of the subaccount, one of "active" or "paused" -
reputation integer the subaccount's current reputation on a scale from 0 to 100
- created_at string the date and time that the subaccount was created as a UTC
string in YYYY-MM-DD HH:MM:SS format - first_sent_at string the date and time
that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format -
sent_weekly integer the number of emails the subaccount has sent so far this
week (weeks start on midnight Monday, UTC) - sent_monthly integer the number of
emails the subaccount has sent so far this month (months start on midnight of
the 1st, UTC) - sent_total integer the number of emails the subaccount has sent
since it was created<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="resume" id="_resume">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_resume">#</a>
<code><a href="source-class-Mandrill_Subaccounts.html#149-167" title="Go to source code">resume</a>( <span>string <var>$id</var></span> )</code>
<div class="description short">
<p>Resume a paused subaccount's sending</p>
</div>
<div class="description detailed hidden">
<p>Resume a paused subaccount's sending</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>string</code><br>$id the unique identifier of the subaccount to resume</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the resumed subaccount - id string a unique indentifier for
the subaccount - name string an optional display name for the subaccount -
custom_quota integer an optional manual hourly quota for the subaccount. If not
specified, the hourly quota will be managed based on reputation - status string
the current sending status of the subaccount, one of "active" or "paused" -
reputation integer the subaccount's current reputation on a scale from 0 to 100
- created_at string the date and time that the subaccount was created as a UTC
string in YYYY-MM-DD HH:MM:SS format - first_sent_at string the date and time
that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format -
sent_weekly integer the number of emails the subaccount has sent so far this
week (weeks start on midnight Monday, UTC) - sent_monthly integer the number of
emails the subaccount has sent so far this month (months start on midnight of
the 1st, UTC) - sent_total integer the number of emails the subaccount has sent
since it was created<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,534 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Tags</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li class="active"><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Tags</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Tags.html#3-172" title="Go to source code">Mandrill/Tags.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Tags.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Tags.html#8-28" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Return all of the user-defined tag information</p>
</div>
<div class="description detailed hidden">
<p>Return all of the user-defined tag information</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>a list of user-defined tags - return[] struct a user-defined tag - tag string
the actual tag as a string - reputation integer the tag's current reputation on
a scale from 0 to 100. - sent integer the total number of messages sent with
this tag - hard_bounces integer the total number of hard bounces by messages
with this tag - soft_bounces integer the total number of soft bounces by
messages with this tag - rejects integer the total number of rejected messages
with this tag - complaints integer the total number of spam complaints received
for messages with this tag - unsubs integer the total number of unsubscribe
requests received for messages with this tag - opens integer the total number of
times messages with this tag have been opened - clicks integer the total number
of times tracked URLs in messages with this tag have been clicked - unique_opens
integer the number of unique opens for emails sent with this tag - unique_clicks
integer the number of unique clicks for emails sent with this tag<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Tags.html#30-52" title="Go to source code">delete</a>( <span>string <var>$tag</var></span> )</code>
<div class="description short">
<p>Deletes a tag permanently. Deleting a tag removes the tag from any messages
that have been sent, and also deletes the tag's stats. There is no way to undo
this operation, so use it carefully.</p>
</div>
<div class="description detailed hidden">
<p>Deletes a tag permanently. Deleting a tag removes the tag from any messages
that have been sent, and also deletes the tag's stats. There is no way to undo
this operation, so use it carefully.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$tag</var></dt>
<dd><code>string</code><br>$tag a tag name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the tag that was deleted - tag string the actual tag as a string - reputation
integer the tag's current reputation on a scale from 0 to 100. - sent integer
the total number of messages sent with this tag - hard_bounces integer the total
number of hard bounces by messages with this tag - soft_bounces integer the
total number of soft bounces by messages with this tag - rejects integer the
total number of rejected messages with this tag - complaints integer the total
number of spam complaints received for messages with this tag - unsubs integer
the total number of unsubscribe requests received for messages with this tag -
opens integer the total number of times messages with this tag have been opened
- clicks integer the total number of times tracked URLs in messages with this
tag have been clicked - unique_opens integer the number of unique opens for
emails sent with this tag - unique_clicks integer the number of unique clicks
for emails sent with this tag<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Tags.html#54-127" title="Go to source code">info</a>( <span>string <var>$tag</var></span> )</code>
<div class="description short">
<p>Return more detailed information about a single tag, including aggregates of
recent stats</p>
</div>
<div class="description detailed hidden">
<p>Return more detailed information about a single tag, including aggregates of
recent stats</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$tag</var></dt>
<dd><code>string</code><br>$tag an existing tag name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the detailed information on the tag - tag string the actual tag as a string -
sent integer the total number of messages sent with this tag - hard_bounces
integer the total number of hard bounces by messages with this tag -
soft_bounces integer the total number of soft bounces by messages with this tag
- rejects integer the total number of rejected messages with this tag -
complaints integer the total number of spam complaints received for messages
with this tag - unsubs integer the total number of unsubscribe requests received
for messages with this tag - opens integer the total number of times messages
with this tag have been opened - clicks integer the total number of times
tracked URLs in messages with this tag have been clicked - stats struct an
aggregate summary of the tag's sending stats - today struct stats with this tag
so far today - sent integer the number of emails sent with this tag so far today
- hard_bounces integer the number of emails hard bounced with this tag so far
today - soft_bounces integer the number of emails soft bounced with this tag so
far today - rejects integer the number of emails rejected for sending this tag
so far today - complaints integer the number of spam complaints with this tag so
far today - unsubs integer the number of unsubscribes with this tag so far today
- opens integer the number of times emails have been opened with this tag so far
today - unique_opens integer the number of unique opens for emails sent with
this tag so far today - clicks integer the number of URLs that have been clicked
with this tag so far today - unique_clicks integer the number of unique clicks
for emails sent with this tag so far today - last<sub>7</sub>_days struct stats
with this tag in the last 7 days - sent integer the number of emails sent with
this tag in the last 7 days - hard_bounces integer the number of emails hard
bounced with this tag in the last 7 days - soft_bounces integer the number of
emails soft bounced with this tag in the last 7 days - rejects integer the
number of emails rejected for sending this tag in the last 7 days - complaints
integer the number of spam complaints with this tag in the last 7 days - unsubs
integer the number of unsubscribes with this tag in the last 7 days - opens
integer the number of times emails have been opened with this tag in the last 7
days - unique_opens integer the number of unique opens for emails sent with this
tag in the last 7 days - clicks integer the number of URLs that have been
clicked with this tag in the last 7 days - unique_clicks integer the number of
unique clicks for emails sent with this tag in the last 7 days -
last<sub>30</sub>_days struct stats with this tag in the last 30 days - sent
integer the number of emails sent with this tag in the last 30 days -
hard_bounces integer the number of emails hard bounced with this tag in the last
30 days - soft_bounces integer the number of emails soft bounced with this tag
in the last 30 days - rejects integer the number of emails rejected for sending
this tag in the last 30 days - complaints integer the number of spam complaints
with this tag in the last 30 days - unsubs integer the number of unsubscribes
with this tag in the last 30 days - opens integer the number of times emails
have been opened with this tag in the last 30 days - unique_opens integer the
number of unique opens for emails sent with this tag in the last 30 days -
clicks integer the number of URLs that have been clicked with this tag in the
last 30 days - unique_clicks integer the number of unique clicks for emails sent
with this tag in the last 30 days - last<sub>60</sub>_days struct stats with
this tag in the last 60 days - sent integer the number of emails sent with this
tag in the last 60 days - hard_bounces integer the number of emails hard bounced
with this tag in the last 60 days - soft_bounces integer the number of emails
soft bounced with this tag in the last 60 days - rejects integer the number of
emails rejected for sending this tag in the last 60 days - complaints integer
the number of spam complaints with this tag in the last 60 days - unsubs integer
the number of unsubscribes with this tag in the last 60 days - opens integer the
number of times emails have been opened with this tag in the last 60 days -
unique_opens integer the number of unique opens for emails sent with this tag in
the last 60 days - clicks integer the number of URLs that have been clicked with
this tag in the last 60 days - unique_clicks integer the number of unique clicks
for emails sent with this tag in the last 60 days - last<sub>90</sub>_days
struct stats with this tag in the last 90 days - sent integer the number of
emails sent with this tag in the last 90 days - hard_bounces integer the number
of emails hard bounced with this tag in the last 90 days - soft_bounces integer
the number of emails soft bounced with this tag in the last 90 days - rejects
integer the number of emails rejected for sending this tag in the last 90 days -
complaints integer the number of spam complaints with this tag in the last 90
days - unsubs integer the number of unsubscribes with this tag in the last 90
days - opens integer the number of times emails have been opened with this tag
in the last 90 days - unique_opens integer the number of unique opens for emails
sent with this tag in the last 90 days - clicks integer the number of URLs that
have been clicked with this tag in the last 90 days - unique_clicks integer the
number of unique clicks for emails sent with this tag in the last 90 days<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="timeSeries" id="_timeSeries">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_timeSeries">#</a>
<code><a href="source-class-Mandrill_Tags.html#129-149" title="Go to source code">timeSeries</a>( <span>string <var>$tag</var></span> )</code>
<div class="description short">
<p>Return the recent history (hourly stats for the last 30 days) for a tag</p>
</div>
<div class="description detailed hidden">
<p>Return the recent history (hourly stats for the last 30 days) for a tag</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$tag</var></dt>
<dd><code>string</code><br>$tag an existing tag name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the array of history information - return[] struct the stats for a single hour -
time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent
integer the number of emails that were sent during the hour - hard_bounces
integer the number of emails that hard bounced during the hour - soft_bounces
integer the number of emails that soft bounced during the hour - rejects integer
the number of emails that were rejected during the hour - complaints integer the
number of spam complaints received during the hour - unsubs integer the number
of unsubscribes received during the hour - opens integer the number of emails
opened during the hour - unique_opens integer the number of unique opens
generated by messages sent during the hour - clicks integer the number of
tracked URLs clicked during the hour - unique_clicks integer the number of
unique clicks generated by messages sent during the hour<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="allTimeSeries" id="_allTimeSeries">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_allTimeSeries">#</a>
<code><a href="source-class-Mandrill_Tags.html#151-170" title="Go to source code">allTimeSeries</a>( )</code>
<div class="description short">
<p>Return the recent history (hourly stats for the last 30 days) for all
tags</p>
</div>
<div class="description detailed hidden">
<p>Return the recent history (hourly stats for the last 30 days) for all
tags</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the array of history information - return[] struct the stats for a single hour -
time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent
integer the number of emails that were sent during the hour - hard_bounces
integer the number of emails that hard bounced during the hour - soft_bounces
integer the number of emails that soft bounced during the hour - rejects integer
the number of emails that were rejected during the hour - complaints integer the
number of spam complaints received during the hour - unsubs integer the number
of unsubscribes received during the hour - opens integer the number of emails
opened during the hour - unique_opens integer the number of unique opens
generated by messages sent during the hour - clicks integer the number of
tracked URLs clicked during the hour - unique_clicks integer the number of
unique clicks generated by messages sent during the hour<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,738 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Templates</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li class="active"><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Templates</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Templates.html#3-233" title="Go to source code">Mandrill/Templates.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Templates.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="add" id="_add">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_add">#</a>
<code><a href="source-class-Mandrill_Templates.html#8-42" title="Go to source code">add</a>( <span>string <var>$name</var></span>, <span>string <var>$from_email</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$from_name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$subject</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$code</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$text</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$publish</var> = <span class="php-keyword1">true</span></span>, <span>array <var>$labels</var> = <span class="php-keyword1">array</span>()</span> )</code>
<div class="description short">
<p>Add a new template</p>
</div>
<div class="description detailed hidden">
<p>Add a new template</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the name for the new template - must be unique</dd>
<dt><var>$from_email</var></dt>
<dd><code>string</code><br>$from_email a default sending address for emails sent using this template</dd>
<dt><var>$from_name</var></dt>
<dd><code>string</code><br>$from_name a default from name to be used</dd>
<dt><var>$subject</var></dt>
<dd><code>string</code><br>$subject a default subject line to be used</dd>
<dt><var>$code</var></dt>
<dd><code>string</code><br>$code the HTML code for the template with mc:edit attributes for the editable
elements</dd>
<dt><var>$text</var></dt>
<dd><code>string</code><br>$text a default text part to be used when sending with this template</dd>
<dt><var>$publish</var></dt>
<dd><code>boolean</code><br>$publish set to false to add a draft template without publishing</dd>
<dt><var>$labels</var></dt>
<dd><code>array</code><br>$labels an optional array of up to 10 labels to use for filtering templates -
labels[] string a single label</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information saved about the new template - slug string the immutable unique
code name of the template - name string the name of the template - labels array
the list of labels applied to the template - labels[] string a single label -
code string the full HTML code of the template, with mc:edit attributes marking
the editable elements - draft version - subject string the subject line of the
template, if provided - draft version - from_email string the default sender
address for the template, if provided - draft version - from_name string the
default sender from name for the template, if provided - draft version - text
string the default text part of messages sent with the template, if provided -
draft version - publish_name string the same as the template name - kept as a
separate field for backwards compatibility - publish_code string the full HTML
code of the template, with mc:edit attributes marking the editable elements that
are available as published, if it has been published - publish_subject string
the subject line of the template, if provided - publish_from_email string the
default sender address for the template, if provided - publish_from_name string
the default sender from name for the template, if provided - publish_text string
the default text part of messages sent with the template, if provided -
published_at string the date and time the template was last published as a UTC
string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
created_at string the date and time the template was first created as a UTC
string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Templates.html#44-70" title="Go to source code">info</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Get the information for an existing template</p>
</div>
<div class="description detailed hidden">
<p>Get the information for an existing template</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the immutable name of an existing template</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the requested template information - slug string the immutable unique code name
of the template - name string the name of the template - labels array the list
of labels applied to the template - labels[] string a single label - code string
the full HTML code of the template, with mc:edit attributes marking the editable
elements - draft version - subject string the subject line of the template, if
provided - draft version - from_email string the default sender address for the
template, if provided - draft version - from_name string the default sender from
name for the template, if provided - draft version - text string the default
text part of messages sent with the template, if provided - draft version -
publish_name string the same as the template name - kept as a separate field for
backwards compatibility - publish_code string the full HTML code of the
template, with mc:edit attributes marking the editable elements that are
available as published, if it has been published - publish_subject string the
subject line of the template, if provided - publish_from_email string the
default sender address for the template, if provided - publish_from_name string
the default sender from name for the template, if provided - publish_text string
the default text part of messages sent with the template, if provided -
published_at string the date and time the template was last published as a UTC
string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
created_at string the date and time the template was first created as a UTC
string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="update" id="_update">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_update">#</a>
<code><a href="source-class-Mandrill_Templates.html#72-106" title="Go to source code">update</a>( <span>string <var>$name</var></span>, <span>string <var>$from_email</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$from_name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$subject</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$code</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$text</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$publish</var> = <span class="php-keyword1">true</span></span>, <span>array <var>$labels</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Update the code for an existing template. If null is provided for any fields,
the values will remain unchanged.</p>
</div>
<div class="description detailed hidden">
<p>Update the code for an existing template. If null is provided for any fields,
the values will remain unchanged.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the immutable name of an existing template</dd>
<dt><var>$from_email</var></dt>
<dd><code>string</code><br>$from_email the new default sending address</dd>
<dt><var>$from_name</var></dt>
<dd><code>string</code><br>$from_name the new default from name</dd>
<dt><var>$subject</var></dt>
<dd><code>string</code><br>$subject the new default subject line</dd>
<dt><var>$code</var></dt>
<dd><code>string</code><br>$code the new code for the template</dd>
<dt><var>$text</var></dt>
<dd><code>string</code><br>$text the new default text part to be used</dd>
<dt><var>$publish</var></dt>
<dd><code>boolean</code><br>$publish set to false to update the draft version of the template without
publishing</dd>
<dt><var>$labels</var></dt>
<dd><code>array</code><br>$labels an optional array of up to 10 labels to use for filtering templates -
labels[] string a single label</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the template that was updated - slug string the immutable unique code name of
the template - name string the name of the template - labels array the list of
labels applied to the template - labels[] string a single label - code string
the full HTML code of the template, with mc:edit attributes marking the editable
elements - draft version - subject string the subject line of the template, if
provided - draft version - from_email string the default sender address for the
template, if provided - draft version - from_name string the default sender from
name for the template, if provided - draft version - text string the default
text part of messages sent with the template, if provided - draft version -
publish_name string the same as the template name - kept as a separate field for
backwards compatibility - publish_code string the full HTML code of the
template, with mc:edit attributes marking the editable elements that are
available as published, if it has been published - publish_subject string the
subject line of the template, if provided - publish_from_email string the
default sender address for the template, if provided - publish_from_name string
the default sender from name for the template, if provided - publish_text string
the default text part of messages sent with the template, if provided -
published_at string the date and time the template was last published as a UTC
string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
created_at string the date and time the template was first created as a UTC
string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="publish" id="_publish">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_publish">#</a>
<code><a href="source-class-Mandrill_Templates.html#108-134" title="Go to source code">publish</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Publish the content for the template. Any new messages sent using this
template will start using the content that was previously in draft.</p>
</div>
<div class="description detailed hidden">
<p>Publish the content for the template. Any new messages sent using this
template will start using the content that was previously in draft.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the immutable name of an existing template</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the template that was published - slug string the immutable unique code name of
the template - name string the name of the template - labels array the list of
labels applied to the template - labels[] string a single label - code string
the full HTML code of the template, with mc:edit attributes marking the editable
elements - draft version - subject string the subject line of the template, if
provided - draft version - from_email string the default sender address for the
template, if provided - draft version - from_name string the default sender from
name for the template, if provided - draft version - text string the default
text part of messages sent with the template, if provided - draft version -
publish_name string the same as the template name - kept as a separate field for
backwards compatibility - publish_code string the full HTML code of the
template, with mc:edit attributes marking the editable elements that are
available as published, if it has been published - publish_subject string the
subject line of the template, if provided - publish_from_email string the
default sender address for the template, if provided - publish_from_name string
the default sender from name for the template, if provided - publish_text string
the default text part of messages sent with the template, if provided -
published_at string the date and time the template was last published as a UTC
string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
created_at string the date and time the template was first created as a UTC
string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Templates.html#136-162" title="Go to source code">delete</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Delete a template</p>
</div>
<div class="description detailed hidden">
<p>Delete a template</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the immutable name of an existing template</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the template that was deleted - slug string the immutable unique code name of
the template - name string the name of the template - labels array the list of
labels applied to the template - labels[] string a single label - code string
the full HTML code of the template, with mc:edit attributes marking the editable
elements - draft version - subject string the subject line of the template, if
provided - draft version - from_email string the default sender address for the
template, if provided - draft version - from_name string the default sender from
name for the template, if provided - draft version - text string the default
text part of messages sent with the template, if provided - draft version -
publish_name string the same as the template name - kept as a separate field for
backwards compatibility - publish_code string the full HTML code of the
template, with mc:edit attributes marking the editable elements that are
available as published, if it has been published - publish_subject string the
subject line of the template, if provided - publish_from_email string the
default sender address for the template, if provided - publish_from_name string
the default sender from name for the template, if provided - publish_text string
the default text part of messages sent with the template, if provided -
published_at string the date and time the template was last published as a UTC
string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
created_at string the date and time the template was first created as a UTC
string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Templates.html#164-191" title="Go to source code">getList</a>( <span>string <var>$label</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Return a list of all the templates available to this user</p>
</div>
<div class="description detailed hidden">
<p>Return a list of all the templates available to this user</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$label</var></dt>
<dd><code>string</code><br>$label an optional label to filter the templates</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>an array of structs with information about each template - return[] struct the
information on each template in the account - slug string the immutable unique
code name of the template - name string the name of the template - labels array
the list of labels applied to the template - labels[] string a single label -
code string the full HTML code of the template, with mc:edit attributes marking
the editable elements - draft version - subject string the subject line of the
template, if provided - draft version - from_email string the default sender
address for the template, if provided - draft version - from_name string the
default sender from name for the template, if provided - draft version - text
string the default text part of messages sent with the template, if provided -
draft version - publish_name string the same as the template name - kept as a
separate field for backwards compatibility - publish_code string the full HTML
code of the template, with mc:edit attributes marking the editable elements that
are available as published, if it has been published - publish_subject string
the subject line of the template, if provided - publish_from_email string the
default sender address for the template, if provided - publish_from_name string
the default sender from name for the template, if provided - publish_text string
the default text part of messages sent with the template, if provided -
published_at string the date and time the template was last published as a UTC
string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
created_at string the date and time the template was first created as a UTC
string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="timeSeries" id="_timeSeries">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_timeSeries">#</a>
<code><a href="source-class-Mandrill_Templates.html#193-212" title="Go to source code">timeSeries</a>( <span>string <var>$name</var></span> )</code>
<div class="description short">
<p>Return the recent history (hourly stats for the last 30 days) for a
template</p>
</div>
<div class="description detailed hidden">
<p>Return the recent history (hourly stats for the last 30 days) for a
template</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$name</var></dt>
<dd><code>string</code><br>$name the name of an existing template</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the array of history information - return[] struct the stats for a single hour -
time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent
integer the number of emails that were sent during the hour - hard_bounces
integer the number of emails that hard bounced during the hour - soft_bounces
integer the number of emails that soft bounced during the hour - rejects integer
the number of emails that were rejected during the hour - complaints integer the
number of spam complaints received during the hour - opens integer the number of
emails opened during the hour - unique_opens integer the number of unique opens
generated by messages sent during the hour - clicks integer the number of
tracked URLs clicked during the hour - unique_clicks integer the number of
unique clicks generated by messages sent during the hour<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="render" id="_render">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_render">#</a>
<code><a href="source-class-Mandrill_Templates.html#214-231" title="Go to source code">render</a>( <span>string <var>$template_name</var></span>, <span>array <var>$template_content</var></span>, <span>array <var>$merge_vars</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Inject content and optionally merge fields into a template, returning the
HTML that results</p>
</div>
<div class="description detailed hidden">
<p>Inject content and optionally merge fields into a template, returning the
HTML that results</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$template_name</var></dt>
<dd><code>string</code><br>$template_name the immutable name of a template that exists in the user's
account</dd>
<dt><var>$template_content</var></dt>
<dd><code>array</code><br>$template_content an array of template content to render. Each item in the array
should be a struct with two keys - name: the name of the content block to set
the content for, and content: the actual content to put into the block -
template_content[] struct the injection of a single piece of content into a
single editable region - name string the name of the mc:edit editable region to
inject into - content string the content to inject</dd>
<dt><var>$merge_vars</var></dt>
<dd><code>array</code><br>$merge_vars optional merge variables to use for injecting merge field content.
If this is not provided, no merge fields will be replaced. - merge_vars[] struct
a single merge variable - name string the merge variable's name. Merge variable
names are case-insensitive and may not start with _ - content string the merge
variable's content</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the result of rendering the given template with the content and merge field
values injected - html string the rendered HTML as a string<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Export</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Export</h1>
<div class="description">
<p>The requested export job does not exist</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Export</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Export.html#86-89" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_IP</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li class="active"><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_IP</h1>
<div class="description">
<p>The provided dedicated IP does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_IP</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_IP.html#111-114" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_InboundDomain</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li class="active"><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_InboundDomain</h1>
<div class="description">
<p>The requested inbound domain does not exist</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_InboundDomain</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_InboundDomain.html#76-79" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_InboundRoute</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li class="active"><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_InboundRoute</h1>
<div class="description">
<p>The provided inbound route does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_InboundRoute</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_InboundRoute.html#81-84" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Message</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Message</h1>
<div class="description">
<p>The provided message id does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Message</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Message.html#36-39" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_MetadataField</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li class="active"><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_MetadataField</h1>
<div class="description">
<p>The provided metadata field name does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_MetadataField</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_MetadataField.html#146-149" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Pool</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Pool</h1>
<div class="description">
<p>The provided dedicated IP pool does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Pool</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Pool.html#96-99" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Sender</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Sender</h1>
<div class="description">
<p>The requested sender does not exist</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Sender</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Sender.html#51-54" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Subaccount</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Subaccount</h1>
<div class="description">
<p>The provided subaccount id does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Subaccount</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Subaccount.html#21-24" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Template</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Template</h1>
<div class="description">
<p>The requested template does not exist</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Template</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Template.html#26-29" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_TrackingDomain</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li class="active"><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_TrackingDomain</h1>
<div class="description">
<p>The provided tracking domain does not exist.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_TrackingDomain</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_TrackingDomain.html#61-64" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Url</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Url</h1>
<div class="description">
<p>The requested URL has not been seen in a tracked link</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Url</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Url.html#56-59" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,231 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Unknown_Webhook</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Unknown_Webhook</h1>
<div class="description">
<p>The requested webhook does not exist</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_Unknown_Webhook</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Unknown_Webhook.html#71-74" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,501 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Urls</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li class="active"><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Urls</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Urls.html#3-106" title="Go to source code">Mandrill/Urls.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Urls.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Urls.html#8-20" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Get the 100 most clicked URLs</p>
</div>
<div class="description detailed hidden">
<p>Get the 100 most clicked URLs</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the 100 most clicked URLs and their stats - return[] struct the individual URL
stats - url string the URL to be tracked - sent integer the number of emails
that contained the URL - clicks integer the number of times the URL has been
clicked from a tracked email - unique_clicks integer the number of unique emails
that have generated clicks for this URL<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="search" id="_search">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_search">#</a>
<code><a href="source-class-Mandrill_Urls.html#22-35" title="Go to source code">search</a>( <span>string <var>$q</var></span> )</code>
<div class="description short">
<p>Return the 100 most clicked URLs that match the search query given</p>
</div>
<div class="description detailed hidden">
<p>Return the 100 most clicked URLs that match the search query given</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$q</var></dt>
<dd><code>string</code><br>$q a search query</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the 100 most clicked URLs matching the search query - return[] struct the URL
matching the query - url string the URL to be tracked - sent integer the number
of emails that contained the URL - clicks integer the number of times the URL
has been clicked from a tracked email - unique_clicks integer the number of
unique emails that have generated clicks for this URL<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="timeSeries" id="_timeSeries">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_timeSeries">#</a>
<code><a href="source-class-Mandrill_Urls.html#37-50" title="Go to source code">timeSeries</a>( <span>string <var>$url</var></span> )</code>
<div class="description short">
<p>Return the recent history (hourly stats for the last 30 days) for a url</p>
</div>
<div class="description detailed hidden">
<p>Return the recent history (hourly stats for the last 30 days) for a url</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$url</var></dt>
<dd><code>string</code><br>$url an existing URL</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the array of history information - return[] struct the information for a single
hour - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format -
sent integer the number of emails that were sent with the URL during the hour -
clicks integer the number of times the URL was clicked during the hour -
unique_clicks integer the number of unique clicks generated for emails sent with
this URL during the hour<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="trackingDomains" id="_trackingDomains">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_trackingDomains">#</a>
<code><a href="source-class-Mandrill_Urls.html#52-68" title="Go to source code">trackingDomains</a>( )</code>
<div class="description short">
<p>Get the list of tracking domains set up for this account</p>
</div>
<div class="description detailed hidden">
<p>Get the list of tracking domains set up for this account</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the tracking domains and their status - return[] struct the individual tracking
domain - domain string the tracking domain name - created_at string the date and
time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS
format - last_tested_at string when the domain's DNS settings were last tested
as a UTC string in YYYY-MM-DD HH:MM:SS format - cname struct details about the
domain's CNAME record - valid boolean whether the domain's CNAME record is valid
for use with Mandrill - valid_after string when the domain's CNAME record will
be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS
format. If set, this indicates that the record is valid now, but was previously
invalid, and Mandrill will wait until the record's TTL elapses to start using
it. - error string an error describing the CNAME record, or null if the record
is correct - valid_tracking boolean whether this domain can be used as a
tracking domain for email.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="addTrackingDomain" id="_addTrackingDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_addTrackingDomain">#</a>
<code><a href="source-class-Mandrill_Urls.html#70-86" title="Go to source code">addTrackingDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Add a tracking domain to your account</p>
</div>
<div class="description detailed hidden">
<p>Add a tracking domain to your account</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain a domain name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the domain - domain string the tracking domain name -
created_at string the date and time that the tracking domain was added as a UTC
string in YYYY-MM-DD HH:MM:SS format - last_tested_at string when the domain's
DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format -
cname struct details about the domain's CNAME record - valid boolean whether the
domain's CNAME record is valid for use with Mandrill - valid_after string when
the domain's CNAME record will be considered valid for use with Mandrill as a
UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record
is valid now, but was previously invalid, and Mandrill will wait until the
record's TTL elapses to start using it. - error string an error describing the
CNAME record, or null if the record is correct - valid_tracking boolean whether
this domain can be used as a tracking domain for email.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="checkTrackingDomain" id="_checkTrackingDomain">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_checkTrackingDomain">#</a>
<code><a href="source-class-Mandrill_Urls.html#88-104" title="Go to source code">checkTrackingDomain</a>( <span>string <var>$domain</var></span> )</code>
<div class="description short">
<p>Checks the CNAME settings for a tracking domain. The domain must have been
added already with the add-tracking-domain call</p>
</div>
<div class="description detailed hidden">
<p>Checks the CNAME settings for a tracking domain. The domain must have been
added already with the add-tracking-domain call</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$domain</var></dt>
<dd><code>string</code><br>$domain an existing tracking domain name</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>information about the tracking domain - domain string the tracking domain name -
created_at string the date and time that the tracking domain was added as a UTC
string in YYYY-MM-DD HH:MM:SS format - last_tested_at string when the domain's
DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format -
cname struct details about the domain's CNAME record - valid boolean whether the
domain's CNAME record is valid for use with Mandrill - valid_after string when
the domain's CNAME record will be considered valid for use with Mandrill as a
UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record
is valid now, but was previously invalid, and Mandrill will wait until the
record's TTL elapses to start using it. - error string an error describing the
CNAME record, or null if the record is correct - valid_tracking boolean whether
this domain can be used as a tracking domain for email.<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,458 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Users</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li class="active"><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Users</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Users.html#3-130" title="Go to source code">Mandrill/Users.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Users.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Users.html#8-88" title="Go to source code">info</a>( )</code>
<div class="description short">
<p>Return the information about the API-connected user</p>
</div>
<div class="description detailed hidden">
<p>Return the information about the API-connected user</p>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the user information including username, key, reputation, quota, and historical
sending stats - username string the username of the user (used for SMTP
authentication) - created_at string the date and time that the user's Mandrill
account was created as a UTC string in YYYY-MM-DD HH:MM:SS format - public_id
string a unique, permanent identifier for this user - reputation integer the
reputation of the user on a scale from 0 to 100, with 75 generally being a
"good" reputation - hourly_quota integer the maximum number of emails Mandrill
will deliver for this user each hour. Any emails beyond that will be accepted
and queued for later delivery. Users with higher reputations will have higher
hourly quotas - backlog integer the number of emails that are queued for
delivery due to exceeding your monthly or hourly quotas - stats struct an
aggregate summary of the account's sending stats - today struct stats for this
user so far today - sent integer the number of emails sent for this user so far
today - hard_bounces integer the number of emails hard bounced for this user so
far today - soft_bounces integer the number of emails soft bounced for this user
so far today - rejects integer the number of emails rejected for sending this
user so far today - complaints integer the number of spam complaints for this
user so far today - unsubs integer the number of unsubscribes for this user so
far today - opens integer the number of times emails have been opened for this
user so far today - unique_opens integer the number of unique opens for emails
sent for this user so far today - clicks integer the number of URLs that have
been clicked for this user so far today - unique_clicks integer the number of
unique clicks for emails sent for this user so far today - last<sub>7</sub>_days
struct stats for this user in the last 7 days - sent integer the number of
emails sent for this user in the last 7 days - hard_bounces integer the number
of emails hard bounced for this user in the last 7 days - soft_bounces integer
the number of emails soft bounced for this user in the last 7 days - rejects
integer the number of emails rejected for sending this user in the last 7 days -
complaints integer the number of spam complaints for this user in the last 7
days - unsubs integer the number of unsubscribes for this user in the last 7
days - opens integer the number of times emails have been opened for this user
in the last 7 days - unique_opens integer the number of unique opens for emails
sent for this user in the last 7 days - clicks integer the number of URLs that
have been clicked for this user in the last 7 days - unique_clicks integer the
number of unique clicks for emails sent for this user in the last 7 days -
last<sub>30</sub>_days struct stats for this user in the last 30 days - sent
integer the number of emails sent for this user in the last 30 days -
hard_bounces integer the number of emails hard bounced for this user in the last
30 days - soft_bounces integer the number of emails soft bounced for this user
in the last 30 days - rejects integer the number of emails rejected for sending
this user in the last 30 days - complaints integer the number of spam complaints
for this user in the last 30 days - unsubs integer the number of unsubscribes
for this user in the last 30 days - opens integer the number of times emails
have been opened for this user in the last 30 days - unique_opens integer the
number of unique opens for emails sent for this user in the last 30 days -
clicks integer the number of URLs that have been clicked for this user in the
last 30 days - unique_clicks integer the number of unique clicks for emails sent
for this user in the last 30 days - last<sub>60</sub>_days struct stats for this
user in the last 60 days - sent integer the number of emails sent for this user
in the last 60 days - hard_bounces integer the number of emails hard bounced for
this user in the last 60 days - soft_bounces integer the number of emails soft
bounced for this user in the last 60 days - rejects integer the number of emails
rejected for sending this user in the last 60 days - complaints integer the
number of spam complaints for this user in the last 60 days - unsubs integer the
number of unsubscribes for this user in the last 60 days - opens integer the
number of times emails have been opened for this user in the last 60 days -
unique_opens integer the number of unique opens for emails sent for this user in
the last 60 days - clicks integer the number of URLs that have been clicked for
this user in the last 60 days - unique_clicks integer the number of unique
clicks for emails sent for this user in the last 60 days -
last<sub>90</sub>_days struct stats for this user in the last 90 days - sent
integer the number of emails sent for this user in the last 90 days -
hard_bounces integer the number of emails hard bounced for this user in the last
90 days - soft_bounces integer the number of emails soft bounced for this user
in the last 90 days - rejects integer the number of emails rejected for sending
this user in the last 90 days - complaints integer the number of spam complaints
for this user in the last 90 days - unsubs integer the number of unsubscribes
for this user in the last 90 days - opens integer the number of times emails
have been opened for this user in the last 90 days - unique_opens integer the
number of unique opens for emails sent for this user in the last 90 days -
clicks integer the number of URLs that have been clicked for this user in the
last 90 days - unique_clicks integer the number of unique clicks for emails sent
for this user in the last 90 days - all_time struct stats for the lifetime of
the user's account - sent integer the number of emails sent in the lifetime of
the user's account - hard_bounces integer the number of emails hard bounced in
the lifetime of the user's account - soft_bounces integer the number of emails
soft bounced in the lifetime of the user's account - rejects integer the number
of emails rejected for sending this user so far today - complaints integer the
number of spam complaints in the lifetime of the user's account - unsubs integer
the number of unsubscribes in the lifetime of the user's account - opens integer
the number of times emails have been opened in the lifetime of the user's
account - unique_opens integer the number of unique opens for emails sent in the
lifetime of the user's account - clicks integer the number of URLs that have
been clicked in the lifetime of the user's account - unique_clicks integer the
number of unique clicks for emails sent in the lifetime of the user's account<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="ping" id="_ping">
<td class="attributes"><code>
public
string
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ping">#</a>
<code><a href="source-class-Mandrill_Users.html#90-97" title="Go to source code">ping</a>( )</code>
<div class="description short">
<p>Validate an API key and respond to a ping</p>
</div>
<div class="description detailed hidden">
<p>Validate an API key and respond to a ping</p>
<h4>Returns</h4>
<div class="list">
<code>string</code><br>the string "PONG!"<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="ping2" id="_ping2">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ping2">#</a>
<code><a href="source-class-Mandrill_Users.html#99-106" title="Go to source code">ping2</a>( )</code>
<div class="description short">
<p>Validate an API key and respond to a ping (anal JSON parser version)</p>
</div>
<div class="description detailed hidden">
<p>Validate an API key and respond to a ping (anal JSON parser version)</p>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a struct with one key "PING" with a static value "PONG!"<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="senders" id="_senders">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_senders">#</a>
<code><a href="source-class-Mandrill_Users.html#108-128" title="Go to source code">senders</a>( )</code>
<div class="description short">
<p>Return the senders that have tried to use this account, both verified and
unverified</p>
</div>
<div class="description detailed hidden">
<p>Return the senders that have tried to use this account, both verified and
unverified</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>an array of sender data, one for each sending addresses used by the account -
return[] struct the information on each sending address in the account - address
string the sender's email address - created_at string the date and time that the
sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS
format - sent integer the total number of messages sent by this sender -
hard_bounces integer the total number of hard bounces by messages by this sender
- soft_bounces integer the total number of soft bounces by messages by this
sender - rejects integer the total number of rejected messages by this sender -
complaints integer the total number of spam complaints received for messages by
this sender - unsubs integer the total number of unsubscribe requests received
for messages by this sender - opens integer the total number of times messages
by this sender have been opened - clicks integer the total number of times
tracked URLs in messages by this sender have been clicked - unique_opens integer
the number of unique opens for emails sent for this sender - unique_clicks
integer the number of unique clicks for emails sent for this sender<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,232 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_ValidationError</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li class="active"><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_ValidationError</h1>
<div class="description">
<p>The parameters passed to the API call are invalid or not provided when
required</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<a href="class-Exception.html"><span>Exception</span></a>
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by" />
<a href="class-Mandrill_Error.html"><span>Mandrill_Error</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by" />
<b><span>Mandrill_ValidationError</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_ValidationError.html#6-9" title="Go to source code">Mandrill/Exceptions.php</a><br />
</div>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Exception.html#methods">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#___construct">__construct()</a>,
<a href="class-Exception.html#___toString">__toString()</a>,
<a href="class-Exception.html#_getCode">getCode()</a>,
<a href="class-Exception.html#_getFile">getFile()</a>,
<a href="class-Exception.html#_getLine">getLine()</a>,
<a href="class-Exception.html#_getMessage">getMessage()</a>,
<a href="class-Exception.html#_getPrevious">getPrevious()</a>,
<a href="class-Exception.html#_getTrace">getTrace()</a>,
<a href="class-Exception.html#_getTraceAsString">getTraceAsString()</a>
</code></td>
</tr>
</table>
<table class="summary inherited">
<caption>Properties inherited from <a href="class-Exception.html#properties">Exception</a></caption>
<tr>
<td><code>
<a href="class-Exception.html#$code"><var>$code</var></a>,
<a href="class-Exception.html#$file"><var>$file</var></a>,
<a href="class-Exception.html#$line"><var>$line</var></a>,
<a href="class-Exception.html#$message"><var>$message</var></a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,488 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Webhooks</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li class="active"><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Webhooks</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Webhooks.html#3-120" title="Go to source code">Mandrill/Webhooks.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Webhooks.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Webhooks.html#8-27" title="Go to source code">getList</a>( )</code>
<div class="description short">
<p>Get the list of all webhooks defined on the account</p>
</div>
<div class="description detailed hidden">
<p>Get the list of all webhooks defined on the account</p>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>the webhooks associated with the account - return[] struct the individual
webhook info - id integer a unique integer indentifier for the webhook - url
string The URL that the event data will be posted to - description string a
description of the webhook - auth_key string the key used to requests for this
webhook - events array The message events that will be posted to the hook -
events[] string the individual message event (send, hard_bounce, soft_bounce,
open, click, spam, unsub, or reject) - created_at string the date and time that
the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format -
last_sent_at string the date and time that the webhook last successfully
received events as a UTC string in YYYY-MM-DD HH:MM:SS format - batches_sent
integer the number of event batches that have ever been sent to this webhook -
events_sent integer the total number of events that have ever been sent to this
webhook - last_error string if we've ever gotten an error trying to post to this
webhook, the last error that we've seen<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="add" id="_add">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_add">#</a>
<code><a href="source-class-Mandrill_Webhooks.html#29-51" title="Go to source code">add</a>( <span>string <var>$url</var></span>, <span>string <var>$description</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$events</var> = <span class="php-keyword1">array</span>()</span> )</code>
<div class="description short">
<p>Add a new webhook</p>
</div>
<div class="description detailed hidden">
<p>Add a new webhook</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$url</var></dt>
<dd><code>string</code><br>$url the URL to POST batches of events</dd>
<dt><var>$description</var></dt>
<dd><code>string</code><br>$description an optional description of the webhook</dd>
<dt><var>$events</var></dt>
<dd><code>array</code><br>$events an optional list of events that will be posted to the webhook - events[]
string the individual event to listen for</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information saved about the new webhook - id integer a unique integer
indentifier for the webhook - url string The URL that the event data will be
posted to - description string a description of the webhook - auth_key string
the key used to requests for this webhook - events array The message events that
will be posted to the hook - events[] string the individual message event (send,
hard_bounce, soft_bounce, open, click, spam, unsub, or reject) - created_at
string the date and time that the webhook was created as a UTC string in
YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time that the
webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS
format - batches_sent integer the number of event batches that have ever been
sent to this webhook - events_sent integer the total number of events that have
ever been sent to this webhook - last_error string if we've ever gotten an error
trying to post to this webhook, the last error that we've seen<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="info" id="_info">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_info">#</a>
<code><a href="source-class-Mandrill_Webhooks.html#53-72" title="Go to source code">info</a>( <span>integer <var>$id</var></span> )</code>
<div class="description short">
<p>Given the ID of an existing webhook, return the data about it</p>
</div>
<div class="description detailed hidden">
<p>Given the ID of an existing webhook, return the data about it</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>integer</code><br>$id the unique identifier of a webhook belonging to this account</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information about the webhook - id integer a unique integer indentifier for
the webhook - url string The URL that the event data will be posted to -
description string a description of the webhook - auth_key string the key used
to requests for this webhook - events array The message events that will be
posted to the hook - events[] string the individual message event (send,
hard_bounce, soft_bounce, open, click, spam, unsub, or reject) - created_at
string the date and time that the webhook was created as a UTC string in
YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time that the
webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS
format - batches_sent integer the number of event batches that have ever been
sent to this webhook - events_sent integer the total number of events that have
ever been sent to this webhook - last_error string if we've ever gotten an error
trying to post to this webhook, the last error that we've seen<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="update" id="_update">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_update">#</a>
<code><a href="source-class-Mandrill_Webhooks.html#74-97" title="Go to source code">update</a>( <span>integer <var>$id</var></span>, <span>string <var>$url</var></span>, <span>string <var>$description</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$events</var> = <span class="php-keyword1">array</span>()</span> )</code>
<div class="description short">
<p>Update an existing webhook</p>
</div>
<div class="description detailed hidden">
<p>Update an existing webhook</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>integer</code><br>$id the unique identifier of a webhook belonging to this account</dd>
<dt><var>$url</var></dt>
<dd><code>string</code><br>$url the URL to POST batches of events</dd>
<dt><var>$description</var></dt>
<dd><code>string</code><br>$description an optional description of the webhook</dd>
<dt><var>$events</var></dt>
<dd><code>array</code><br>$events an optional list of events that will be posted to the webhook - events[]
string the individual event to listen for</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the updated webhook - id integer a unique integer
indentifier for the webhook - url string The URL that the event data will be
posted to - description string a description of the webhook - auth_key string
the key used to requests for this webhook - events array The message events that
will be posted to the hook - events[] string the individual message event (send,
hard_bounce, soft_bounce, open, click, spam, unsub, or reject) - created_at
string the date and time that the webhook was created as a UTC string in
YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time that the
webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS
format - batches_sent integer the number of event batches that have ever been
sent to this webhook - events_sent integer the total number of events that have
ever been sent to this webhook - last_error string if we've ever gotten an error
trying to post to this webhook, the last error that we've seen<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Webhooks.html#99-118" title="Go to source code">delete</a>( <span>integer <var>$id</var></span> )</code>
<div class="description short">
<p>Delete an existing webhook</p>
</div>
<div class="description detailed hidden">
<p>Delete an existing webhook</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$id</var></dt>
<dd><code>integer</code><br>$id the unique identifier of a webhook belonging to this account</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>the information for the deleted webhook - id integer a unique integer
indentifier for the webhook - url string The URL that the event data will be
posted to - description string a description of the webhook - auth_key string
the key used to requests for this webhook - events array The message events that
will be posted to the hook - events[] string the individual message event (send,
hard_bounce, soft_bounce, open, click, spam, unsub, or reject) - created_at
string the date and time that the webhook was created as a UTC string in
YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time that the
webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS
format - batches_sent integer the number of event batches that have ever been
sent to this webhook - events_sent integer the total number of events that have
ever been sent to this webhook - last_error string if we've ever gotten an error
trying to post to this webhook, the last error that we've seen<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,346 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Mandrill_Whitelists</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li class="active"><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Mandrill_Whitelists</h1>
<div class="info">
<b>Located at</b> <a href="source-class-Mandrill_Whitelists.html#3-49" title="Go to source code">Mandrill/Whitelists.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Mandrill_Whitelists.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="add" id="_add">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_add">#</a>
<code><a href="source-class-Mandrill_Whitelists.html#8-20" title="Go to source code">add</a>( <span>string <var>$email</var></span> )</code>
<div class="description short">
<p>Adds an email to your email rejection whitelist. If the address is currently
on your blacklist, that blacklist entry will be removed automatically.</p>
</div>
<div class="description detailed hidden">
<p>Adds an email to your email rejection whitelist. If the address is currently
on your blacklist, that blacklist entry will be removed automatically.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$email</var></dt>
<dd><code>string</code><br>$email an email address to add to the whitelist</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a status object containing the address and the result of the operation - email
string the email address you provided - whether boolean the operation succeeded<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="getList" id="_getList">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getList">#</a>
<code><a href="source-class-Mandrill_Whitelists.html#22-35" title="Go to source code">getList</a>( <span>string <var>$email</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
<p>Retrieves your email rejection whitelist. You can provide an email address or
search prefix to limit the results. Returns up to 1000 results.</p>
</div>
<div class="description detailed hidden">
<p>Retrieves your email rejection whitelist. You can provide an email address or
search prefix to limit the results. Returns up to 1000 results.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$email</var></dt>
<dd><code>string</code><br>$email an optional email address or prefix to search by</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>up to 1000 whitelist entries - return[] struct the information for each
whitelist entry - email string the email that is whitelisted - detail string a
description of why the email was whitelisted - created_at string when the email
was added to the whitelist<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="delete" id="_delete">
<td class="attributes"><code>
public
struct
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_delete">#</a>
<code><a href="source-class-Mandrill_Whitelists.html#37-47" title="Go to source code">delete</a>( <span>string <var>$email</var></span> )</code>
<div class="description short">
<p>Removes an email address from the whitelist.</p>
</div>
<div class="description detailed hidden">
<p>Removes an email address from the whitelist.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$email</var></dt>
<dd><code>string</code><br>$email the email address to remove from the whitelist</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>struct</code><br>a status object containing the address and whether the deletion succeeded -
email string the email address that was removed from the blacklist - deleted
boolean whether the address was deleted successfully<br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,3 @@
var ApiGen = ApiGen || {};
ApiGen.elements = [["c","Exception"],["c","Mandrill"],["c","Mandrill_Error"],["c","Mandrill_Exports"],["c","Mandrill_HttpError"],["c","Mandrill_Inbound"],["c","Mandrill_Internal"],["c","Mandrill_Invalid_CustomDNS"],["c","Mandrill_Invalid_CustomDNSPending"],["c","Mandrill_Invalid_DeleteDefaultPool"],["c","Mandrill_Invalid_DeleteNonEmptyPool"],["c","Mandrill_Invalid_EmptyDefaultPool"],["c","Mandrill_Invalid_Key"],["c","Mandrill_Invalid_Reject"],["c","Mandrill_Invalid_Tag_Name"],["c","Mandrill_Invalid_Template"],["c","Mandrill_IP_ProvisionLimit"],["c","Mandrill_Ips"],["c","Mandrill_Messages"],["c","Mandrill_Metadata"],["c","Mandrill_Metadata_FieldLimit"],["c","Mandrill_NoSendingHistory"],["c","Mandrill_PaymentRequired"],["c","Mandrill_PoorReputation"],["c","Mandrill_Rejects"],["c","Mandrill_Senders"],["c","Mandrill_ServiceUnavailable"],["c","Mandrill_Subaccounts"],["c","Mandrill_Tags"],["c","Mandrill_Templates"],["c","Mandrill_Unknown_Export"],["c","Mandrill_Unknown_InboundDomain"],["c","Mandrill_Unknown_InboundRoute"],["c","Mandrill_Unknown_IP"],["c","Mandrill_Unknown_Message"],["c","Mandrill_Unknown_MetadataField"],["c","Mandrill_Unknown_Pool"],["c","Mandrill_Unknown_Sender"],["c","Mandrill_Unknown_Subaccount"],["c","Mandrill_Unknown_Template"],["c","Mandrill_Unknown_TrackingDomain"],["c","Mandrill_Unknown_Url"],["c","Mandrill_Unknown_Webhook"],["c","Mandrill_Urls"],["c","Mandrill_Users"],["c","Mandrill_ValidationError"],["c","Mandrill_Webhooks"],["c","Mandrill_Whitelists"]];

View File

@@ -0,0 +1,149 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Overview</title>
<script type="text/javascript" src="resources/combined.js"></script>
<script type="text/javascript" src="elementlist.js"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<span>Overview</span>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Exception.html">Exception</a></li>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" autofocus />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li class="active">
<span>Overview</span> </li>
<li>
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content">
<h1>Overview</h1>
<table class="summary" id="namespaces">
<caption>Namespaces summary</caption>
<tr>
<td class="name"><a href="namespace-None.html">None</a></td>
</tr>
<tr>
<td class="name"><a href="namespace-PHP.html">PHP</a></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,341 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>No namespace</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li class="active">
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="namespace">
<h1>No namespace</h1>
<table class="summary" id="classes">
<caption>Classes summary</caption>
<tr>
<td class="name"><a href="class-Mandrill.html">Mandrill</a></td>
<td>
<!-- by Texy2! --></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Users.html">Mandrill_Users</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></td>
<td></td>
</tr>
</table>
<table class="summary" id="exceptions">
<caption>Exceptions summary</caption>
<tr>
<td class="name"><a href="class-Mandrill_Error.html">Mandrill_Error</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></td>
<td></td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></td>
<td>The domain name is not configured for use as the dedicated IP's custom reverse
DNS.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></td>
<td>A custom DNS change for this dedicated IP is currently pending.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></td>
<td>The default pool cannot be deleted.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></td>
<td>Non-empty pools cannot be deleted.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></td>
<td>You cannot remove the last IP from your default IP pool.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></td>
<td>The provided API key is not a valid Mandrill API key</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></td>
<td>The requested email is not in the rejection list</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></td>
<td>The requested tag does not exist or contains invalid characters</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></td>
<td>The given template name already exists or contains invalid characters</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></td>
<td>A dedicated IP cannot be provisioned while another request is pending.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></td>
<td>Custom metadata field limit reached.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></td>
<td>The user hasn't started sending yet.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></td>
<td>The requested feature requires payment.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></td>
<td>The user's reputation is too low to continue.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></td>
<td>The subsystem providing this API call is down for maintenance</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></td>
<td>The requested export job does not exist</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></td>
<td>The requested inbound domain does not exist</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></td>
<td>The provided inbound route does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></td>
<td>The provided dedicated IP does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></td>
<td>The provided message id does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></td>
<td>The provided metadata field name does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></td>
<td>The provided dedicated IP pool does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></td>
<td>The requested sender does not exist</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></td>
<td>The provided subaccount id does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></td>
<td>The requested template does not exist</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></td>
<td>The provided tracking domain does not exist.</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></td>
<td>The requested URL has not been seen in a tracked link</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></td>
<td>The requested webhook does not exist</td>
</tr>
<tr>
<td class="name"><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></td>
<td>The parameters passed to the API call are invalid or not provided when required</td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,103 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Namespace PHP</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li><a href="namespace-None.html">None</a>
</li>
<li class="active"><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Exceptions</h3>
<ul>
<li><a href="class-Exception.html">Exception</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li class="active">
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="namespace">
<h1>Namespace PHP</h1>
<table class="summary" id="exceptions">
<caption>Exceptions summary</caption>
<tr>
<td class="name"><a href="class-Exception.html">Exception</a></td>
<td></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 236 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 238 B

File diff suppressed because one or more lines are too long

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 216 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 171 B

View File

@@ -0,0 +1,608 @@
/*!
* ApiGen 2.8.0 - API documentation generator for PHP 5.3+
*
* Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
* Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
* Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
*
* For the full copyright and license information, please view
* the file LICENSE.md that was distributed with this source code.
*/
body {
font: 13px/1.5 Verdana, 'Geneva CE', lucida, sans-serif;
margin: 0;
padding: 0;
background: #ffffff;
color: #333333;
}
h1, h2, h3, h4, caption {
font-family: 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
color: #053368;
}
h1 {
color: #1e5eb6;
font-size: 230%;
font-weight: normal;
margin: .3em 0;
}
h2 {
color: #1e5eb6;
font-size: 150%;
font-weight: normal;
margin: -.3em 0 .3em 0;
}
h3 {
font-size: 1.6em;
font-weight: normal;
margin-bottom: 2px;
}
h4 {
font-size: 100%;
font-weight: bold;
padding: 0;
margin: 0;
}
caption {
border: 1px solid #cccccc;
background: #ecede5;
font-weight: bold;
font-size: 1.2em;
padding: 3px 5px;
text-align: left;
margin-bottom: 0;
}
p {
margin: .7em 0 1em;
padding: 0;
}
hr {
margin: 2em 0 1em;
border: none;
border-top: 1px solid #cccccc;
height: 0;
}
a {
color: #006aeb;
padding: 3px 1px;
text-decoration: none;
}
h1 a {
color: #1e5eb6;
}
a:hover, a:active, a:focus, a:hover b, a:hover var {
background-color: #006aeb;
color: #ffffff !important;
}
code, var, pre {
font-family: monospace;
}
var {
font-weight: bold;
font-style: normal;
color: #ca8a04;
}
pre {
margin: 0;
}
code a b {
color: #000000;
}
.deprecated {
text-decoration: line-through;
}
.invalid {
color: #e71818;
}
.hidden {
display: none;
}
/* Left side */
#left {
overflow: auto;
width: 270px;
height: 100%;
position: fixed;
}
/* Menu */
#menu {
padding: 10px;
}
#menu ul {
list-style: none;
padding: 0;
margin: 0;
}
#menu ul ul {
padding-left: 10px;
}
#menu li {
white-space: nowrap;
position: relative;
}
#menu a {
display: block;
padding: 0 2px;
}
#menu .active > a, #menu > span {
color: #333333;
background: none;
font-weight: bold;
}
#menu .active > a.invalid {
color: #e71818;
}
#menu .active > a:hover, #menu .active > a:active, #menu .active > a:focus {
background-color: #006aeb;
}
#menu #groups span {
position: absolute;
top: 4px;
right: 2px;
cursor: pointer;
display: block;
width: 12px;
height: 12px;
background: url('collapsed.png') transparent 0 0 no-repeat;
}
#menu #groups span:hover {
background-position: -12px 0;
}
#menu #groups span.collapsed {
background-position: 0 -12px;
}
#menu #groups span.collapsed:hover {
background-position: -12px -12px;
}
#menu #groups ul.collapsed {
display: none;
}
/* Right side */
#right {
overflow: auto;
margin-left: 275px;
height: 100%;
position: fixed;
left: 0;
right: 0;
}
#rightInner {
max-width: 1000px;
min-width: 350px;
}
/* Search */
#search {
float: right;
margin: 3px 8px;
}
#search input.text {
padding: 3px 5px;
width: 250px;
}
/* Autocomplete */
.ac_results {
padding: 0;
border: 1px solid #cccccc;
background-color: #ffffff;
overflow: hidden;
z-index: 99999;
}
.ac_results ul {
width: 100%;
list-style-position: outside;
list-style: none;
padding: 0;
margin: 0;
}
.ac_results li {
margin: 0;
padding: 2px 5px;
cursor: default;
display: block;
font: 12px 'Trebuchet MS', 'Geneva CE', lucida, sans-serif;
line-height: 16px;
overflow: hidden;
white-space: nowrap;
}
.ac_results li strong {
color: #000000;
}
.ac_odd {
background-color: #eeeeee;
}
.ac_over {
background-color: #006aeb;
color: #ffffff;
}
.ac_results li.ac_over strong {
color: #ffffff;
}
/* Navigation */
#navigation {
padding: 3px 8px;
background-color: #f6f6f4;
height: 26px;
}
#navigation ul {
list-style: none;
margin: 0 8px 4px 0;
padding: 0;
overflow: hidden;
float: left;
}
#navigation ul + ul {
border-left: 1px solid #000000;
padding-left: 8px;
}
#navigation ul li {
float: left;
margin: 2px;
padding: 0 3px;
font-family: Verdana, 'Geneva CE', lucida, sans-serif;
color: #808080;
}
#navigation ul li.active {
background-color: #053368;
color: #ffffff;
font-weight: bold;
}
#navigation ul li a {
color: #000000;
font-weight: bold;
padding: 0;
}
#navigation ul li span {
float: left;
padding: 0 3px;
}
#navigation ul li a:hover span, #navigation ul li a:active span, #navigation ul li a:focus span {
background-color: #006aeb;
}
/* Content */
#content {
clear: both;
padding: 5px 15px;
}
.description pre {
padding: .6em;
background: #fcfcf7;
}
#content > .description {
background: #ecede5;
padding: 1px 8px;
margin: 1.2em 0;
}
#content > .description pre {
margin: .5em 0;
}
dl.tree {
margin: 1.2em 0;
}
dl.tree dd {
margin: 0;
padding: 0;
}
.info {
margin: 1.2em 0;
}
.summary {
border: 1px solid #cccccc;
border-collapse: collapse;
font-size: 1em;
width: 100%;
margin: 1.2em 0 2.4em;
}
.summary caption {
border-width: 1px 1px 0;
}
.summary caption.switchable {
background: #ecede5 url('sort.png') no-repeat center right;
cursor: pointer;
}
.summary td {
border: 1px solid #cccccc;
margin: 0;
padding: 3px 10px;
font-size: 1em;
vertical-align: top;
}
.summary td:first-child {
text-align: right;
}
#packages.summary td:first-child, #namespaces.summary td:first-child, .inherited.summary td:first-child, .used.summary td:first-child {
text-align: left;
}
.summary tr:hover td {
background: #f6f6f4;
}
.summary .description pre {
border: .5em solid #ecede5;
}
.summary .description p {
margin: 0;
}
.summary .description p + p, .summary .description ul {
margin: 3px 0 0 0;
}
.summary .description.detailed h4 {
margin-top: 3px;
}
.summary dl {
margin: 0;
}
.summary dd {
margin: 0 0 0 25px;
}
.name, .attributes {
white-space: nowrap;
}
.value {
white-space: pre-wrap;
}
td.name, td.attributes {
width: 1%;
}
.class #methods .name {
width: auto;
white-space: normal;
}
.class #methods .name > div > code {
white-space: pre-wrap;
}
.class #methods .name > div > code span, .function .value > code {
white-space: nowrap;
}
.class #methods td.name > div, .class td.description > div {
position: relative;
padding-right: 1em;
}
.anchor {
position: absolute;
top: 0;
right: 0;
line-height: 1;
font-size: 85%;
margin: 0;
color: #006aeb !important;
}
.list {
margin: 0 0 5px 25px;
}
div.invalid {
background-color: #fae4e0;
padding: 10px;
}
/* Splitter */
#splitter {
position: fixed;
height: 100%;
width: 5px;
left: 270px;
background: #1e5eb6 url('resize.png') left center no-repeat;
cursor: e-resize;
}
#splitter.active {
opacity: .5;
}
/* Footer */
#footer {
border-top: 1px solid #e9eeef;
clear: both;
color: #a7a7a7;
font-size: 8pt;
text-align: center;
padding: 20px 0 0;
margin: 3em 0 0;
height: 90px;
background: #ffffff url('footer.png') no-repeat center top;
}
/* Tree */
div.tree ul {
list-style: none;
background: url('tree-vertical.png') left repeat-y;
padding: 0;
margin-left: 20px;
}
div.tree li {
margin: 0;
padding: 0;
}
div.tree div {
padding-left: 30px;
}
div.tree div.notlast {
background: url('tree-hasnext.png') left 10px no-repeat;
}
div.tree div.last {
background: url('tree-last.png') left -240px no-repeat;
}
div.tree li.last {
background: url('tree-cleaner.png') left center repeat-y;
}
div.tree span.padding {
padding-left: 15px;
}
/* Source code */
.php-keyword1 {
color: #e71818;
font-weight: bold;
}
.php-keyword2 {
font-weight: bold;
}
.php-var {
color: #d59401;
font-weight: bold;
}
.php-num {
color: #cd0673;
}
.php-quote {
color: #008000;
}
.php-comment {
color: #929292;
}
.xlang {
color: #ff0000;
font-weight: bold;
}
span.l {
display: block;
}
span.l.selected {
background: #f6f6f4;
}
span.l a {
color: #333333;
}
span.l a:hover, div.l a:active, div.l a:focus {
background: transparent;
color: #333333 !important;
}
span.l .php-var a {
color: #d59401;
}
span.l .php-var a:hover, span.l .php-var a:active, span.l .php-var a:focus {
color: #d59401 !important;
}
span.l a.l {
padding-left: 2px;
color: #c0c0c0;
}
span.l a.l:hover, span.l a.l:active, span.l a.l:focus {
background: transparent;
color: #c0c0c0 !important;
}
#rightInner.medium #navigation {
height: 52px;
}
#rightInner.medium #navigation ul:first-child + ul {
clear: left;
border: none;
padding: 0;
}
#rightInner.medium .name, #rightInner.medium .attributes {
white-space: normal;
}
#rightInner.small #search {
float: left;
}
#rightInner.small #navigation {
height: 78px;
}
#rightInner.small #navigation ul:first-child {
clear: both;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 B

View File

@@ -0,0 +1,299 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill.html" title="Summary of Mandrill"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Templates.php'</span>;
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Exports.php'</span>;
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Users.php'</span>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Rejects.php'</span>;
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Inbound.php'</span>;
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Tags.php'</span>;
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Messages.php'</span>;
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Whitelists.php'</span>;
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Ips.php'</span>;
</span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Internal.php'</span>;
</span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Subaccounts.php'</span>;
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Urls.php'</span>;
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Webhooks.php'</span>;
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Senders.php'</span>;
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Metadata.php'</span>;
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">require_once</span> <span class="php-quote">'Mandrill/Exceptions.php'</span>;
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a>
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-keyword1">class</span> <a id="Mandrill" href="#Mandrill">Mandrill</a> {
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a>
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$apikey" href="#$apikey">$apikey</a></span>;
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$ch" href="#$ch">$ch</a></span>;
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$root" href="#$root">$root</a></span> = <span class="php-quote">'https://mandrillapp.com/api/1.0'</span>;
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$debug" href="#$debug">$debug</a></span> = <span class="php-keyword1">false</span>;
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a>
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$error_map" href="#$error_map">$error_map</a></span> = <span class="php-keyword1">array</span>(
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-quote">&quot;ValidationError&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_ValidationError&quot;</span>,
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-quote">&quot;Invalid_Key&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Key&quot;</span>,
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-quote">&quot;PaymentRequired&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_PaymentRequired&quot;</span>,
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> <span class="php-quote">&quot;Unknown_Subaccount&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Subaccount&quot;</span>,
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-quote">&quot;Unknown_Template&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Template&quot;</span>,
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-quote">&quot;ServiceUnavailable&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_ServiceUnavailable&quot;</span>,
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-quote">&quot;Unknown_Message&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Message&quot;</span>,
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a> <span class="php-quote">&quot;Invalid_Tag_Name&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Tag_Name&quot;</span>,
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-quote">&quot;Invalid_Reject&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Reject&quot;</span>,
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-quote">&quot;Unknown_Sender&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Sender&quot;</span>,
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a> <span class="php-quote">&quot;Unknown_Url&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Url&quot;</span>,
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-quote">&quot;Unknown_TrackingDomain&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_TrackingDomain&quot;</span>,
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-quote">&quot;Invalid_Template&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_Template&quot;</span>,
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-quote">&quot;Unknown_Webhook&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Webhook&quot;</span>,
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a> <span class="php-quote">&quot;Unknown_InboundDomain&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_InboundDomain&quot;</span>,
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-quote">&quot;Unknown_InboundRoute&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_InboundRoute&quot;</span>,
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-quote">&quot;Unknown_Export&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Export&quot;</span>,
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> <span class="php-quote">&quot;IP_ProvisionLimit&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_IP_ProvisionLimit&quot;</span>,
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> <span class="php-quote">&quot;Unknown_Pool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_Pool&quot;</span>,
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-quote">&quot;NoSendingHistory&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_NoSendingHistory&quot;</span>,
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a> <span class="php-quote">&quot;PoorReputation&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_PoorReputation&quot;</span>,
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-quote">&quot;Unknown_IP&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_IP&quot;</span>,
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-quote">&quot;Invalid_EmptyDefaultPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_EmptyDefaultPool&quot;</span>,
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-quote">&quot;Invalid_DeleteDefaultPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_DeleteDefaultPool&quot;</span>,
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-quote">&quot;Invalid_DeleteNonEmptyPool&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_DeleteNonEmptyPool&quot;</span>,
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-quote">&quot;Invalid_CustomDNS&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_CustomDNS&quot;</span>,
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-quote">&quot;Invalid_CustomDNSPending&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Invalid_CustomDNSPending&quot;</span>,
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-quote">&quot;Metadata_FieldLimit&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Metadata_FieldLimit&quot;</span>,
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-quote">&quot;Unknown_MetadataField&quot;</span> =&gt; <span class="php-quote">&quot;Mandrill_Unknown_MetadataField&quot;</span>
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> );
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$apikey</span>=<span class="php-keyword1">null</span>) {
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword1">if</span>(!<span class="php-var">$apikey</span>) <span class="php-var">$apikey</span> = <span class="php-keyword2">getenv</span>(<span class="php-quote">'MANDRILL_APIKEY'</span>);
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword1">if</span>(!<span class="php-var">$apikey</span>) <span class="php-var">$apikey</span> = <span class="php-var">$this</span>-&gt;readConfigs();
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> <span class="php-keyword1">if</span>(!<span class="php-var">$apikey</span>) <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Mandrill_Error(<span class="php-quote">'You must provide a Mandrill API key'</span>);
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-var">$this</span>-&gt;apikey = <span class="php-var">$apikey</span>;
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a>
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-var">$this</span>-&gt;ch = <span class="php-keyword2">curl_init</span>();
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_USERAGENT, <span class="php-quote">'Mandrill-PHP/1.0.52'</span>);
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_POST, <span class="php-keyword1">true</span>);
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_FOLLOWLOCATION, <span class="php-keyword1">true</span>);
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_HEADER, <span class="php-keyword1">false</span>);
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_RETURNTRANSFER, <span class="php-keyword1">true</span>);
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_CONNECTTIMEOUT, <span class="php-num">30</span>);
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$this</span>-&gt;ch, CURLOPT_TIMEOUT, <span class="php-num">600</span>);
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-var">$this</span>-&gt;root = <span class="php-keyword2">rtrim</span>(<span class="php-var">$this</span>-&gt;root, <span class="php-quote">'/'</span>) . <span class="php-quote">'/'</span>;
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-var">$this</span>-&gt;templates = <span class="php-keyword1">new</span> Mandrill_Templates(<span class="php-var">$this</span>);
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-var">$this</span>-&gt;exports = <span class="php-keyword1">new</span> Mandrill_Exports(<span class="php-var">$this</span>);
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-var">$this</span>-&gt;users = <span class="php-keyword1">new</span> Mandrill_Users(<span class="php-var">$this</span>);
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-var">$this</span>-&gt;rejects = <span class="php-keyword1">new</span> Mandrill_Rejects(<span class="php-var">$this</span>);
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-var">$this</span>-&gt;inbound = <span class="php-keyword1">new</span> Mandrill_Inbound(<span class="php-var">$this</span>);
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-var">$this</span>-&gt;tags = <span class="php-keyword1">new</span> Mandrill_Tags(<span class="php-var">$this</span>);
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-var">$this</span>-&gt;messages = <span class="php-keyword1">new</span> Mandrill_Messages(<span class="php-var">$this</span>);
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-var">$this</span>-&gt;whitelists = <span class="php-keyword1">new</span> Mandrill_Whitelists(<span class="php-var">$this</span>);
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-var">$this</span>-&gt;ips = <span class="php-keyword1">new</span> Mandrill_Ips(<span class="php-var">$this</span>);
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-var">$this</span>-&gt;internal = <span class="php-keyword1">new</span> Mandrill_Internal(<span class="php-var">$this</span>);
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-var">$this</span>-&gt;subaccounts = <span class="php-keyword1">new</span> Mandrill_Subaccounts(<span class="php-var">$this</span>);
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-var">$this</span>-&gt;urls = <span class="php-keyword1">new</span> Mandrill_Urls(<span class="php-var">$this</span>);
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-var">$this</span>-&gt;webhooks = <span class="php-keyword1">new</span> Mandrill_Webhooks(<span class="php-var">$this</span>);
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-var">$this</span>-&gt;senders = <span class="php-keyword1">new</span> Mandrill_Senders(<span class="php-var">$this</span>);
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-var">$this</span>-&gt;metadata = <span class="php-keyword1">new</span> Mandrill_Metadata(<span class="php-var">$this</span>);
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> }
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a>
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___destruct" href="#___destruct">__destruct</a>() {
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> <span class="php-keyword2">curl_close</span>(<span class="php-var">$this</span>-&gt;ch);
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> }
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a>
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_call" href="#_call">call</a>(<span class="php-var">$url</span>, <span class="php-var">$params</span>) {
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-var">$params</span>[<span class="php-quote">'key'</span>] = <span class="php-var">$this</span>-&gt;apikey;
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-var">$params</span> = <span class="php-keyword2">json_encode</span>(<span class="php-var">$params</span>);
</span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-var">$ch</span> = <span class="php-var">$this</span>-&gt;ch;
</span><span id="101" class="l"><a class="l" href="#101">101: </a>
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_URL, <span class="php-var">$this</span>-&gt;root . <span class="php-var">$url</span> . <span class="php-quote">'.json'</span>);
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_HTTPHEADER, <span class="php-keyword1">array</span>(<span class="php-quote">'Content-Type: application/json'</span>));
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_POSTFIELDS, <span class="php-var">$params</span>);
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_VERBOSE, <span class="php-var">$this</span>-&gt;debug);
</span><span id="106" class="l"><a class="l" href="#106">106: </a>
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-var">$start</span> = <span class="php-keyword2">microtime</span>(<span class="php-keyword1">true</span>);
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-var">$this</span>-&gt;<span class="php-keyword2">log</span>(<span class="php-quote">'Call to '</span> . <span class="php-var">$this</span>-&gt;root . <span class="php-var">$url</span> . <span class="php-quote">'.json: '</span> . <span class="php-var">$params</span>);
</span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;debug) {
</span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-var">$curl_buffer</span> = <span class="php-keyword2">fopen</span>(<span class="php-quote">'php://memory'</span>, <span class="php-quote">'w+'</span>);
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-keyword2">curl_setopt</span>(<span class="php-var">$ch</span>, CURLOPT_STDERR, <span class="php-var">$curl_buffer</span>);
</span><span id="112" class="l"><a class="l" href="#112">112: </a> }
</span><span id="113" class="l"><a class="l" href="#113">113: </a>
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-var">$response_body</span> = <span class="php-keyword2">curl_exec</span>(<span class="php-var">$ch</span>);
</span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-var">$info</span> = <span class="php-keyword2">curl_getinfo</span>(<span class="php-var">$ch</span>);
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-var">$time</span> = <span class="php-keyword2">microtime</span>(<span class="php-keyword1">true</span>) - <span class="php-var">$start</span>;
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;debug) {
</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-keyword2">rewind</span>(<span class="php-var">$curl_buffer</span>);
</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-var">$this</span>-&gt;<span class="php-keyword2">log</span>(<span class="php-keyword2">stream_get_contents</span>(<span class="php-var">$curl_buffer</span>));
</span><span id="120" class="l"><a class="l" href="#120">120: </a> <span class="php-keyword2">fclose</span>(<span class="php-var">$curl_buffer</span>);
</span><span id="121" class="l"><a class="l" href="#121">121: </a> }
</span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-var">$this</span>-&gt;<span class="php-keyword2">log</span>(<span class="php-quote">'Completed in '</span> . <span class="php-keyword2">number_format</span>(<span class="php-var">$time</span> * <span class="php-num">1000</span>, <span class="php-num">2</span>) . <span class="php-quote">'ms'</span>);
</span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-var">$this</span>-&gt;<span class="php-keyword2">log</span>(<span class="php-quote">'Got response: '</span> . <span class="php-var">$response_body</span>);
</span><span id="124" class="l"><a class="l" href="#124">124: </a>
</span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-keyword1">if</span>(<span class="php-keyword2">curl_error</span>(<span class="php-var">$ch</span>)) {
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Mandrill_HttpError(<span class="php-quote">&quot;API call to </span><span class="php-var">$url</span><span class="php-quote"> failed: &quot;</span> . <span class="php-keyword2">curl_error</span>(<span class="php-var">$ch</span>));
</span><span id="127" class="l"><a class="l" href="#127">127: </a> }
</span><span id="128" class="l"><a class="l" href="#128">128: </a> <span class="php-var">$result</span> = <span class="php-keyword2">json_decode</span>(<span class="php-var">$response_body</span>, <span class="php-keyword1">true</span>);
</span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-keyword1">if</span>(<span class="php-var">$result</span> === <span class="php-keyword1">null</span>) <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Mandrill_Error(<span class="php-quote">'We were unable to decode the JSON response from the Mandrill API: '</span> . <span class="php-var">$response_body</span>);
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-keyword1">if</span>(<span class="php-keyword2">floor</span>(<span class="php-var">$info</span>[<span class="php-quote">'http_code'</span>] / <span class="php-num">100</span>) &gt;= <span class="php-num">4</span>) {
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-keyword1">throw</span> <span class="php-var">$this</span>-&gt;castError(<span class="php-var">$result</span>);
</span><span id="133" class="l"><a class="l" href="#133">133: </a> }
</span><span id="134" class="l"><a class="l" href="#134">134: </a>
</span><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-keyword1">return</span> <span class="php-var">$result</span>;
</span><span id="136" class="l"><a class="l" href="#136">136: </a> }
</span><span id="137" class="l"><a class="l" href="#137">137: </a>
</span><span id="138" class="l"><a class="l" href="#138">138: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_readConfigs" href="#_readConfigs">readConfigs</a>() {
</span><span id="139" class="l"><a class="l" href="#139">139: </a> <span class="php-var">$paths</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'~/.mandrill.key'</span>, <span class="php-quote">'/etc/mandrill.key'</span>);
</span><span id="140" class="l"><a class="l" href="#140">140: </a> <span class="php-keyword1">foreach</span>(<span class="php-var">$paths</span> <span class="php-keyword1">as</span> <span class="php-var">$path</span>) {
</span><span id="141" class="l"><a class="l" href="#141">141: </a> <span class="php-keyword1">if</span>(<span class="php-keyword2">file_exists</span>(<span class="php-var">$path</span>)) {
</span><span id="142" class="l"><a class="l" href="#142">142: </a> <span class="php-var">$apikey</span> = <span class="php-keyword2">trim</span>(<span class="php-keyword2">file_get_contents</span>(<span class="php-var">$path</span>));
</span><span id="143" class="l"><a class="l" href="#143">143: </a> <span class="php-keyword1">if</span>(<span class="php-var">$apikey</span>) <span class="php-keyword1">return</span> <span class="php-var">$apikey</span>;
</span><span id="144" class="l"><a class="l" href="#144">144: </a> }
</span><span id="145" class="l"><a class="l" href="#145">145: </a> }
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">false</span>;
</span><span id="147" class="l"><a class="l" href="#147">147: </a> }
</span><span id="148" class="l"><a class="l" href="#148">148: </a>
</span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_castError" href="#_castError">castError</a>(<span class="php-var">$result</span>) {
</span><span id="150" class="l"><a class="l" href="#150">150: </a> <span class="php-keyword1">if</span>(<span class="php-var">$result</span>[<span class="php-quote">'status'</span>] !== <span class="php-quote">'error'</span> || !<span class="php-var">$result</span>[<span class="php-quote">'name'</span>]) <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Mandrill_Error(<span class="php-quote">'We received an unexpected error: '</span> . <span class="php-keyword2">json_encode</span>(<span class="php-var">$result</span>));
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a> <span class="php-var">$class</span> = (<span class="php-keyword1">isset</span>(self::<span class="php-var">$error_map</span>[<span class="php-var">$result</span>[<span class="php-quote">'name'</span>]])) ? self::<span class="php-var">$error_map</span>[<span class="php-var">$result</span>[<span class="php-quote">'name'</span>]] : <span class="php-quote">'Mandrill_Error'</span>;
</span><span id="153" class="l"><a class="l" href="#153">153: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> <span class="php-var">$class</span>(<span class="php-var">$result</span>[<span class="php-quote">'message'</span>], <span class="php-var">$result</span>[<span class="php-quote">'code'</span>]);
</span><span id="154" class="l"><a class="l" href="#154">154: </a> }
</span><span id="155" class="l"><a class="l" href="#155">155: </a>
</span><span id="156" class="l"><a class="l" href="#156">156: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">log</span>(<span class="php-var">$msg</span>) {
</span><span id="157" class="l"><a class="l" href="#157">157: </a> <span class="php-keyword1">if</span>(<span class="php-var">$this</span>-&gt;debug) <span class="php-keyword2">error_log</span>(<span class="php-var">$msg</span>);
</span><span id="158" class="l"><a class="l" href="#158">158: </a> }
</span><span id="159" class="l"><a class="l" href="#159">159: </a>}
</span><span id="160" class="l"><a class="l" href="#160">160: </a>
</span><span id="161" class="l"><a class="l" href="#161">161: </a>
</span><span id="162" class="l"><a class="l" href="#162">162: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li class="active"><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Error.html" title="Summary of Mandrill_Error"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,250 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exports.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li class="active"><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Exports.html" title="Summary of Mandrill_Exports"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Exports" href="#Mandrill_Exports">Mandrill_Exports</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Returns information about an export job. If the export job's state is 'complete',
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">the returned data will include a URL you can use to fetch the results. Every export
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">job produces a zip archive, but the format of the archive is distinct for each job
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">type. The api calls that initiate exports include more details about the output format
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">for that job type.
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @param string $id an export job identifier
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @return struct the information about the export
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - type string the type of the export job - activity, reject, or whitelist
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - state string the export job's state - waiting, working, complete, error, or expired.
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is completed.
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> */</span>
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$id</span>) {
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/info'</span>, <span class="php-var">$_params</span>);
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> }
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a>
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-comment">/**
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * Returns a list of your exports.
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * @return array the account's exports
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * - return[] struct the individual export info
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - type string the type of the export job - activity, reject, or whitelist
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - state string the export job's state - waiting, working, complete, error, or expired.
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is completed.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() {
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/list'</span>, <span class="php-var">$_params</span>);
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a> }
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-comment">/**
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">containing a single file named rejects.csv that includes the following fields: email,
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment">reason, detail, created_at, expires_at, last_event_at, expires_at.
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * @param string $notify_email an optional email address to notify when the export job has finished.
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @return struct information about the rejects export job that was started
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * - type string the type of the export job
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * - state string the export job's state
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is complete
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> */</span>
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_rejects" href="#_rejects">rejects</a>(<span class="php-var">$notify_email</span>=<span class="php-keyword1">null</span>) {
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;notify_email&quot;</span> =&gt; <span class="php-var">$notify_email</span>);
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/rejects'</span>, <span class="php-var">$_params</span>);
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> }
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a>
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> <span class="php-comment">/**
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment">containing a single file named whitelist.csv that includes the following fields:
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment">email, detail, created_at.
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * @param string $notify_email an optional email address to notify when the export job has finished.
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * @return struct information about the whitelist export job that was started
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * - type string the type of the export job
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * - state string the export job's state
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is complete
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> */</span>
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_whitelist" href="#_whitelist">whitelist</a>(<span class="php-var">$notify_email</span>=<span class="php-keyword1">null</span>) {
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;notify_email&quot;</span> =&gt; <span class="php-var">$notify_email</span>);
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/whitelist'</span>, <span class="php-var">$_params</span>);
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> }
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a>
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-comment">/**
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * Begins an export of your activity history. The activity will be exported to a zip archive
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment">containing a single file named activity.csv in the same format as you would be able to export
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment">from your account's activity view. It includes the following fields: Date, Email Address,
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment">Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment">metadata fields, they will be included in the exported data.
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * @param string $notify_email an optional email address to notify when the export job has finished
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * @param string $date_from start date as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * @param string $date_to end date as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * @param array $tags an array of tag names to narrow the export to; will match messages that contain ANY of the tags
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * - tags[] string a tag name
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @param array $senders an array of senders to narrow the export to
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - senders[] string a sender address
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * @param array $states an array of states to narrow the export to; messages with ANY of the states will be included
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - states[] string a message state
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * @param array $api_keys an array of api keys to narrow the export to; messsagse sent with ANY of the keys will be included
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - api_keys[] string an API key associated with your account
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * @return struct information about the activity export job that was started
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - id string the unique identifier for this Export. Use this identifier when checking the export job's status
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - created_at string the date and time that the export job was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * - type string the type of the export job
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * - finished_at string the date and time that the export job was finished as a UTC string in YYYY-MM-DD HH:MM:SS format, or null for jobs that have not run
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * - state string the export job's state
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * - result_url string the url for the export job's results, if the job is complete
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> */</span>
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_activity" href="#_activity">activity</a>(<span class="php-var">$notify_email</span>=<span class="php-keyword1">null</span>, <span class="php-var">$date_from</span>=<span class="php-keyword1">null</span>, <span class="php-var">$date_to</span>=<span class="php-keyword1">null</span>, <span class="php-var">$tags</span>=<span class="php-keyword1">null</span>, <span class="php-var">$senders</span>=<span class="php-keyword1">null</span>, <span class="php-var">$states</span>=<span class="php-keyword1">null</span>, <span class="php-var">$api_keys</span>=<span class="php-keyword1">null</span>) {
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;notify_email&quot;</span> =&gt; <span class="php-var">$notify_email</span>, <span class="php-quote">&quot;date_from&quot;</span> =&gt; <span class="php-var">$date_from</span>, <span class="php-quote">&quot;date_to&quot;</span> =&gt; <span class="php-var">$date_to</span>, <span class="php-quote">&quot;tags&quot;</span> =&gt; <span class="php-var">$tags</span>, <span class="php-quote">&quot;senders&quot;</span> =&gt; <span class="php-var">$senders</span>, <span class="php-quote">&quot;states&quot;</span> =&gt; <span class="php-var">$states</span>, <span class="php-quote">&quot;api_keys&quot;</span> =&gt; <span class="php-var">$api_keys</span>);
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'exports/activity'</span>, <span class="php-var">$_params</span>);
</span><span id="108" class="l"><a class="l" href="#108">108: </a> }
</span><span id="109" class="l"><a class="l" href="#109">109: </a>
</span><span id="110" class="l"><a class="l" href="#110">110: </a>}
</span><span id="111" class="l"><a class="l" href="#111">111: </a>
</span><span id="112" class="l"><a class="l" href="#112">112: </a>
</span><span id="113" class="l"><a class="l" href="#113">113: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li class="active"><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_HttpError.html" title="Summary of Mandrill_HttpError"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li class="active"><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_IP_ProvisionLimit.html" title="Summary of Mandrill_IP_ProvisionLimit"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,276 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Inbound.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li class="active"><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Inbound.html" title="Summary of Mandrill_Inbound"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Inbound" href="#Mandrill_Inbound">Mandrill_Inbound</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * List the domains that have been configured for inbound delivery
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @return array the inbound domains associated with the account
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * - return[] struct the individual domain info
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - domain string the domain name that is accepting mail
</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 inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - valid_mx boolean true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> */</span>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_domains" href="#_domains">domains</a>() {
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/domains'</span>, <span class="php-var">$_params</span>);
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a> }
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a> <span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * Add an inbound domain to your account
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * @param string $domain a domain name
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * @return struct information about the domain
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * - domain string the domain name that is accepting mail
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * - created_at string the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * - valid_mx boolean true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addDomain" href="#_addDomain">addDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/add-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a> }
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-comment">/**
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * @param string $domain an existing inbound domain
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * @return struct information about the inbound domain
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * - domain string the domain name that is accepting mail
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * - created_at string the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * - valid_mx boolean true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> */</span>
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_checkDomain" href="#_checkDomain">checkDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/check-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> }
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a>
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-comment">/**
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * @param string $domain an existing inbound domain
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * @return struct information about the deleted domain
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * - domain string the domain name that is accepting mail
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * - created_at string the date and time that the inbound domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * - valid_mx boolean true if this inbound domain has successfully set up an MX record to deliver mail to the Mandrill servers
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> */</span>
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteDomain" href="#_deleteDomain">deleteDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/delete-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> }
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a>
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-comment">/**
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * List the mailbox routes defined for an inbound domain
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * @param string $domain the domain to check
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * @return array the routes associated with the domain
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - return[] struct the individual mailbox route
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - id string the unique identifier of the route
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * - pattern string the search pattern that the mailbox name should match
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * - url string the webhook URL where inbound messages will be published
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_routes" href="#_routes">routes</a>(<span class="php-var">$domain</span>) {
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/routes'</span>, <span class="php-var">$_params</span>);
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> }
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-comment">/**
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * Add a new mailbox route to an inbound domain
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * @param string $domain an existing inbound domain
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * @param string $pattern the search pattern that the mailbox name should match
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * @param string $url the webhook URL where the inbound messages will be published
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * @return struct the added mailbox route information
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * - id string the unique identifier of the route
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * - pattern string the search pattern that the mailbox name should match
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * - url string the webhook URL where inbound messages will be published
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addRoute" href="#_addRoute">addRoute</a>(<span class="php-var">$domain</span>, <span class="php-var">$pattern</span>, <span class="php-var">$url</span>) {
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>, <span class="php-quote">&quot;pattern&quot;</span> =&gt; <span class="php-var">$pattern</span>, <span class="php-quote">&quot;url&quot;</span> =&gt; <span class="php-var">$url</span>);
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/add-route'</span>, <span class="php-var">$_params</span>);
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> }
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-comment">/**
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @param string $id the unique identifier of an existing mailbox route
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @param string $pattern the search pattern that the mailbox name should match
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * @param string $url the webhook URL where the inbound messages will be published
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @return struct the updated mailbox route information
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - id string the unique identifier of the route
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - pattern string the search pattern that the mailbox name should match
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * - url string the webhook URL where inbound messages will be published
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_updateRoute" href="#_updateRoute">updateRoute</a>(<span class="php-var">$id</span>, <span class="php-var">$pattern</span>=<span class="php-keyword1">null</span>, <span class="php-var">$url</span>=<span class="php-keyword1">null</span>) {
</span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>, <span class="php-quote">&quot;pattern&quot;</span> =&gt; <span class="php-var">$pattern</span>, <span class="php-quote">&quot;url&quot;</span> =&gt; <span class="php-var">$url</span>);
</span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/update-route'</span>, <span class="php-var">$_params</span>);
</span><span id="102" class="l"><a class="l" href="#102">102: </a> }
</span><span id="103" class="l"><a class="l" href="#103">103: </a>
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-comment">/**
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * Delete an existing inbound mailbox route
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * @param string $id the unique identifier of an existing route
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * @return struct the deleted mailbox route information
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * - id string the unique identifier of the route
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * - pattern string the search pattern that the mailbox name should match
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * - url string the webhook URL where inbound messages will be published
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> */</span>
</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteRoute" href="#_deleteRoute">deleteRoute</a>(<span class="php-var">$id</span>) {
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/delete-route'</span>, <span class="php-var">$_params</span>);
</span><span id="115" class="l"><a class="l" href="#115">115: </a> }
</span><span id="116" class="l"><a class="l" href="#116">116: </a>
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-comment">/**
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * @param string $raw_message the full MIME document of an email message
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * @param array|null $to optionally define the recipients to receive the message - otherwise we'll use the To, Cc, and Bcc headers provided in the document
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * - to[] string the email address of the recipient
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * @param string $mail_from the address specified in the MAIL FROM stage of the SMTP conversation. Required for the SPF check.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * @param string $helo the identification provided by the client mta in the MTA state of the SMTP conversation. Required for the SPF check.
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * @param string $client_address the remote MTA's ip address. Optional; required for the SPF check.
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * @return array an array of the information for each recipient in the message (usually one) that matched an inbound route
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * - return[] struct the individual recipient information
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * - email string the email address of the matching recipient
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * - pattern string the mailbox route pattern that the recipient matched
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> * - url string the webhook URL that the message was posted to
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> */</span>
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_sendRaw" href="#_sendRaw">sendRaw</a>(<span class="php-var">$raw_message</span>, <span class="php-var">$to</span>=<span class="php-keyword1">null</span>, <span class="php-var">$mail_from</span>=<span class="php-keyword1">null</span>, <span class="php-var">$helo</span>=<span class="php-keyword1">null</span>, <span class="php-var">$client_address</span>=<span class="php-keyword1">null</span>) {
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;raw_message&quot;</span> =&gt; <span class="php-var">$raw_message</span>, <span class="php-quote">&quot;to&quot;</span> =&gt; <span class="php-var">$to</span>, <span class="php-quote">&quot;mail_from&quot;</span> =&gt; <span class="php-var">$mail_from</span>, <span class="php-quote">&quot;helo&quot;</span> =&gt; <span class="php-var">$helo</span>, <span class="php-quote">&quot;client_address&quot;</span> =&gt; <span class="php-var">$client_address</span>);
</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'inbound/send-raw'</span>, <span class="php-var">$_params</span>);
</span><span id="134" class="l"><a class="l" href="#134">134: </a> }
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a>}
</span><span id="137" class="l"><a class="l" href="#137">137: </a>
</span><span id="138" class="l"><a class="l" href="#138">138: </a>
</span><span id="139" class="l"><a class="l" href="#139">139: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,148 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Internal.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li class="active"><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Internal.html" title="Summary of Mandrill_Internal"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Internal" href="#Mandrill_Internal">Mandrill_Internal</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a>}
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a>
</span><span id="10" class="l"><a class="l" href="#10">10: </a>
</span><span id="11" class="l"><a class="l" href="#11">11: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li class="active"><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_CustomDNS.html" title="Summary of Mandrill_Invalid_CustomDNS"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li class="active"><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_CustomDNSPending.html" title="Summary of Mandrill_Invalid_CustomDNSPending"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li class="active"><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_DeleteDefaultPool.html" title="Summary of Mandrill_Invalid_DeleteDefaultPool"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li class="active"><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html" title="Summary of Mandrill_Invalid_DeleteNonEmptyPool"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li class="active"><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_EmptyDefaultPool.html" title="Summary of Mandrill_Invalid_EmptyDefaultPool"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_Key.html" title="Summary of Mandrill_Invalid_Key"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_Reject.html" title="Summary of Mandrill_Invalid_Reject"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_Tag_Name.html" title="Summary of Mandrill_Invalid_Tag_Name"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li class="active"><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Invalid_Template.html" title="Summary of Mandrill_Invalid_Template"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,417 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Ips.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li class="active"><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Ips.html" title="Summary of Mandrill_Ips"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</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> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Lists your dedicated IPs.
</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
</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
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> */</span>
</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>() {
</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>();
</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>);
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> }
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a>
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-comment">/**
</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.
</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
</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
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> }
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a>
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-comment">/**
</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
</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
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment">are processed within 24 hours.
</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
</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
</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
</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
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> }
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-comment">/**
</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,
</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
</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
</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.
</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
</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
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> }
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-comment">/**
</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.
</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
</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
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="111" class="l"><a class="l" href="#111">111: </a> }
</span><span id="112" class="l"><a class="l" href="#112">112: </a>
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-comment">/**
</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.
</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
</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
</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.
</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
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="135" class="l"><a class="l" href="#135">135: </a> }
</span><span id="136" class="l"><a class="l" href="#136">136: </a>
</span><span id="137" class="l"><a class="l" href="#137">137: </a> <span class="php-comment">/**
</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.
</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
</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.
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * - ip string the ip address
</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
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="147" class="l"><a class="l" href="#147">147: </a> }
</span><span id="148" class="l"><a class="l" href="#148">148: </a>
</span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-comment">/**
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * Lists your dedicated IP pools.
</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
</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
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * - name string this pool's name
</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
</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
</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
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> */</span>
</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>() {
</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>();
</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>);
</span><span id="173" class="l"><a class="l" href="#173">173: </a> }
</span><span id="174" class="l"><a class="l" href="#174">174: </a>
</span><span id="175" class="l"><a class="l" href="#175">175: </a> <span class="php-comment">/**
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment"> * Describes a single dedicated IP pool.
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> * @param string $pool a pool name
</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
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * - name string this pool's name
</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
</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
</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
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="199" class="l"><a class="l" href="#199">199: </a> }
</span><span id="200" class="l"><a class="l" href="#200">200: </a>
</span><span id="201" class="l"><a class="l" href="#201">201: </a> <span class="php-comment">/**
</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
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment">name, no action will be performed.
</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
</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
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment"> * - name string this pool's name
</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
</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
</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
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="226" class="l"><a class="l" href="#226">226: </a> }
</span><span id="227" class="l"><a class="l" href="#227">227: </a>
</span><span id="228" class="l"><a class="l" href="#228">228: </a> <span class="php-comment">/**
</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.
</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
</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
</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
</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
</span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="238" class="l"><a class="l" href="#238">238: </a> }
</span><span id="239" class="l"><a class="l" href="#239">239: </a>
</span><span id="240" class="l"><a class="l" href="#240">240: </a> <span class="php-comment">/**
</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
</span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment">DNS for a dedicated IP.
</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
</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
</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
</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
</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
</span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="252" class="l"><a class="l" href="#252">252: </a> }
</span><span id="253" class="l"><a class="l" href="#253">253: </a>
</span><span id="254" class="l"><a class="l" href="#254">254: </a> <span class="php-comment">/**
</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.
</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
</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.
</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
</span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment"> * - ip string the ip address
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</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
</span></span><span id="271" class="l"><a class="l" href="#271">271: </a><span class="php-comment"> */</span>
</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>) {
</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>);
</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>);
</span><span id="275" class="l"><a class="l" href="#275">275: </a> }
</span><span id="276" class="l"><a class="l" href="#276">276: </a>
</span><span id="277" class="l"><a class="l" href="#277">277: </a>}
</span><span id="278" class="l"><a class="l" href="#278">278: </a>
</span><span id="279" class="l"><a class="l" href="#279">279: </a>
</span><span id="280" class="l"><a class="l" href="#280">280: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,546 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Messages.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li class="active"><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Messages.html" title="Summary of Mandrill_Messages"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Messages" href="#Mandrill_Messages">Mandrill_Messages</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Send a new transactional message through Mandrill
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @param struct $message the information on the message to send
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * - html string the full HTML content to be sent
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - text string optional full text content to be sent
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * - subject string the message subject
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - from_email string the sender email address.
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * - from_name string optional from name to be used
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - to array an array of recipient information.
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - to[] struct a single recipient's information.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - name string the optional display name to use for the recipient
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - type string the header type to use for the recipient, defaults to &quot;to&quot; if not provided
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - headers struct optional extra headers to add to the message (most headers are allowed)
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * - important boolean whether or not this message is important, and should be delivered ahead of non-important messages
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * - track_opens boolean whether or not to turn on open tracking for the message
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * - track_clicks boolean whether or not to turn on click tracking for the message
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * - auto_text boolean whether or not to automatically generate a text part for messages that are not given text
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * - auto_html boolean whether or not to automatically generate an HTML part for messages that are not given HTML
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * - inline_css boolean whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * - url_strip_qs boolean whether or not to strip the query string from URLs when aggregating tracked URL data
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * - preserve_recipients boolean whether or not to expose all recipients in to &quot;To&quot; header for each email
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * - view_content_link boolean set to false to remove content logging for sensitive emails
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * - bcc_address string an optional address to receive an exact copy of each recipient's email
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * - tracking_domain string a custom domain to use for tracking opens and clicks instead of mandrillapp.com
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * - signing_domain string a custom domain to use for SPF/DKIM signing instead of mandrill (for &quot;via&quot; or &quot;on behalf of&quot; in email clients)
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - return_path_domain string a custom domain to use for the messages's return-path
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * - merge boolean whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - global_merge_vars array global merge variables to use for all recipients. You can override these per recipient.
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - global_merge_vars[] struct a single global merge variable
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * - name string the global merge variable's name. Merge variable names are case-insensitive and may not start with _
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * - content string the global merge variable's content
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * - merge_vars array per-recipient merge variables, which override global merge variables with the same name.
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * - merge_vars[] struct per-recipient merge variables
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * - rcpt string the email address of the recipient that the merge variables should apply to
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * - vars array the recipient's merge variables
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * - vars[] struct a single merge variable
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * - name string the merge variable's name. Merge variable names are case-insensitive and may not start with _
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * - content string the merge variable's content
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * - tags array an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * - tags[] string a single tag - must not start with an underscore
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * - subaccount string the unique id of a subaccount for this message - must already exist or will fail with an error
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * - google_analytics_domains array an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * - google_analytics_campaign array|string optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead.
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * - metadata array metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * - recipient_metadata array Per-recipient metadata that will override the global values specified in the metadata parameter.
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * - recipient_metadata[] struct metadata for a single recipient
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * - rcpt string the email address of the recipient that the metadata is associated with
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * - values array an associated array containing the recipient's unique metadata. If a key exists in both the per-recipient metadata and the global metadata, the per-recipient metadata will be used.
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * - attachments array an array of supported attachments to add to the message
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * - attachments[] struct a single supported attachment
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - type string the MIME type of the attachment
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - name string the file name of the attachment
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - content string the content of the attachment as a base64-encoded string
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - images array an array of embedded images to add to the message
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - images[] struct a single embedded image
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - type string the MIME type of the image - must start with &quot;image/&quot;
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - name string the Content ID of the image - use &lt;img src=&quot;cid:THIS_VALUE&quot;&gt; to reference the image in your HTML content
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * - content string the content of the image as a base64-encoded string
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * @param boolean $async enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of &quot;queued&quot; for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * @param string $ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * @param string $send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * @return array of structs for each recipient containing the key &quot;email&quot; with the email address and &quot;status&quot; as either &quot;sent&quot;, &quot;queued&quot;, or &quot;rejected&quot;
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * - return[] struct the sending results for a single recipient
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - status string the sending status of the recipient - either &quot;sent&quot;, &quot;queued&quot;, &quot;scheduled&quot;, &quot;rejected&quot;, or &quot;invalid&quot;
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * - reject_reason string the reason for the rejection if the recipient status is &quot;rejected&quot;
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * - _id string the message's unique id
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> */</span>
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_send" href="#_send">send</a>(<span class="php-var">$message</span>, <span class="php-var">$async</span>=<span class="php-keyword1">false</span>, <span class="php-var">$ip_pool</span>=<span class="php-keyword1">null</span>, <span class="php-var">$send_at</span>=<span class="php-keyword1">null</span>) {
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;message&quot;</span> =&gt; <span class="php-var">$message</span>, <span class="php-quote">&quot;async&quot;</span> =&gt; <span class="php-var">$async</span>, <span class="php-quote">&quot;ip_pool&quot;</span> =&gt; <span class="php-var">$ip_pool</span>, <span class="php-quote">&quot;send_at&quot;</span> =&gt; <span class="php-var">$send_at</span>);
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/send'</span>, <span class="php-var">$_params</span>);
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> }
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a>
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-comment">/**
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * Send a new transactional message through Mandrill using a template
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * @param string $template_name the immutable name or slug of a template that exists in the user's account. For backwards-compatibility, the template name may also be used but the immutable slug is preferred.
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * @param array $template_content an array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * - template_content[] struct the injection of a single piece of content into a single editable region
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * - name string the name of the mc:edit editable region to inject into
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * - content string the content to inject
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * @param struct $message the other information on the message to send - same as /messages/send, but without the html content
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * - html string optional full HTML content to be sent if not in template
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * - text string optional full text content to be sent
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - subject string the message subject
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * - from_email string the sender email address.
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - from_name string optional from name to be used
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - to array an array of recipient information.
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - to[] struct a single recipient's information.
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - name string the optional display name to use for the recipient
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - type string the header type to use for the recipient, defaults to &quot;to&quot; if not provided
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * - headers struct optional extra headers to add to the message (most headers are allowed)
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * - important boolean whether or not this message is important, and should be delivered ahead of non-important messages
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * - track_opens boolean whether or not to turn on open tracking for the message
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * - track_clicks boolean whether or not to turn on click tracking for the message
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * - auto_text boolean whether or not to automatically generate a text part for messages that are not given text
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * - auto_html boolean whether or not to automatically generate an HTML part for messages that are not given HTML
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * - inline_css boolean whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * - url_strip_qs boolean whether or not to strip the query string from URLs when aggregating tracked URL data
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * - preserve_recipients boolean whether or not to expose all recipients in to &quot;To&quot; header for each email
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * - view_content_link boolean set to false to remove content logging for sensitive emails
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * - bcc_address string an optional address to receive an exact copy of each recipient's email
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * - tracking_domain string a custom domain to use for tracking opens and clicks instead of mandrillapp.com
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * - signing_domain string a custom domain to use for SPF/DKIM signing instead of mandrill (for &quot;via&quot; or &quot;on behalf of&quot; in email clients)
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * - return_path_domain string a custom domain to use for the messages's return-path
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * - merge boolean whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * - global_merge_vars array global merge variables to use for all recipients. You can override these per recipient.
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * - global_merge_vars[] struct a single global merge variable
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * - name string the global merge variable's name. Merge variable names are case-insensitive and may not start with _
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * - content string the global merge variable's content
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * - merge_vars array per-recipient merge variables, which override global merge variables with the same name.
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * - merge_vars[] struct per-recipient merge variables
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * - rcpt string the email address of the recipient that the merge variables should apply to
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * - vars array the recipient's merge variables
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * - vars[] struct a single merge variable
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * - name string the merge variable's name. Merge variable names are case-insensitive and may not start with _
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * - content string the merge variable's content
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * - tags array an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * - tags[] string a single tag - must not start with an underscore
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * - subaccount string the unique id of a subaccount for this message - must already exist or will fail with an error
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> * - google_analytics_domains array an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * - google_analytics_campaign array|string optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead.
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * - metadata array metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * - recipient_metadata array Per-recipient metadata that will override the global values specified in the metadata parameter.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * - recipient_metadata[] struct metadata for a single recipient
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * - rcpt string the email address of the recipient that the metadata is associated with
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * - values array an associated array containing the recipient's unique metadata. If a key exists in both the per-recipient metadata and the global metadata, the per-recipient metadata will be used.
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * - attachments array an array of supported attachments to add to the message
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * - attachments[] struct a single supported attachment
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * - type string the MIME type of the attachment
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * - name string the file name of the attachment
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * - content string the content of the attachment as a base64-encoded string
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * - images array an array of embedded images to add to the message
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * - images[] struct a single embedded image
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * - type string the MIME type of the image - must start with &quot;image/&quot;
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> * - name string the Content ID of the image - use &lt;img src=&quot;cid:THIS_VALUE&quot;&gt; to reference the image in your HTML content
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> * - content string the content of the image as a base64-encoded string
</span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment"> * @param boolean $async enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of &quot;queued&quot; for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * @param string $ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> * @param string $send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment"> * @return array of structs for each recipient containing the key &quot;email&quot; with the email address and &quot;status&quot; as either &quot;sent&quot;, &quot;queued&quot;, &quot;scheduled&quot;, or &quot;rejected&quot;
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * - return[] struct the sending results for a single recipient
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * - status string the sending status of the recipient - either &quot;sent&quot;, &quot;queued&quot;, &quot;rejected&quot;, or &quot;invalid&quot;
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * - reject_reason string the reason for the rejection if the recipient status is &quot;rejected&quot;
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * - _id string the message's unique id
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> */</span>
</span><span id="156" class="l"><a class="l" href="#156">156: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_sendTemplate" href="#_sendTemplate">sendTemplate</a>(<span class="php-var">$template_name</span>, <span class="php-var">$template_content</span>, <span class="php-var">$message</span>, <span class="php-var">$async</span>=<span class="php-keyword1">false</span>, <span class="php-var">$ip_pool</span>=<span class="php-keyword1">null</span>, <span class="php-var">$send_at</span>=<span class="php-keyword1">null</span>) {
</span><span id="157" class="l"><a class="l" href="#157">157: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;template_name&quot;</span> =&gt; <span class="php-var">$template_name</span>, <span class="php-quote">&quot;template_content&quot;</span> =&gt; <span class="php-var">$template_content</span>, <span class="php-quote">&quot;message&quot;</span> =&gt; <span class="php-var">$message</span>, <span class="php-quote">&quot;async&quot;</span> =&gt; <span class="php-var">$async</span>, <span class="php-quote">&quot;ip_pool&quot;</span> =&gt; <span class="php-var">$ip_pool</span>, <span class="php-quote">&quot;send_at&quot;</span> =&gt; <span class="php-var">$send_at</span>);
</span><span id="158" class="l"><a class="l" href="#158">158: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/send-template'</span>, <span class="php-var">$_params</span>);
</span><span id="159" class="l"><a class="l" href="#159">159: </a> }
</span><span id="160" class="l"><a class="l" href="#160">160: </a>
</span><span id="161" class="l"><a class="l" href="#161">161: </a> <span class="php-comment">/**
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * Search the content of recently sent messages and optionally narrow by date range, tags and senders
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> * @param string $query the search terms to find matching messages for
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> * @param string $date_from start date
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * @param string $date_to end date
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * @param array $tags an array of tag names to narrow the search to, will return messages that contain ANY of the tags
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> * @param array $senders an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * @param array $api_keys an array of API keys to narrow the search to, will return messages sent by ANY of the keys
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * @param integer $limit the maximum number of results to return, defaults to 100, 1000 is the maximum
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> * @return array of structs for each matching message
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> * - return[] struct the information for a single matching message
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> * - ts integer the Unix timestamp from when this message was sent
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> * - _id string the message's unique id
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> * - sender string the email address of the sender
</span></span><span id="175" class="l"><a class="l" href="#175">175: </a><span class="php-comment"> * - template string the unique name of the template used, if any
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment"> * - subject string the message's subject line
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> * - email string the recipient email address
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment"> * - tags array list of tags on this message
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * - tags[] string individual tag on this message
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> * - opens integer how many times has this message been opened
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment"> * - opens_detail array list of individual opens for the message
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> * - opens_detail[] struct information on an individual open
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment"> * - ts integer the unix timestamp from when the message was opened
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment"> * - ip string the IP address that generated the open
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment"> * - location string the approximate region and country that the opening IP is located
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment"> * - ua string the email client or browser data of the open
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment"> * - clicks integer how many times has a link been clicked in this message
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment"> * - clicks_detail array list of individual clicks for the message
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment"> * - clicks_detail[] struct information on an individual click
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment"> * - ts integer the unix timestamp from when the message was clicked
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * - url string the URL that was clicked on
</span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment"> * - ip string the IP address that generated the click
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * - location string the approximate region and country that the clicking IP is located
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * - ua string the email client or browser data of the click
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> * - state string sending status of this message: sent, bounced, rejected
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * - metadata struct any custom metadata provided when the message was sent
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> * - smtp_events array a log of up to 3 smtp events for the message
</span></span><span id="198" class="l"><a class="l" href="#198">198: </a><span class="php-comment"> * - smtp_events[] struct information about a specific smtp event
</span></span><span id="199" class="l"><a class="l" href="#199">199: </a><span class="php-comment"> * - ts integer the Unix timestamp when the event occured
</span></span><span id="200" class="l"><a class="l" href="#200">200: </a><span class="php-comment"> * - type string the message's state as a result of this event
</span></span><span id="201" class="l"><a class="l" href="#201">201: </a><span class="php-comment"> * - diag string the SMTP response from the recipient's server
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment"> */</span>
</span><span id="203" class="l"><a class="l" href="#203">203: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_search" href="#_search">search</a>(<span class="php-var">$query</span>=<span class="php-quote">'*'</span>, <span class="php-var">$date_from</span>=<span class="php-keyword1">null</span>, <span class="php-var">$date_to</span>=<span class="php-keyword1">null</span>, <span class="php-var">$tags</span>=<span class="php-keyword1">null</span>, <span class="php-var">$senders</span>=<span class="php-keyword1">null</span>, <span class="php-var">$api_keys</span>=<span class="php-keyword1">null</span>, <span class="php-var">$limit</span>=<span class="php-num">100</span>) {
</span><span id="204" class="l"><a class="l" href="#204">204: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;query&quot;</span> =&gt; <span class="php-var">$query</span>, <span class="php-quote">&quot;date_from&quot;</span> =&gt; <span class="php-var">$date_from</span>, <span class="php-quote">&quot;date_to&quot;</span> =&gt; <span class="php-var">$date_to</span>, <span class="php-quote">&quot;tags&quot;</span> =&gt; <span class="php-var">$tags</span>, <span class="php-quote">&quot;senders&quot;</span> =&gt; <span class="php-var">$senders</span>, <span class="php-quote">&quot;api_keys&quot;</span> =&gt; <span class="php-var">$api_keys</span>, <span class="php-quote">&quot;limit&quot;</span> =&gt; <span class="php-var">$limit</span>);
</span><span id="205" class="l"><a class="l" href="#205">205: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/search'</span>, <span class="php-var">$_params</span>);
</span><span id="206" class="l"><a class="l" href="#206">206: </a> }
</span><span id="207" class="l"><a class="l" href="#207">207: </a>
</span><span id="208" class="l"><a class="l" href="#208">208: </a> <span class="php-comment">/**
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment"> * Search the content of recently sent messages and return the aggregated hourly stats for matching messages
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment"> * @param string $query the search terms to find matching messages for
</span></span><span id="211" class="l"><a class="l" href="#211">211: </a><span class="php-comment"> * @param string $date_from start date
</span></span><span id="212" class="l"><a class="l" href="#212">212: </a><span class="php-comment"> * @param string $date_to end date
</span></span><span id="213" class="l"><a class="l" href="#213">213: </a><span class="php-comment"> * @param array $tags an array of tag names to narrow the search to, will return messages that contain ANY of the tags
</span></span><span id="214" class="l"><a class="l" href="#214">214: </a><span class="php-comment"> * @param array $senders an array of sender addresses to narrow the search to, will return messages sent by ANY of the senders
</span></span><span id="215" class="l"><a class="l" href="#215">215: </a><span class="php-comment"> * @return array the array of history information
</span></span><span id="216" class="l"><a class="l" href="#216">216: </a><span class="php-comment"> * - return[] struct the stats for a single hour
</span></span><span id="217" class="l"><a class="l" href="#217">217: </a><span class="php-comment"> * - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="218" class="l"><a class="l" href="#218">218: </a><span class="php-comment"> * - sent integer the number of emails that were sent during the hour
</span></span><span id="219" class="l"><a class="l" href="#219">219: </a><span class="php-comment"> * - hard_bounces integer the number of emails that hard bounced during the hour
</span></span><span id="220" class="l"><a class="l" href="#220">220: </a><span class="php-comment"> * - soft_bounces integer the number of emails that soft bounced during the hour
</span></span><span id="221" class="l"><a class="l" href="#221">221: </a><span class="php-comment"> * - rejects integer the number of emails that were rejected during the hour
</span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment"> * - complaints integer the number of spam complaints received during the hour
</span></span><span id="223" class="l"><a class="l" href="#223">223: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes received during the hour
</span></span><span id="224" class="l"><a class="l" href="#224">224: </a><span class="php-comment"> * - opens integer the number of emails opened during the hour
</span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment"> * - unique_opens integer the number of unique opens generated by messages sent during the hour
</span></span><span id="226" class="l"><a class="l" href="#226">226: </a><span class="php-comment"> * - clicks integer the number of tracked URLs clicked during the hour
</span></span><span id="227" class="l"><a class="l" href="#227">227: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks generated by messages sent during the hour
</span></span><span id="228" class="l"><a class="l" href="#228">228: </a><span class="php-comment"> */</span>
</span><span id="229" class="l"><a class="l" href="#229">229: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_searchTimeSeries" href="#_searchTimeSeries">searchTimeSeries</a>(<span class="php-var">$query</span>=<span class="php-quote">'*'</span>, <span class="php-var">$date_from</span>=<span class="php-keyword1">null</span>, <span class="php-var">$date_to</span>=<span class="php-keyword1">null</span>, <span class="php-var">$tags</span>=<span class="php-keyword1">null</span>, <span class="php-var">$senders</span>=<span class="php-keyword1">null</span>) {
</span><span id="230" class="l"><a class="l" href="#230">230: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;query&quot;</span> =&gt; <span class="php-var">$query</span>, <span class="php-quote">&quot;date_from&quot;</span> =&gt; <span class="php-var">$date_from</span>, <span class="php-quote">&quot;date_to&quot;</span> =&gt; <span class="php-var">$date_to</span>, <span class="php-quote">&quot;tags&quot;</span> =&gt; <span class="php-var">$tags</span>, <span class="php-quote">&quot;senders&quot;</span> =&gt; <span class="php-var">$senders</span>);
</span><span id="231" class="l"><a class="l" href="#231">231: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/search-time-series'</span>, <span class="php-var">$_params</span>);
</span><span id="232" class="l"><a class="l" href="#232">232: </a> }
</span><span id="233" class="l"><a class="l" href="#233">233: </a>
</span><span id="234" class="l"><a class="l" href="#234">234: </a> <span class="php-comment">/**
</span></span><span id="235" class="l"><a class="l" href="#235">235: </a><span class="php-comment"> * Get the information for a single recently sent message
</span></span><span id="236" class="l"><a class="l" href="#236">236: </a><span class="php-comment"> * @param string $id the unique id of the message to get - passed as the &quot;_id&quot; field in webhooks, send calls, or search calls
</span></span><span id="237" class="l"><a class="l" href="#237">237: </a><span class="php-comment"> * @return struct the information for the message
</span></span><span id="238" class="l"><a class="l" href="#238">238: </a><span class="php-comment"> * - ts integer the Unix timestamp from when this message was sent
</span></span><span id="239" class="l"><a class="l" href="#239">239: </a><span class="php-comment"> * - _id string the message's unique id
</span></span><span id="240" class="l"><a class="l" href="#240">240: </a><span class="php-comment"> * - sender string the email address of the sender
</span></span><span id="241" class="l"><a class="l" href="#241">241: </a><span class="php-comment"> * - template string the unique name of the template used, if any
</span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment"> * - subject string the message's subject line
</span></span><span id="243" class="l"><a class="l" href="#243">243: </a><span class="php-comment"> * - email string the recipient email address
</span></span><span id="244" class="l"><a class="l" href="#244">244: </a><span class="php-comment"> * - tags array list of tags on this message
</span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment"> * - tags[] string individual tag on this message
</span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment"> * - opens integer how many times has this message been opened
</span></span><span id="247" class="l"><a class="l" href="#247">247: </a><span class="php-comment"> * - opens_detail array list of individual opens for the message
</span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment"> * - opens_detail[] struct information on an individual open
</span></span><span id="249" class="l"><a class="l" href="#249">249: </a><span class="php-comment"> * - ts integer the unix timestamp from when the message was opened
</span></span><span id="250" class="l"><a class="l" href="#250">250: </a><span class="php-comment"> * - ip string the IP address that generated the open
</span></span><span id="251" class="l"><a class="l" href="#251">251: </a><span class="php-comment"> * - location string the approximate region and country that the opening IP is located
</span></span><span id="252" class="l"><a class="l" href="#252">252: </a><span class="php-comment"> * - ua string the email client or browser data of the open
</span></span><span id="253" class="l"><a class="l" href="#253">253: </a><span class="php-comment"> * - clicks integer how many times has a link been clicked in this message
</span></span><span id="254" class="l"><a class="l" href="#254">254: </a><span class="php-comment"> * - clicks_detail array list of individual clicks for the message
</span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment"> * - clicks_detail[] struct information on an individual click
</span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment"> * - ts integer the unix timestamp from when the message was clicked
</span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment"> * - url string the URL that was clicked on
</span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment"> * - ip string the IP address that generated the click
</span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment"> * - location string the approximate region and country that the clicking IP is located
</span></span><span id="260" class="l"><a class="l" href="#260">260: </a><span class="php-comment"> * - ua string the email client or browser data of the click
</span></span><span id="261" class="l"><a class="l" href="#261">261: </a><span class="php-comment"> * - state string sending status of this message: sent, bounced, rejected
</span></span><span id="262" class="l"><a class="l" href="#262">262: </a><span class="php-comment"> * - metadata struct any custom metadata provided when the message was sent
</span></span><span id="263" class="l"><a class="l" href="#263">263: </a><span class="php-comment"> * - smtp_events array a log of up to 3 smtp events for the message
</span></span><span id="264" class="l"><a class="l" href="#264">264: </a><span class="php-comment"> * - smtp_events[] struct information about a specific smtp event
</span></span><span id="265" class="l"><a class="l" href="#265">265: </a><span class="php-comment"> * - ts integer the Unix timestamp when the event occured
</span></span><span id="266" class="l"><a class="l" href="#266">266: </a><span class="php-comment"> * - type string the message's state as a result of this event
</span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment"> * - diag string the SMTP response from the recipient's server
</span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment"> */</span>
</span><span id="269" class="l"><a class="l" href="#269">269: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$id</span>) {
</span><span id="270" class="l"><a class="l" href="#270">270: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="271" class="l"><a class="l" href="#271">271: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/info'</span>, <span class="php-var">$_params</span>);
</span><span id="272" class="l"><a class="l" href="#272">272: </a> }
</span><span id="273" class="l"><a class="l" href="#273">273: </a>
</span><span id="274" class="l"><a class="l" href="#274">274: </a> <span class="php-comment">/**
</span></span><span id="275" class="l"><a class="l" href="#275">275: </a><span class="php-comment"> * Get the full content of a recently sent message
</span></span><span id="276" class="l"><a class="l" href="#276">276: </a><span class="php-comment"> * @param string $id the unique id of the message to get - passed as the &quot;_id&quot; field in webhooks, send calls, or search calls
</span></span><span id="277" class="l"><a class="l" href="#277">277: </a><span class="php-comment"> * @return struct the content of the message
</span></span><span id="278" class="l"><a class="l" href="#278">278: </a><span class="php-comment"> * - ts integer the Unix timestamp from when this message was sent
</span></span><span id="279" class="l"><a class="l" href="#279">279: </a><span class="php-comment"> * - _id string the message's unique id
</span></span><span id="280" class="l"><a class="l" href="#280">280: </a><span class="php-comment"> * - from_email string the email address of the sender
</span></span><span id="281" class="l"><a class="l" href="#281">281: </a><span class="php-comment"> * - from_name string the alias of the sender (if any)
</span></span><span id="282" class="l"><a class="l" href="#282">282: </a><span class="php-comment"> * - subject string the message's subject line
</span></span><span id="283" class="l"><a class="l" href="#283">283: </a><span class="php-comment"> * - to struct the message recipient's information
</span></span><span id="284" class="l"><a class="l" href="#284">284: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="285" class="l"><a class="l" href="#285">285: </a><span class="php-comment"> * - name string the alias of the recipient (if any)
</span></span><span id="286" class="l"><a class="l" href="#286">286: </a><span class="php-comment"> * - tags array list of tags on this message
</span></span><span id="287" class="l"><a class="l" href="#287">287: </a><span class="php-comment"> * - tags[] string individual tag on this message
</span></span><span id="288" class="l"><a class="l" href="#288">288: </a><span class="php-comment"> * - headers struct the key-value pairs of the custom MIME headers for the message's main document
</span></span><span id="289" class="l"><a class="l" href="#289">289: </a><span class="php-comment"> * - text string the text part of the message, if any
</span></span><span id="290" class="l"><a class="l" href="#290">290: </a><span class="php-comment"> * - html string the HTML part of the message, if any
</span></span><span id="291" class="l"><a class="l" href="#291">291: </a><span class="php-comment"> * - attachments array an array of any attachments that can be found in the message
</span></span><span id="292" class="l"><a class="l" href="#292">292: </a><span class="php-comment"> * - attachments[] struct information about an individual attachment
</span></span><span id="293" class="l"><a class="l" href="#293">293: </a><span class="php-comment"> * - name string the file name of the attachment
</span></span><span id="294" class="l"><a class="l" href="#294">294: </a><span class="php-comment"> * - type string the MIME type of the attachment
</span></span><span id="295" class="l"><a class="l" href="#295">295: </a><span class="php-comment"> * - content string the content of the attachment as a base64 encoded string
</span></span><span id="296" class="l"><a class="l" href="#296">296: </a><span class="php-comment"> */</span>
</span><span id="297" class="l"><a class="l" href="#297">297: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_content" href="#_content">content</a>(<span class="php-var">$id</span>) {
</span><span id="298" class="l"><a class="l" href="#298">298: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="299" class="l"><a class="l" href="#299">299: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/content'</span>, <span class="php-var">$_params</span>);
</span><span id="300" class="l"><a class="l" href="#300">300: </a> }
</span><span id="301" class="l"><a class="l" href="#301">301: </a>
</span><span id="302" class="l"><a class="l" href="#302">302: </a> <span class="php-comment">/**
</span></span><span id="303" class="l"><a class="l" href="#303">303: </a><span class="php-comment"> * Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
</span></span><span id="304" class="l"><a class="l" href="#304">304: </a><span class="php-comment"> * @param string $raw_message the full MIME document of an email message
</span></span><span id="305" class="l"><a class="l" href="#305">305: </a><span class="php-comment"> * @return struct the parsed message
</span></span><span id="306" class="l"><a class="l" href="#306">306: </a><span class="php-comment"> * - subject string the subject of the message
</span></span><span id="307" class="l"><a class="l" href="#307">307: </a><span class="php-comment"> * - from_email string the email address of the sender
</span></span><span id="308" class="l"><a class="l" href="#308">308: </a><span class="php-comment"> * - from_name string the alias of the sender (if any)
</span></span><span id="309" class="l"><a class="l" href="#309">309: </a><span class="php-comment"> * - to array an array of any recipients in the message
</span></span><span id="310" class="l"><a class="l" href="#310">310: </a><span class="php-comment"> * - to[] struct the information on a single recipient
</span></span><span id="311" class="l"><a class="l" href="#311">311: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="312" class="l"><a class="l" href="#312">312: </a><span class="php-comment"> * - name string the alias of the recipient (if any)
</span></span><span id="313" class="l"><a class="l" href="#313">313: </a><span class="php-comment"> * - headers struct the key-value pairs of the MIME headers for the message's main document
</span></span><span id="314" class="l"><a class="l" href="#314">314: </a><span class="php-comment"> * - text string the text part of the message, if any
</span></span><span id="315" class="l"><a class="l" href="#315">315: </a><span class="php-comment"> * - html string the HTML part of the message, if any
</span></span><span id="316" class="l"><a class="l" href="#316">316: </a><span class="php-comment"> * - attachments array an array of any attachments that can be found in the message
</span></span><span id="317" class="l"><a class="l" href="#317">317: </a><span class="php-comment"> * - attachments[] struct information about an individual attachment
</span></span><span id="318" class="l"><a class="l" href="#318">318: </a><span class="php-comment"> * - name string the file name of the attachment
</span></span><span id="319" class="l"><a class="l" href="#319">319: </a><span class="php-comment"> * - type string the MIME type of the attachment
</span></span><span id="320" class="l"><a class="l" href="#320">320: </a><span class="php-comment"> * - binary boolean if this is set to true, the attachment is not pure-text, and the content will be base64 encoded
</span></span><span id="321" class="l"><a class="l" href="#321">321: </a><span class="php-comment"> * - content string the content of the attachment as a text string or a base64 encoded string based on the attachment type
</span></span><span id="322" class="l"><a class="l" href="#322">322: </a><span class="php-comment"> * - images array an array of any embedded images that can be found in the message
</span></span><span id="323" class="l"><a class="l" href="#323">323: </a><span class="php-comment"> * - images[] struct information about an individual image
</span></span><span id="324" class="l"><a class="l" href="#324">324: </a><span class="php-comment"> * - name string the Content-ID of the embedded image
</span></span><span id="325" class="l"><a class="l" href="#325">325: </a><span class="php-comment"> * - type string the MIME type of the image
</span></span><span id="326" class="l"><a class="l" href="#326">326: </a><span class="php-comment"> * - content string the content of the image as a base64 encoded string
</span></span><span id="327" class="l"><a class="l" href="#327">327: </a><span class="php-comment"> */</span>
</span><span id="328" class="l"><a class="l" href="#328">328: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_parse" href="#_parse">parse</a>(<span class="php-var">$raw_message</span>) {
</span><span id="329" class="l"><a class="l" href="#329">329: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;raw_message&quot;</span> =&gt; <span class="php-var">$raw_message</span>);
</span><span id="330" class="l"><a class="l" href="#330">330: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/parse'</span>, <span class="php-var">$_params</span>);
</span><span id="331" class="l"><a class="l" href="#331">331: </a> }
</span><span id="332" class="l"><a class="l" href="#332">332: </a>
</span><span id="333" class="l"><a class="l" href="#333">333: </a> <span class="php-comment">/**
</span></span><span id="334" class="l"><a class="l" href="#334">334: </a><span class="php-comment"> * Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
</span></span><span id="335" class="l"><a class="l" href="#335">335: </a><span class="php-comment"> * @param string $raw_message the full MIME document of an email message
</span></span><span id="336" class="l"><a class="l" href="#336">336: </a><span class="php-comment"> * @param string|null $from_email optionally define the sender address - otherwise we'll use the address found in the provided headers
</span></span><span id="337" class="l"><a class="l" href="#337">337: </a><span class="php-comment"> * @param string|null $from_name optionally define the sender alias
</span></span><span id="338" class="l"><a class="l" href="#338">338: </a><span class="php-comment"> * @param array|null $to optionally define the recipients to receive the message - otherwise we'll use the To, Cc, and Bcc headers provided in the document
</span></span><span id="339" class="l"><a class="l" href="#339">339: </a><span class="php-comment"> * - to[] string the email address of the recipient
</span></span><span id="340" class="l"><a class="l" href="#340">340: </a><span class="php-comment"> * @param boolean $async enable a background sending mode that is optimized for bulk sending. In async mode, messages/sendRaw will immediately return a status of &quot;queued&quot; for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
</span></span><span id="341" class="l"><a class="l" href="#341">341: </a><span class="php-comment"> * @param string $ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
</span></span><span id="342" class="l"><a class="l" href="#342">342: </a><span class="php-comment"> * @param string $send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately.
</span></span><span id="343" class="l"><a class="l" href="#343">343: </a><span class="php-comment"> * @param string $return_path_domain a custom domain to use for the messages's return-path
</span></span><span id="344" class="l"><a class="l" href="#344">344: </a><span class="php-comment"> * @return array of structs for each recipient containing the key &quot;email&quot; with the email address and &quot;status&quot; as either &quot;sent&quot;, &quot;queued&quot;, or &quot;rejected&quot;
</span></span><span id="345" class="l"><a class="l" href="#345">345: </a><span class="php-comment"> * - return[] struct the sending results for a single recipient
</span></span><span id="346" class="l"><a class="l" href="#346">346: </a><span class="php-comment"> * - email string the email address of the recipient
</span></span><span id="347" class="l"><a class="l" href="#347">347: </a><span class="php-comment"> * - status string the sending status of the recipient - either &quot;sent&quot;, &quot;queued&quot;, &quot;scheduled&quot;, &quot;rejected&quot;, or &quot;invalid&quot;
</span></span><span id="348" class="l"><a class="l" href="#348">348: </a><span class="php-comment"> * - reject_reason string the reason for the rejection if the recipient status is &quot;rejected&quot;
</span></span><span id="349" class="l"><a class="l" href="#349">349: </a><span class="php-comment"> * - _id string the message's unique id
</span></span><span id="350" class="l"><a class="l" href="#350">350: </a><span class="php-comment"> */</span>
</span><span id="351" class="l"><a class="l" href="#351">351: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_sendRaw" href="#_sendRaw">sendRaw</a>(<span class="php-var">$raw_message</span>, <span class="php-var">$from_email</span>=<span class="php-keyword1">null</span>, <span class="php-var">$from_name</span>=<span class="php-keyword1">null</span>, <span class="php-var">$to</span>=<span class="php-keyword1">null</span>, <span class="php-var">$async</span>=<span class="php-keyword1">false</span>, <span class="php-var">$ip_pool</span>=<span class="php-keyword1">null</span>, <span class="php-var">$send_at</span>=<span class="php-keyword1">null</span>, <span class="php-var">$return_path_domain</span>=<span class="php-keyword1">null</span>) {
</span><span id="352" class="l"><a class="l" href="#352">352: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;raw_message&quot;</span> =&gt; <span class="php-var">$raw_message</span>, <span class="php-quote">&quot;from_email&quot;</span> =&gt; <span class="php-var">$from_email</span>, <span class="php-quote">&quot;from_name&quot;</span> =&gt; <span class="php-var">$from_name</span>, <span class="php-quote">&quot;to&quot;</span> =&gt; <span class="php-var">$to</span>, <span class="php-quote">&quot;async&quot;</span> =&gt; <span class="php-var">$async</span>, <span class="php-quote">&quot;ip_pool&quot;</span> =&gt; <span class="php-var">$ip_pool</span>, <span class="php-quote">&quot;send_at&quot;</span> =&gt; <span class="php-var">$send_at</span>, <span class="php-quote">&quot;return_path_domain&quot;</span> =&gt; <span class="php-var">$return_path_domain</span>);
</span><span id="353" class="l"><a class="l" href="#353">353: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/send-raw'</span>, <span class="php-var">$_params</span>);
</span><span id="354" class="l"><a class="l" href="#354">354: </a> }
</span><span id="355" class="l"><a class="l" href="#355">355: </a>
</span><span id="356" class="l"><a class="l" href="#356">356: </a> <span class="php-comment">/**
</span></span><span id="357" class="l"><a class="l" href="#357">357: </a><span class="php-comment"> * Queries your scheduled emails by sender or recipient, or both.
</span></span><span id="358" class="l"><a class="l" href="#358">358: </a><span class="php-comment"> * @param string $to an optional recipient address to restrict results to
</span></span><span id="359" class="l"><a class="l" href="#359">359: </a><span class="php-comment"> * @return array a list of up to 1000 scheduled emails
</span></span><span id="360" class="l"><a class="l" href="#360">360: </a><span class="php-comment"> * - return[] struct a scheduled email
</span></span><span id="361" class="l"><a class="l" href="#361">361: </a><span class="php-comment"> * - _id string the scheduled message id
</span></span><span id="362" class="l"><a class="l" href="#362">362: </a><span class="php-comment"> * - created_at string the UTC timestamp when the message was created, in YYYY-MM-DD HH:MM:SS format
</span></span><span id="363" class="l"><a class="l" href="#363">363: </a><span class="php-comment"> * - send_at string the UTC timestamp when the message will be sent, in YYYY-MM-DD HH:MM:SS format
</span></span><span id="364" class="l"><a class="l" href="#364">364: </a><span class="php-comment"> * - from_email string the email's sender address
</span></span><span id="365" class="l"><a class="l" href="#365">365: </a><span class="php-comment"> * - to string the email's recipient
</span></span><span id="366" class="l"><a class="l" href="#366">366: </a><span class="php-comment"> * - subject string the email's subject
</span></span><span id="367" class="l"><a class="l" href="#367">367: </a><span class="php-comment"> */</span>
</span><span id="368" class="l"><a class="l" href="#368">368: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_listScheduled" href="#_listScheduled">listScheduled</a>(<span class="php-var">$to</span>=<span class="php-keyword1">null</span>) {
</span><span id="369" class="l"><a class="l" href="#369">369: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;to&quot;</span> =&gt; <span class="php-var">$to</span>);
</span><span id="370" class="l"><a class="l" href="#370">370: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/list-scheduled'</span>, <span class="php-var">$_params</span>);
</span><span id="371" class="l"><a class="l" href="#371">371: </a> }
</span><span id="372" class="l"><a class="l" href="#372">372: </a>
</span><span id="373" class="l"><a class="l" href="#373">373: </a> <span class="php-comment">/**
</span></span><span id="374" class="l"><a class="l" href="#374">374: </a><span class="php-comment"> * Cancels a scheduled email.
</span></span><span id="375" class="l"><a class="l" href="#375">375: </a><span class="php-comment"> * @param string $id a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled
</span></span><span id="376" class="l"><a class="l" href="#376">376: </a><span class="php-comment"> * @return struct information about the scheduled email that was cancelled.
</span></span><span id="377" class="l"><a class="l" href="#377">377: </a><span class="php-comment"> * - _id string the scheduled message id
</span></span><span id="378" class="l"><a class="l" href="#378">378: </a><span class="php-comment"> * - created_at string the UTC timestamp when the message was created, in YYYY-MM-DD HH:MM:SS format
</span></span><span id="379" class="l"><a class="l" href="#379">379: </a><span class="php-comment"> * - send_at string the UTC timestamp when the message will be sent, in YYYY-MM-DD HH:MM:SS format
</span></span><span id="380" class="l"><a class="l" href="#380">380: </a><span class="php-comment"> * - from_email string the email's sender address
</span></span><span id="381" class="l"><a class="l" href="#381">381: </a><span class="php-comment"> * - to string the email's recipient
</span></span><span id="382" class="l"><a class="l" href="#382">382: </a><span class="php-comment"> * - subject string the email's subject
</span></span><span id="383" class="l"><a class="l" href="#383">383: </a><span class="php-comment"> */</span>
</span><span id="384" class="l"><a class="l" href="#384">384: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_cancelScheduled" href="#_cancelScheduled">cancelScheduled</a>(<span class="php-var">$id</span>) {
</span><span id="385" class="l"><a class="l" href="#385">385: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="386" class="l"><a class="l" href="#386">386: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/cancel-scheduled'</span>, <span class="php-var">$_params</span>);
</span><span id="387" class="l"><a class="l" href="#387">387: </a> }
</span><span id="388" class="l"><a class="l" href="#388">388: </a>
</span><span id="389" class="l"><a class="l" href="#389">389: </a> <span class="php-comment">/**
</span></span><span id="390" class="l"><a class="l" href="#390">390: </a><span class="php-comment"> * Reschedules a scheduled email.
</span></span><span id="391" class="l"><a class="l" href="#391">391: </a><span class="php-comment"> * @param string $id a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled
</span></span><span id="392" class="l"><a class="l" href="#392">392: </a><span class="php-comment"> * @param string $send_at the new UTC timestamp when the message should sent. Mandrill can't time travel, so if you specify a time in past the message will be sent immediately
</span></span><span id="393" class="l"><a class="l" href="#393">393: </a><span class="php-comment"> * @return struct information about the scheduled email that was rescheduled.
</span></span><span id="394" class="l"><a class="l" href="#394">394: </a><span class="php-comment"> * - _id string the scheduled message id
</span></span><span id="395" class="l"><a class="l" href="#395">395: </a><span class="php-comment"> * - created_at string the UTC timestamp when the message was created, in YYYY-MM-DD HH:MM:SS format
</span></span><span id="396" class="l"><a class="l" href="#396">396: </a><span class="php-comment"> * - send_at string the UTC timestamp when the message will be sent, in YYYY-MM-DD HH:MM:SS format
</span></span><span id="397" class="l"><a class="l" href="#397">397: </a><span class="php-comment"> * - from_email string the email's sender address
</span></span><span id="398" class="l"><a class="l" href="#398">398: </a><span class="php-comment"> * - to string the email's recipient
</span></span><span id="399" class="l"><a class="l" href="#399">399: </a><span class="php-comment"> * - subject string the email's subject
</span></span><span id="400" class="l"><a class="l" href="#400">400: </a><span class="php-comment"> */</span>
</span><span id="401" class="l"><a class="l" href="#401">401: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_reschedule" href="#_reschedule">reschedule</a>(<span class="php-var">$id</span>, <span class="php-var">$send_at</span>) {
</span><span id="402" class="l"><a class="l" href="#402">402: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>, <span class="php-quote">&quot;send_at&quot;</span> =&gt; <span class="php-var">$send_at</span>);
</span><span id="403" class="l"><a class="l" href="#403">403: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'messages/reschedule'</span>, <span class="php-var">$_params</span>);
</span><span id="404" class="l"><a class="l" href="#404">404: </a> }
</span><span id="405" class="l"><a class="l" href="#405">405: </a>
</span><span id="406" class="l"><a class="l" href="#406">406: </a>}
</span><span id="407" class="l"><a class="l" href="#407">407: </a>
</span><span id="408" class="l"><a class="l" href="#408">408: </a>
</span><span id="409" class="l"><a class="l" href="#409">409: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Metadata.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li class="active"><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Metadata.html" title="Summary of Mandrill_Metadata"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata" href="#Mandrill_Metadata">Mandrill_Metadata</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Get the list of custom metadata fields indexed for the account.
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @return array the custom metadata fields for the account
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * - return[] struct the individual custom metadata field info
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * - name string the unique identifier of the metadata field to update
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * - state string the current state of the metadata field, one of &quot;active&quot;, &quot;delete&quot;, or &quot;index&quot;
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * - view_template string Mustache template to control how the metadata is rendered in your activity log
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> */</span>
</span><span id="16" class="l"><a class="l" href="#16">16: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() {
</span><span id="17" class="l"><a class="l" href="#17">17: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'metadata/list'</span>, <span class="php-var">$_params</span>);
</span><span id="19" class="l"><a class="l" href="#19">19: </a> }
</span><span id="20" class="l"><a class="l" href="#20">20: </a>
</span><span id="21" class="l"><a class="l" href="#21">21: </a> <span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * Add a new custom metadata field to be indexed for the account.
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * @param string $name a unique identifier for the metadata field
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> * @param string $view_template optional Mustache template to control how the metadata is rendered in your activity log
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * @return struct the information saved about the new metadata field
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * - name string the unique identifier of the metadata field to update
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * - state string the current state of the metadata field, one of &quot;active&quot;, &quot;delete&quot;, or &quot;index&quot;
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> * - view_template string Mustache template to control how the metadata is rendered in your activity log
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> */</span>
</span><span id="30" class="l"><a class="l" href="#30">30: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add" href="#_add">add</a>(<span class="php-var">$name</span>, <span class="php-var">$view_template</span>=<span class="php-keyword1">null</span>) {
</span><span id="31" class="l"><a class="l" href="#31">31: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>, <span class="php-quote">&quot;view_template&quot;</span> =&gt; <span class="php-var">$view_template</span>);
</span><span id="32" class="l"><a class="l" href="#32">32: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'metadata/add'</span>, <span class="php-var">$_params</span>);
</span><span id="33" class="l"><a class="l" href="#33">33: </a> }
</span><span id="34" class="l"><a class="l" href="#34">34: </a>
</span><span id="35" class="l"><a class="l" href="#35">35: </a> <span class="php-comment">/**
</span></span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-comment"> * Update an existing custom metadata field.
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * @param string $name the unique identifier of the metadata field to update
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> * @param string $view_template optional Mustache template to control how the metadata is rendered in your activity log
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * @return struct the information for the updated metadata field
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> * - name string the unique identifier of the metadata field to update
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> * - state string the current state of the metadata field, one of &quot;active&quot;, &quot;delete&quot;, or &quot;index&quot;
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> * - view_template string Mustache template to control how the metadata is rendered in your activity log
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> */</span>
</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> <a id="_update" href="#_update">update</a>(<span class="php-var">$name</span>, <span class="php-var">$view_template</span>) {
</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;name&quot;</span> =&gt; <span class="php-var">$name</span>, <span class="php-quote">&quot;view_template&quot;</span> =&gt; <span class="php-var">$view_template</span>);
</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">'metadata/update'</span>, <span class="php-var">$_params</span>);
</span><span id="47" class="l"><a class="l" href="#47">47: </a> }
</span><span id="48" class="l"><a class="l" href="#48">48: </a>
</span><span id="49" class="l"><a class="l" href="#49">49: </a> <span class="php-comment">/**
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> * Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> * @param string $name the unique identifier of the metadata field to update
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> * @return struct the information for the deleted metadata field
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment"> * - name string the unique identifier of the metadata field to update
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> * - state string the current state of the metadata field, one of &quot;active&quot;, &quot;delete&quot;, or &quot;index&quot;
</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment"> * - view_template string Mustache template to control how the metadata is rendered in your activity log
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> */</span>
</span><span id="57" class="l"><a class="l" href="#57">57: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$name</span>) {
</span><span id="58" class="l"><a class="l" href="#58">58: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>);
</span><span id="59" class="l"><a class="l" href="#59">59: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'metadata/delete'</span>, <span class="php-var">$_params</span>);
</span><span id="60" class="l"><a class="l" href="#60">60: </a> }
</span><span id="61" class="l"><a class="l" href="#61">61: </a>
</span><span id="62" class="l"><a class="l" href="#62">62: </a>}
</span><span id="63" class="l"><a class="l" href="#63">63: </a>
</span><span id="64" class="l"><a class="l" href="#64">64: </a>
</span><span id="65" class="l"><a class="l" href="#65">65: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li class="active"><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Metadata_FieldLimit.html" title="Summary of Mandrill_Metadata_FieldLimit"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li class="active"><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_NoSendingHistory.html" title="Summary of Mandrill_NoSendingHistory"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li class="active"><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_PaymentRequired.html" title="Summary of Mandrill_PaymentRequired"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li class="active"><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_PoorReputation.html" title="Summary of Mandrill_PoorReputation"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,218 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Rejects.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li class="active"><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Rejects.html" title="Summary of Mandrill_Rejects"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Rejects" href="#Mandrill_Rejects">Mandrill_Rejects</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</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 blacklist. Addresses that you
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment">add manually will never expire and there is no reputation penalty
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment">for removing them from your blacklist. Attempting to blacklist an
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment">address that has been whitelisted will have no effect.
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * @param string $email an email address to block
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * @param string $comment an optional comment describing the rejection
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * @param string $subaccount an optional unique identifier for the subaccount to limit the blacklist entry
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @return struct a status object containing the address and the result of the operation
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * - email string the email address you provided
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * - added boolean whether the operation succeeded
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> */</span>
</span><span id="20" class="l"><a class="l" href="#20">20: </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>, <span class="php-var">$comment</span>=<span class="php-keyword1">null</span>, <span class="php-var">$subaccount</span>=<span class="php-keyword1">null</span>) {
</span><span id="21" class="l"><a class="l" href="#21">21: </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>, <span class="php-quote">&quot;comment&quot;</span> =&gt; <span class="php-var">$comment</span>, <span class="php-quote">&quot;subaccount&quot;</span> =&gt; <span class="php-var">$subaccount</span>);
</span><span id="22" class="l"><a class="l" href="#22">22: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'rejects/add'</span>, <span class="php-var">$_params</span>);
</span><span id="23" class="l"><a class="l" href="#23">23: </a> }
</span><span id="24" class="l"><a class="l" href="#24">24: </a>
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-comment">/**
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> * Retrieves your email rejection blacklist. You can provide an email
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment">address to limit the results. Returns up to 1000 results. By default,
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment">entries that have expired are excluded from the results; set
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment">include_expired to true to include them.
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * @param string $email an optional email address to search by
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * @param boolean $include_expired whether to include rejections that have already expired.
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * @param string $subaccount an optional unique identifier for the subaccount to limit the blacklist
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> * @return array Up to 1000 rejection entries
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * - return[] struct the information for each rejection blacklist entry
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> * - email string the email that is blocked
</span></span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-comment"> * - reason string the type of event (hard-bounce, soft-bounce, spam, unsub) that caused this rejection
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment"> * - detail string extended details about the event, such as the SMTP diagnostic for bounces or the comment for manually-created rejections
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment"> * - created_at string when the email was added to the blacklist
</span></span><span id="39" class="l"><a class="l" href="#39">39: </a><span class="php-comment"> * - last_event_at string the timestamp of the most recent event that either created or renewed this rejection
</span></span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment"> * - expires_at string when the blacklist entry will expire (this may be in the past)
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> * - expired boolean whether the blacklist entry has expired
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> * - sender struct the sender that this blacklist entry applies to, or null if none.
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * - address string the sender's email address
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> * - created_at string the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment"> * - sent integer the total number of messages sent by this sender
</span></span><span id="46" class="l"><a class="l" href="#46">46: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages by this sender
</span></span><span id="47" class="l"><a class="l" href="#47">47: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages by this sender
</span></span><span id="48" class="l"><a class="l" href="#48">48: </a><span class="php-comment"> * - rejects integer the total number of rejected messages by this sender
</span></span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages by this sender
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages by this sender
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> * - opens integer the total number of times messages by this sender have been opened
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages by this sender have been clicked
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender
</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment"> * - subaccount string the subaccount that this blacklist entry applies to, or null if none.
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> */</span>
</span><span id="57" class="l"><a class="l" href="#57">57: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>(<span class="php-var">$email</span>=<span class="php-keyword1">null</span>, <span class="php-var">$include_expired</span>=<span class="php-keyword1">false</span>, <span class="php-var">$subaccount</span>=<span class="php-keyword1">null</span>) {
</span><span id="58" class="l"><a class="l" href="#58">58: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;email&quot;</span> =&gt; <span class="php-var">$email</span>, <span class="php-quote">&quot;include_expired&quot;</span> =&gt; <span class="php-var">$include_expired</span>, <span class="php-quote">&quot;subaccount&quot;</span> =&gt; <span class="php-var">$subaccount</span>);
</span><span id="59" class="l"><a class="l" href="#59">59: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'rejects/list'</span>, <span class="php-var">$_params</span>);
</span><span id="60" class="l"><a class="l" href="#60">60: </a> }
</span><span id="61" class="l"><a class="l" href="#61">61: </a>
</span><span id="62" class="l"><a class="l" href="#62">62: </a> <span class="php-comment">/**
</span></span><span id="63" class="l"><a class="l" href="#63">63: </a><span class="php-comment"> * Deletes an email rejection. There is no limit to how many rejections
</span></span><span id="64" class="l"><a class="l" href="#64">64: </a><span class="php-comment">you can remove from your blacklist, but keep in mind that each deletion
</span></span><span id="65" class="l"><a class="l" href="#65">65: </a><span class="php-comment">has an affect on your reputation.
</span></span><span id="66" class="l"><a class="l" href="#66">66: </a><span class="php-comment"> * @param string $email an email address
</span></span><span id="67" class="l"><a class="l" href="#67">67: </a><span class="php-comment"> * @param string $subaccount an optional unique identifier for the subaccount to limit the blacklist deletion
</span></span><span id="68" class="l"><a class="l" href="#68">68: </a><span class="php-comment"> * @return struct a status object containing the address and whether the deletion succeeded.
</span></span><span id="69" class="l"><a class="l" href="#69">69: </a><span class="php-comment"> * - email string the email address that was removed from the blacklist
</span></span><span id="70" class="l"><a class="l" href="#70">70: </a><span class="php-comment"> * - deleted boolean whether the address was deleted successfully.
</span></span><span id="71" class="l"><a class="l" href="#71">71: </a><span class="php-comment"> * - subaccount string the subaccount blacklist that the address was removed from, if any
</span></span><span id="72" class="l"><a class="l" href="#72">72: </a><span class="php-comment"> */</span>
</span><span id="73" class="l"><a class="l" href="#73">73: </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>, <span class="php-var">$subaccount</span>=<span class="php-keyword1">null</span>) {
</span><span id="74" class="l"><a class="l" href="#74">74: </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>, <span class="php-quote">&quot;subaccount&quot;</span> =&gt; <span class="php-var">$subaccount</span>);
</span><span id="75" class="l"><a class="l" href="#75">75: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'rejects/delete'</span>, <span class="php-var">$_params</span>);
</span><span id="76" class="l"><a class="l" href="#76">76: </a> }
</span><span id="77" class="l"><a class="l" href="#77">77: </a>
</span><span id="78" class="l"><a class="l" href="#78">78: </a>}
</span><span id="79" class="l"><a class="l" href="#79">79: </a>
</span><span id="80" class="l"><a class="l" href="#80">80: </a>
</span><span id="81" class="l"><a class="l" href="#81">81: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,356 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Senders.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li class="active"><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Senders.html" title="Summary of Mandrill_Senders"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Senders" href="#Mandrill_Senders">Mandrill_Senders</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Return the senders that have tried to use this account.
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @return array an array of sender data, one for each sending addresses used by the account
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * - return[] struct the information on each sending address in the account
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - address string the sender's email address
</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 sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - sent integer the total number of messages sent by this sender
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages by this sender
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages by this sender
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - rejects integer the total number of rejected messages by this sender
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages by this sender
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages by this sender
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - opens integer the total number of times messages by this sender have been opened
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages by this sender have been clicked
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> */</span>
</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>() {
</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>();
</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">'senders/list'</span>, <span class="php-var">$_params</span>);
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> }
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a>
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-comment">/**
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * Returns the sender domains that have been added to this account.
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * @return array an array of sender domain data, one for each sending domain used by the account
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * - return[] struct the information on each sending domain for the account
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - domain string the sender domain name
</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 sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - spf struct details about the domain's SPF record
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * - valid boolean whether the domain's SPF record is valid for use with Mandrill
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * - valid_after string when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * - error string an error describing the spf record, or null if the record is correct
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * - dkim struct details about the domain's DKIM record
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * - valid boolean whether the domain's DKIM record is valid for use with Mandrill
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * - valid_after string when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * - error string an error describing the DKIM record, or null if the record is correct
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * - verified_at string if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * - valid_signing boolean whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> */</span>
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_domains" href="#_domains">domains</a>() {
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/domains'</span>, <span class="php-var">$_params</span>);
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> }
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a>
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-comment">/**
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * Adds a sender domain to your account. Sender domains are added automatically as you
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment">send, but you can use this call to add them ahead of time.
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * @param string $domain a domain name
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * @return struct information about the domain
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * - domain string the sender domain name
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - created_at string the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - spf struct details about the domain's SPF record
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - valid boolean whether the domain's SPF record is valid for use with Mandrill
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - valid_after string when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - error string an error describing the spf record, or null if the record is correct
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - dkim struct details about the domain's DKIM record
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * - valid boolean whether the domain's DKIM record is valid for use with Mandrill
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * - valid_after string when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * - error string an error describing the DKIM record, or null if the record is correct
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * - verified_at string if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * - valid_signing boolean whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> */</span>
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addDomain" href="#_addDomain">addDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/add-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> }
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a>
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-comment">/**
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment">account, it will be added automatically.
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * @param string $domain a domain name
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * @return struct information about the sender domain
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * - domain string the sender domain name
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * - created_at string the date and time that the sending domain was first seen as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * - last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * - spf struct details about the domain's SPF record
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * - valid boolean whether the domain's SPF record is valid for use with Mandrill
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * - valid_after string when the domain's SPF record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * - error string an error describing the spf record, or null if the record is correct
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * - dkim struct details about the domain's DKIM record
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * - valid boolean whether the domain's DKIM record is valid for use with Mandrill
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * - valid_after string when the domain's DKIM record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - error string an error describing the DKIM record, or null if the record is correct
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * - verified_at string if the domain has been verified, this indicates when that verification occurred as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - valid_signing boolean whether this domain can be used to authenticate mail, either for itself or as a custom signing domain. If this is false but spf and dkim are both valid, you will need to verify the domain before using it to authenticate mail
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> */</span>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_checkDomain" href="#_checkDomain">checkDomain</a>(<span class="php-var">$domain</span>) {
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/check-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> }
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * Sends a verification email in order to verify ownership of a domain.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment">Domain verification is an optional step to confirm ownership of a domain. Once a
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment">domain has been verified in a Mandrill account, other accounts may not have their
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment">messages signed by that domain unless they also verify the domain. This prevents
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">other Mandrill accounts from sending mail signed by your domain.
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * @param string $domain a domain name at which you can receive email
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * @param string $mailbox a mailbox at the domain where the verification email should be sent
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * @return struct information about the verification that was sent
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * - status string &quot;sent&quot; indicates that the verification has been sent, &quot;already_verified&quot; indicates that the domain has already been verified with your account
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * - domain string the domain name you provided
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * - email string the email address the verification email was sent to
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_verifyDomain" href="#_verifyDomain">verifyDomain</a>(<span class="php-var">$domain</span>, <span class="php-var">$mailbox</span>) {
</span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>, <span class="php-quote">&quot;mailbox&quot;</span> =&gt; <span class="php-var">$mailbox</span>);
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/verify-domain'</span>, <span class="php-var">$_params</span>);
</span><span id="117" class="l"><a class="l" href="#117">117: </a> }
</span><span id="118" class="l"><a class="l" href="#118">118: </a>
</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-comment">/**
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * Return more detailed information about a single sender, including aggregates of recent stats
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * @param string $address the email address of the sender
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * @return struct the detailed information on the sender
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * - address string the sender's email address
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * - created_at string the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * - sent integer the total number of messages sent by this sender
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages by this sender
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages by this sender
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * - rejects integer the total number of rejected messages by this sender
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages by this sender
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages by this sender
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * - opens integer the total number of times messages by this sender have been opened
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages by this sender have been clicked
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * - stats struct an aggregate summary of the sender's sending stats
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * - today struct stats for this sender so far today
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * - sent integer the number of emails sent for this sender so far today
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this sender so far today
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this sender so far today
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this sender so far today
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this sender so far today
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this sender so far today
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this sender so far today
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender so far today
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this sender so far today
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender so far today
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> * - last_7_days struct stats for this sender in the last 7 days
</span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment"> * - sent integer the number of emails sent for this sender in the last 7 days
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this sender in the last 7 days
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this sender in the last 7 days
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this sender in the last 7 days
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this sender in the last 7 days
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this sender in the last 7 days
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this sender in the last 7 days
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender in the last 7 days
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this sender in the last 7 days
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 7 days
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * - last_30_days struct stats for this sender in the last 30 days
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * - sent integer the number of emails sent for this sender in the last 30 days
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this sender in the last 30 days
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this sender in the last 30 days
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this sender in the last 30 days
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this sender in the last 30 days
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this sender in the last 30 days
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this sender in the last 30 days
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender in the last 30 days
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this sender in the last 30 days
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 30 days
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> * - last_60_days struct stats for this sender in the last 60 days
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * - sent integer the number of emails sent for this sender in the last 60 days
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this sender in the last 60 days
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this sender in the last 60 days
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this sender in the last 60 days
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this sender in the last 60 days
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this sender in the last 60 days
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this sender in the last 60 days
</span></span><span id="175" class="l"><a class="l" href="#175">175: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender in the last 60 days
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this sender in the last 60 days
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 60 days
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment"> * - last_90_days struct stats for this sender in the last 90 days
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * - sent integer the number of emails sent for this sender in the last 90 days
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this sender in the last 90 days
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this sender in the last 90 days
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this sender in the last 90 days
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this sender in the last 90 days
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes for this sender in the last 90 days
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this sender in the last 90 days
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this sender in the last 90 days
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this sender in the last 90 days
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this sender in the last 90 days
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment"> */</span>
</span><span id="190" class="l"><a class="l" href="#190">190: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$address</span>) {
</span><span id="191" class="l"><a class="l" href="#191">191: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;address&quot;</span> =&gt; <span class="php-var">$address</span>);
</span><span id="192" class="l"><a class="l" href="#192">192: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/info'</span>, <span class="php-var">$_params</span>);
</span><span id="193" class="l"><a class="l" href="#193">193: </a> }
</span><span id="194" class="l"><a class="l" href="#194">194: </a>
</span><span id="195" class="l"><a class="l" href="#195">195: </a> <span class="php-comment">/**
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * Return the recent history (hourly stats for the last 30 days) for a sender
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> * @param string $address the email address of the sender
</span></span><span id="198" class="l"><a class="l" href="#198">198: </a><span class="php-comment"> * @return array the array of history information
</span></span><span id="199" class="l"><a class="l" href="#199">199: </a><span class="php-comment"> * - return[] struct the stats for a single hour
</span></span><span id="200" class="l"><a class="l" href="#200">200: </a><span class="php-comment"> * - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="201" class="l"><a class="l" href="#201">201: </a><span class="php-comment"> * - sent integer the number of emails that were sent during the hour
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment"> * - hard_bounces integer the number of emails that hard bounced during the hour
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment"> * - soft_bounces integer the number of emails that soft bounced during the hour
</span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment"> * - rejects integer the number of emails that were rejected during the hour
</span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment"> * - complaints integer the number of spam complaints received during the hour
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment"> * - opens integer the number of emails opened during the hour
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> * - unique_opens integer the number of unique opens generated by messages sent during the hour
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment"> * - clicks integer the number of tracked URLs clicked during the hour
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks generated by messages sent during the hour
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment"> */</span>
</span><span id="211" class="l"><a class="l" href="#211">211: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_timeSeries" href="#_timeSeries">timeSeries</a>(<span class="php-var">$address</span>) {
</span><span id="212" class="l"><a class="l" href="#212">212: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;address&quot;</span> =&gt; <span class="php-var">$address</span>);
</span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'senders/time-series'</span>, <span class="php-var">$_params</span>);
</span><span id="214" class="l"><a class="l" href="#214">214: </a> }
</span><span id="215" class="l"><a class="l" href="#215">215: </a>
</span><span id="216" class="l"><a class="l" href="#216">216: </a>}
</span><span id="217" class="l"><a class="l" href="#217">217: </a>
</span><span id="218" class="l"><a class="l" href="#218">218: </a>
</span><span id="219" class="l"><a class="l" href="#219">219: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li class="active"><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_ServiceUnavailable.html" title="Summary of Mandrill_ServiceUnavailable"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,309 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Subaccounts.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li class="active"><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Subaccounts.html" title="Summary of Mandrill_Subaccounts"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Subaccounts" href="#Mandrill_Subaccounts">Mandrill_Subaccounts</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Get the list of subaccounts defined for the account, optionally filtered by a prefix
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @param string $q an optional prefix to filter the subaccounts' ids and names
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * @return array the subaccounts for the account, up to a maximum of 1,000
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - return[] struct the individual subaccount info
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>(<span class="php-var">$q</span>=<span class="php-keyword1">null</span>) {
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;q&quot;</span> =&gt; <span class="php-var">$q</span>);
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'subaccounts/list'</span>, <span class="php-var">$_params</span>);
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a> }
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-comment">/**
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * Add a new subaccount
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * @param string $id a unique identifier for the subaccount to be used in sending calls
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * @param string $name an optional display name to further identify the subaccount
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * @param string $notes optional extra text to associate with the subaccount
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * @param integer $custom_quota an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * @return struct the information saved about the new subaccount
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * - created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
</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="_add" href="#_add">add</a>(<span class="php-var">$id</span>, <span class="php-var">$name</span>=<span class="php-keyword1">null</span>, <span class="php-var">$notes</span>=<span class="php-keyword1">null</span>, <span class="php-var">$custom_quota</span>=<span class="php-keyword1">null</span>) {
</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;id&quot;</span> =&gt; <span class="php-var">$id</span>, <span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>, <span class="php-quote">&quot;notes&quot;</span> =&gt; <span class="php-var">$notes</span>, <span class="php-quote">&quot;custom_quota&quot;</span> =&gt; <span class="php-var">$custom_quota</span>);
</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">'subaccounts/add'</span>, <span class="php-var">$_params</span>);
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> }
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a>
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-comment">/**
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * Given the ID of an existing subaccount, return the data about it
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * @param string $id the unique identifier of the subaccount to query
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * @return struct the information about the subaccount
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * - notes string optional extra text to associate with the subaccount
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * - sent_hourly integer the number of emails the subaccount has sent in the last hour
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * - hourly_quota integer the current hourly quota for the subaccount, either manual or reputation-based
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * - last_30_days struct stats for this subaccount in the last 30 days
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * - sent integer the number of emails sent for this subaccount in the last 30 days
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced for this subaccount in the last 30 days
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced for this subaccount in the last 30 days
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this subaccount in the last 30 days
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * - complaints integer the number of spam complaints for this subaccount in the last 30 days
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * - unsubs integer the number of unsbuscribes for this subaccount in the last 30 days
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * - opens integer the number of times emails have been opened for this subaccount in the last 30 days
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent for this subaccount in the last 30 days
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked for this subaccount in the last 30 days
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent for this subaccount in the last 30 days
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> */</span>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$id</span>) {
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'subaccounts/info'</span>, <span class="php-var">$_params</span>);
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> }
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> <span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * Update an existing subaccount
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * @param string $id the unique identifier of the subaccount to update
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * @param string $name an optional display name to further identify the subaccount
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * @param string $notes optional extra text to associate with the subaccount
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @param integer $custom_quota an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @return struct the information for the updated subaccount
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_update" href="#_update">update</a>(<span class="php-var">$id</span>, <span class="php-var">$name</span>=<span class="php-keyword1">null</span>, <span class="php-var">$notes</span>=<span class="php-keyword1">null</span>, <span class="php-var">$custom_quota</span>=<span class="php-keyword1">null</span>) {
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>, <span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>, <span class="php-quote">&quot;notes&quot;</span> =&gt; <span class="php-var">$notes</span>, <span class="php-quote">&quot;custom_quota&quot;</span> =&gt; <span class="php-var">$custom_quota</span>);
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'subaccounts/update'</span>, <span class="php-var">$_params</span>);
</span><span id="107" class="l"><a class="l" href="#107">107: </a> }
</span><span id="108" class="l"><a class="l" href="#108">108: </a>
</span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-comment">/**
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * @param string $id the unique identifier of the subaccount to delete
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * @return struct the information for the deleted subaccount
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * - created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$id</span>) {
</span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'subaccounts/delete'</span>, <span class="php-var">$_params</span>);
</span><span id="127" class="l"><a class="l" href="#127">127: </a> }
</span><span id="128" class="l"><a class="l" href="#128">128: </a>
</span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-comment">/**
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * @param string $id the unique identifier of the subaccount to pause
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * @return struct the information for the paused subaccount
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * - created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</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> <a id="_pause" href="#_pause">pause</a>(<span class="php-var">$id</span>) {
</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;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</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">'subaccounts/pause'</span>, <span class="php-var">$_params</span>);
</span><span id="147" class="l"><a class="l" href="#147">147: </a> }
</span><span id="148" class="l"><a class="l" href="#148">148: </a>
</span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-comment">/**
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * Resume a paused subaccount's sending
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * @param string $id the unique identifier of the subaccount to resume
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * @return struct the information for the resumed subaccount
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * - id string a unique indentifier for the subaccount
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * - name string an optional display name for the subaccount
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * - custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * - status string the current sending status of the subaccount, one of &quot;active&quot; or &quot;paused&quot;
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * - reputation integer the subaccount's current reputation on a scale from 0 to 100
</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 subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> * - first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> * - sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * - sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * - sent_total integer the number of emails the subaccount has sent since it was created
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> */</span>
</span><span id="164" class="l"><a class="l" href="#164">164: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_resume" href="#_resume">resume</a>(<span class="php-var">$id</span>) {
</span><span id="165" class="l"><a class="l" href="#165">165: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;id&quot;</span> =&gt; <span class="php-var">$id</span>);
</span><span id="166" class="l"><a class="l" href="#166">166: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'subaccounts/resume'</span>, <span class="php-var">$_params</span>);
</span><span id="167" class="l"><a class="l" href="#167">167: </a> }
</span><span id="168" class="l"><a class="l" href="#168">168: </a>
</span><span id="169" class="l"><a class="l" href="#169">169: </a>}
</span><span id="170" class="l"><a class="l" href="#170">170: </a>
</span><span id="171" class="l"><a class="l" href="#171">171: </a>
</span><span id="172" class="l"><a class="l" href="#172">172: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,312 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Tags.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li class="active"><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Tags.html" title="Summary of Mandrill_Tags"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Tags" href="#Mandrill_Tags">Mandrill_Tags</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Return all of the user-defined tag information
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @return array a list of user-defined tags
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * - return[] struct a user-defined tag
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - tag string the actual tag as a string
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * - reputation integer the tag's current reputation on a scale from 0 to 100.
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - sent integer the total number of messages sent with this tag
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages with this tag
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages with this tag
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * - rejects integer the total number of rejected messages with this tag
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages with this tag
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages with this tag
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - opens integer the total number of times messages with this tag have been opened
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages with this tag have been clicked
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> */</span>
</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>() {
</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>();
</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">'tags/list'</span>, <span class="php-var">$_params</span>);
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> }
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a>
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-comment">/**
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * Deletes a tag permanently. Deleting a tag removes the tag from any messages
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment">that have been sent, and also deletes the tag's stats. There is no way to
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment">undo this operation, so use it carefully.
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * @param string $tag a tag name
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * @return struct the tag that was deleted
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - tag string the actual tag as a string
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - reputation integer the tag's current reputation on a scale from 0 to 100.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * - sent integer the total number of messages sent with this tag
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages with this tag
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages with this tag
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * - rejects integer the total number of rejected messages with this tag
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages with this tag
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages with this tag
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * - opens integer the total number of times messages with this tag have been opened
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages with this tag have been clicked
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$tag</span>) {
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;tag&quot;</span> =&gt; <span class="php-var">$tag</span>);
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'tags/delete'</span>, <span class="php-var">$_params</span>);
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> }
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-comment">/**
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * Return more detailed information about a single tag, including aggregates of recent stats
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * @param string $tag an existing tag name
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * @return struct the detailed information on the tag
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * - tag string the actual tag as a string
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - sent integer the total number of messages sent with this tag
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - hard_bounces integer the total number of hard bounces by messages with this tag
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - soft_bounces integer the total number of soft bounces by messages with this tag
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - rejects integer the total number of rejected messages with this tag
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - complaints integer the total number of spam complaints received for messages with this tag
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - unsubs integer the total number of unsubscribe requests received for messages with this tag
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - opens integer the total number of times messages with this tag have been opened
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> * - clicks integer the total number of times tracked URLs in messages with this tag have been clicked
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * - stats struct an aggregate summary of the tag's sending stats
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * - today struct stats with this tag so far today
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * - sent integer the number of emails sent with this tag so far today
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced with this tag so far today
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced with this tag so far today
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this tag so far today
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * - complaints integer the number of spam complaints with this tag so far today
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes with this tag so far today
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * - opens integer the number of times emails have been opened with this tag so far today
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag so far today
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked with this tag so far today
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag so far today
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * - last_7_days struct stats with this tag in the last 7 days
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * - sent integer the number of emails sent with this tag in the last 7 days
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced with this tag in the last 7 days
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced with this tag in the last 7 days
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this tag in the last 7 days
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * - complaints integer the number of spam complaints with this tag in the last 7 days
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes with this tag in the last 7 days
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * - opens integer the number of times emails have been opened with this tag in the last 7 days
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag in the last 7 days
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked with this tag in the last 7 days
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag in the last 7 days
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * - last_30_days struct stats with this tag in the last 30 days
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * - sent integer the number of emails sent with this tag in the last 30 days
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced with this tag in the last 30 days
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced with this tag in the last 30 days
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this tag in the last 30 days
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - complaints integer the number of spam complaints with this tag in the last 30 days
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes with this tag in the last 30 days
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * - opens integer the number of times emails have been opened with this tag in the last 30 days
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag in the last 30 days
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked with this tag in the last 30 days
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag in the last 30 days
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * - last_60_days struct stats with this tag in the last 60 days
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * - sent integer the number of emails sent with this tag in the last 60 days
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced with this tag in the last 60 days
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced with this tag in the last 60 days
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this tag in the last 60 days
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment"> * - complaints integer the number of spam complaints with this tag in the last 60 days
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes with this tag in the last 60 days
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> * - opens integer the number of times emails have been opened with this tag in the last 60 days
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag in the last 60 days
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked with this tag in the last 60 days
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag in the last 60 days
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * - last_90_days struct stats with this tag in the last 90 days
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * - sent integer the number of emails sent with this tag in the last 90 days
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * - hard_bounces integer the number of emails hard bounced with this tag in the last 90 days
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * - soft_bounces integer the number of emails soft bounced with this tag in the last 90 days
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * - rejects integer the number of emails rejected for sending this tag in the last 90 days
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * - complaints integer the number of spam complaints with this tag in the last 90 days
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes with this tag in the last 90 days
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * - opens integer the number of times emails have been opened with this tag in the last 90 days
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * - unique_opens integer the number of unique opens for emails sent with this tag in the last 90 days
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * - clicks integer the number of URLs that have been clicked with this tag in the last 90 days
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks for emails sent with this tag in the last 90 days
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$tag</span>) {
</span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;tag&quot;</span> =&gt; <span class="php-var">$tag</span>);
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'tags/info'</span>, <span class="php-var">$_params</span>);
</span><span id="127" class="l"><a class="l" href="#127">127: </a> }
</span><span id="128" class="l"><a class="l" href="#128">128: </a>
</span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-comment">/**
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> * Return the recent history (hourly stats for the last 30 days) for a tag
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment"> * @param string $tag an existing tag name
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * @return array the array of history information
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> * - return[] struct the stats for a single hour
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment"> * - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * - sent integer the number of emails that were sent during the hour
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * - hard_bounces integer the number of emails that hard bounced during the hour
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * - soft_bounces integer the number of emails that soft bounced during the hour
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * - rejects integer the number of emails that were rejected during the hour
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * - complaints integer the number of spam complaints received during the hour
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes received during the hour
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * - opens integer the number of emails opened during the hour
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * - unique_opens integer the number of unique opens generated by messages sent during the hour
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * - clicks integer the number of tracked URLs clicked during the hour
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks generated by messages sent during the hour
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> */</span>
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_timeSeries" href="#_timeSeries">timeSeries</a>(<span class="php-var">$tag</span>) {
</span><span id="147" class="l"><a class="l" href="#147">147: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;tag&quot;</span> =&gt; <span class="php-var">$tag</span>);
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'tags/time-series'</span>, <span class="php-var">$_params</span>);
</span><span id="149" class="l"><a class="l" href="#149">149: </a> }
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a> <span class="php-comment">/**
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * Return the recent history (hourly stats for the last 30 days) for all tags
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * @return array the array of history information
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * - return[] struct the stats for a single hour
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * - sent integer the number of emails that were sent during the hour
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * - hard_bounces integer the number of emails that hard bounced during the hour
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * - soft_bounces integer the number of emails that soft bounced during the hour
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> * - rejects integer the number of emails that were rejected during the hour
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> * - complaints integer the number of spam complaints received during the hour
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * - unsubs integer the number of unsubscribes received during the hour
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * - opens integer the number of emails opened during the hour
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> * - unique_opens integer the number of unique opens generated by messages sent during the hour
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> * - clicks integer the number of tracked URLs clicked during the hour
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks generated by messages sent during the hour
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> */</span>
</span><span id="167" class="l"><a class="l" href="#167">167: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_allTimeSeries" href="#_allTimeSeries">allTimeSeries</a>() {
</span><span id="168" class="l"><a class="l" href="#168">168: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="169" class="l"><a class="l" href="#169">169: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'tags/all-time-series'</span>, <span class="php-var">$_params</span>);
</span><span id="170" class="l"><a class="l" href="#170">170: </a> }
</span><span id="171" class="l"><a class="l" href="#171">171: </a>
</span><span id="172" class="l"><a class="l" href="#172">172: </a>}
</span><span id="173" class="l"><a class="l" href="#173">173: </a>
</span><span id="174" class="l"><a class="l" href="#174">174: </a>
</span><span id="175" class="l"><a class="l" href="#175">175: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,373 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Templates.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li class="active"><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Templates.html" title="Summary of Mandrill_Templates"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Templates" href="#Mandrill_Templates">Mandrill_Templates</a> {
</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>) {
</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>;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a> }
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a> <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Add a new template
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @param string $name the name for the new template - must be unique
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * @param string $from_email a default sending address for emails sent using this template
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * @param string $from_name a default from name to be used
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * @param string $subject a default subject line to be used
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @param string $code the HTML code for the template with mc:edit attributes for the editable elements
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @param string $text a default text part to be used when sending with this template
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @param boolean $publish set to false to add a draft template without publishing
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * @param array $labels an optional array of up to 10 labels to use for filtering templates
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * @return struct the information saved about the new template
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * - slug string the immutable unique code name of the template
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment"> * - name string the name of the template
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * - labels array the list of labels applied to the template
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * - code string the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * - subject string the subject line of the template, if provided - draft version
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * - from_email string the default sender address for the template, if provided - draft version
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * - from_name string the default sender from name for the template, if provided - draft version
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * - text string the default text part of messages sent with the template, if provided - draft version
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * - publish_name string the same as the template name - kept as a separate field for backwards compatibility
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * - publish_code string the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * - publish_subject string the subject line of the template, if provided
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * - publish_from_email string the default sender address for the template, if provided
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * - publish_from_name string the default sender from name for the template, if provided
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * - publish_text string the default text part of messages sent with the template, if provided
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * - published_at string the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * - created_at string the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * - updated_at string the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add" href="#_add">add</a>(<span class="php-var">$name</span>, <span class="php-var">$from_email</span>=<span class="php-keyword1">null</span>, <span class="php-var">$from_name</span>=<span class="php-keyword1">null</span>, <span class="php-var">$subject</span>=<span class="php-keyword1">null</span>, <span class="php-var">$code</span>=<span class="php-keyword1">null</span>, <span class="php-var">$text</span>=<span class="php-keyword1">null</span>, <span class="php-var">$publish</span>=<span class="php-keyword1">true</span>, <span class="php-var">$labels</span>=<span class="php-keyword1">array</span>()) {
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>, <span class="php-quote">&quot;from_email&quot;</span> =&gt; <span class="php-var">$from_email</span>, <span class="php-quote">&quot;from_name&quot;</span> =&gt; <span class="php-var">$from_name</span>, <span class="php-quote">&quot;subject&quot;</span> =&gt; <span class="php-var">$subject</span>, <span class="php-quote">&quot;code&quot;</span> =&gt; <span class="php-var">$code</span>, <span class="php-quote">&quot;text&quot;</span> =&gt; <span class="php-var">$text</span>, <span class="php-quote">&quot;publish&quot;</span> =&gt; <span class="php-var">$publish</span>, <span class="php-quote">&quot;labels&quot;</span> =&gt; <span class="php-var">$labels</span>);
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/add'</span>, <span class="php-var">$_params</span>);
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a> }
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-comment">/**
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * Get the information for an existing template
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * @param string $name the immutable name of an existing template
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * @return struct the requested template information
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> * - slug string the immutable unique code name of the template
</span></span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-comment"> * - name string the name of the template
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * - labels array the list of labels applied to the template
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * - code string the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> * - subject string the subject line of the template, if provided - draft version
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * - from_email string the default sender address for the template, if provided - draft version
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * - from_name string the default sender from name for the template, if provided - draft version
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * - text string the default text part of messages sent with the template, if provided - draft version
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * - publish_name string the same as the template name - kept as a separate field for backwards compatibility
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> * - publish_code string the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - publish_subject string the subject line of the template, if provided
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - publish_from_email string the default sender address for the template, if provided
</span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - publish_from_name string the default sender from name for the template, if provided
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - publish_text string the default text part of messages sent with the template, if provided
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - published_at string the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * - created_at string the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * - updated_at string the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> */</span>
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$name</span>) {
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>);
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/info'</span>, <span class="php-var">$_params</span>);
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a> }
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a>
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> <span class="php-comment">/**
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * @param string $name the immutable name of an existing template
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @param string $from_email the new default sending address
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * @param string $from_name the new default from name
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * @param string $subject the new default subject line
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * @param string $code the new code for the template
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * @param string $text the new default text part to be used
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * @param boolean $publish set to false to update the draft version of the template without publishing
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * @param array $labels an optional array of up to 10 labels to use for filtering templates
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> * @return struct the template that was updated
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment"> * - slug string the immutable unique code name of the template
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment"> * - name string the name of the template
</span></span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment"> * - labels array the list of labels applied to the template
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * - code string the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * - subject string the subject line of the template, if provided - draft version
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * - from_email string the default sender address for the template, if provided - draft version
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * - from_name string the default sender from name for the template, if provided - draft version
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - text string the default text part of messages sent with the template, if provided - draft version
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * - publish_name string the same as the template name - kept as a separate field for backwards compatibility
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * - publish_code string the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - publish_subject string the subject line of the template, if provided
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - publish_from_email string the default sender address for the template, if provided
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * - publish_from_name string the default sender from name for the template, if provided
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - publish_text string the default text part of messages sent with the template, if provided
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - published_at string the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * - created_at string the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * - updated_at string the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> */</span>
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_update" href="#_update">update</a>(<span class="php-var">$name</span>, <span class="php-var">$from_email</span>=<span class="php-keyword1">null</span>, <span class="php-var">$from_name</span>=<span class="php-keyword1">null</span>, <span class="php-var">$subject</span>=<span class="php-keyword1">null</span>, <span class="php-var">$code</span>=<span class="php-keyword1">null</span>, <span class="php-var">$text</span>=<span class="php-keyword1">null</span>, <span class="php-var">$publish</span>=<span class="php-keyword1">true</span>, <span class="php-var">$labels</span>=<span class="php-keyword1">null</span>) {
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>, <span class="php-quote">&quot;from_email&quot;</span> =&gt; <span class="php-var">$from_email</span>, <span class="php-quote">&quot;from_name&quot;</span> =&gt; <span class="php-var">$from_name</span>, <span class="php-quote">&quot;subject&quot;</span> =&gt; <span class="php-var">$subject</span>, <span class="php-quote">&quot;code&quot;</span> =&gt; <span class="php-var">$code</span>, <span class="php-quote">&quot;text&quot;</span> =&gt; <span class="php-var">$text</span>, <span class="php-quote">&quot;publish&quot;</span> =&gt; <span class="php-var">$publish</span>, <span class="php-quote">&quot;labels&quot;</span> =&gt; <span class="php-var">$labels</span>);
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/update'</span>, <span class="php-var">$_params</span>);
</span><span id="106" class="l"><a class="l" href="#106">106: </a> }
</span><span id="107" class="l"><a class="l" href="#107">107: </a>
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-comment">/**
</span></span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-comment"> * Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * @param string $name the immutable name of an existing template
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * @return struct the template that was published
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * - slug string the immutable unique code name of the template
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * - name string the name of the template
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * - labels array the list of labels applied to the template
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * - code string the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * - subject string the subject line of the template, if provided - draft version
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> * - from_email string the default sender address for the template, if provided - draft version
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * - from_name string the default sender from name for the template, if provided - draft version
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * - text string the default text part of messages sent with the template, if provided - draft version
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * - publish_name string the same as the template name - kept as a separate field for backwards compatibility
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * - publish_code string the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * - publish_subject string the subject line of the template, if provided
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * - publish_from_email string the default sender address for the template, if provided
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * - publish_from_name string the default sender from name for the template, if provided
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> * - publish_text string the default text part of messages sent with the template, if provided
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * - published_at string the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> * - created_at string the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment"> * - updated_at string the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment"> */</span>
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_publish" href="#_publish">publish</a>(<span class="php-var">$name</span>) {
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>);
</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/publish'</span>, <span class="php-var">$_params</span>);
</span><span id="134" class="l"><a class="l" href="#134">134: </a> }
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * Delete a template
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * @param string $name the immutable name of an existing template
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * @return struct the template that was deleted
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * - slug string the immutable unique code name of the template
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * - name string the name of the template
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * - labels array the list of labels applied to the template
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-comment"> * - code string the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment"> * - subject string the subject line of the template, if provided - draft version
</span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment"> * - from_email string the default sender address for the template, if provided - draft version
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * - from_name string the default sender from name for the template, if provided - draft version
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> * - text string the default text part of messages sent with the template, if provided - draft version
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment"> * - publish_name string the same as the template name - kept as a separate field for backwards compatibility
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment"> * - publish_code string the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * - publish_subject string the subject line of the template, if provided
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * - publish_from_email string the default sender address for the template, if provided
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> * - publish_from_name string the default sender from name for the template, if provided
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * - publish_text string the default text part of messages sent with the template, if provided
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> * - published_at string the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment"> * - created_at string the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment"> * - updated_at string the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> */</span>
</span><span id="159" class="l"><a class="l" href="#159">159: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$name</span>) {
</span><span id="160" class="l"><a class="l" href="#160">160: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>);
</span><span id="161" class="l"><a class="l" href="#161">161: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/delete'</span>, <span class="php-var">$_params</span>);
</span><span id="162" class="l"><a class="l" href="#162">162: </a> }
</span><span id="163" class="l"><a class="l" href="#163">163: </a>
</span><span id="164" class="l"><a class="l" href="#164">164: </a> <span class="php-comment">/**
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment"> * Return a list of all the templates available to this user
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment"> * @param string $label an optional label to filter the templates
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment"> * @return array an array of structs with information about each template
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * - return[] struct the information on each template in the account
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * - slug string the immutable unique code name of the template
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> * - name string the name of the template
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> * - labels array the list of labels applied to the template
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> * - labels[] string a single label
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> * - code string the full HTML code of the template, with mc:edit attributes marking the editable elements - draft version
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> * - subject string the subject line of the template, if provided - draft version
</span></span><span id="175" class="l"><a class="l" href="#175">175: </a><span class="php-comment"> * - from_email string the default sender address for the template, if provided - draft version
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment"> * - from_name string the default sender from name for the template, if provided - draft version
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> * - text string the default text part of messages sent with the template, if provided - draft version
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment"> * - publish_name string the same as the template name - kept as a separate field for backwards compatibility
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * - publish_code string the full HTML code of the template, with mc:edit attributes marking the editable elements that are available as published, if it has been published
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> * - publish_subject string the subject line of the template, if provided
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment"> * - publish_from_email string the default sender address for the template, if provided
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> * - publish_from_name string the default sender from name for the template, if provided
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment"> * - publish_text string the default text part of messages sent with the template, if provided
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment"> * - published_at string the date and time the template was last published as a UTC string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment"> * - created_at string the date and time the template was first created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment"> * - updated_at string the date and time the template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment"> */</span>
</span><span id="188" class="l"><a class="l" href="#188">188: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>(<span class="php-var">$label</span>=<span class="php-keyword1">null</span>) {
</span><span id="189" class="l"><a class="l" href="#189">189: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;label&quot;</span> =&gt; <span class="php-var">$label</span>);
</span><span id="190" class="l"><a class="l" href="#190">190: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/list'</span>, <span class="php-var">$_params</span>);
</span><span id="191" class="l"><a class="l" href="#191">191: </a> }
</span><span id="192" class="l"><a class="l" href="#192">192: </a>
</span><span id="193" class="l"><a class="l" href="#193">193: </a> <span class="php-comment">/**
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * Return the recent history (hourly stats for the last 30 days) for a template
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> * @param string $name the name of an existing template
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * @return array the array of history information
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> * - return[] struct the stats for a single hour
</span></span><span id="198" class="l"><a class="l" href="#198">198: </a><span class="php-comment"> * - time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="199" class="l"><a class="l" href="#199">199: </a><span class="php-comment"> * - sent integer the number of emails that were sent during the hour
</span></span><span id="200" class="l"><a class="l" href="#200">200: </a><span class="php-comment"> * - hard_bounces integer the number of emails that hard bounced during the hour
</span></span><span id="201" class="l"><a class="l" href="#201">201: </a><span class="php-comment"> * - soft_bounces integer the number of emails that soft bounced during the hour
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment"> * - rejects integer the number of emails that were rejected during the hour
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment"> * - complaints integer the number of spam complaints received during the hour
</span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment"> * - opens integer the number of emails opened during the hour
</span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment"> * - unique_opens integer the number of unique opens generated by messages sent during the hour
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment"> * - clicks integer the number of tracked URLs clicked during the hour
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks generated by messages sent during the hour
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment"> */</span>
</span><span id="209" class="l"><a class="l" href="#209">209: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_timeSeries" href="#_timeSeries">timeSeries</a>(<span class="php-var">$name</span>) {
</span><span id="210" class="l"><a class="l" href="#210">210: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;name&quot;</span> =&gt; <span class="php-var">$name</span>);
</span><span id="211" class="l"><a class="l" href="#211">211: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/time-series'</span>, <span class="php-var">$_params</span>);
</span><span id="212" class="l"><a class="l" href="#212">212: </a> }
</span><span id="213" class="l"><a class="l" href="#213">213: </a>
</span><span id="214" class="l"><a class="l" href="#214">214: </a> <span class="php-comment">/**
</span></span><span id="215" class="l"><a class="l" href="#215">215: </a><span class="php-comment"> * Inject content and optionally merge fields into a template, returning the HTML that results
</span></span><span id="216" class="l"><a class="l" href="#216">216: </a><span class="php-comment"> * @param string $template_name the immutable name of a template that exists in the user's account
</span></span><span id="217" class="l"><a class="l" href="#217">217: </a><span class="php-comment"> * @param array $template_content an array of template content to render. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block
</span></span><span id="218" class="l"><a class="l" href="#218">218: </a><span class="php-comment"> * - template_content[] struct the injection of a single piece of content into a single editable region
</span></span><span id="219" class="l"><a class="l" href="#219">219: </a><span class="php-comment"> * - name string the name of the mc:edit editable region to inject into
</span></span><span id="220" class="l"><a class="l" href="#220">220: </a><span class="php-comment"> * - content string the content to inject
</span></span><span id="221" class="l"><a class="l" href="#221">221: </a><span class="php-comment"> * @param array $merge_vars optional merge variables to use for injecting merge field content. If this is not provided, no merge fields will be replaced.
</span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment"> * - merge_vars[] struct a single merge variable
</span></span><span id="223" class="l"><a class="l" href="#223">223: </a><span class="php-comment"> * - name string the merge variable's name. Merge variable names are case-insensitive and may not start with _
</span></span><span id="224" class="l"><a class="l" href="#224">224: </a><span class="php-comment"> * - content string the merge variable's content
</span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment"> * @return struct the result of rendering the given template with the content and merge field values injected
</span></span><span id="226" class="l"><a class="l" href="#226">226: </a><span class="php-comment"> * - html string the rendered HTML as a string
</span></span><span id="227" class="l"><a class="l" href="#227">227: </a><span class="php-comment"> */</span>
</span><span id="228" class="l"><a class="l" href="#228">228: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_render" href="#_render">render</a>(<span class="php-var">$template_name</span>, <span class="php-var">$template_content</span>, <span class="php-var">$merge_vars</span>=<span class="php-keyword1">null</span>) {
</span><span id="229" class="l"><a class="l" href="#229">229: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;template_name&quot;</span> =&gt; <span class="php-var">$template_name</span>, <span class="php-quote">&quot;template_content&quot;</span> =&gt; <span class="php-var">$template_content</span>, <span class="php-quote">&quot;merge_vars&quot;</span> =&gt; <span class="php-var">$merge_vars</span>);
</span><span id="230" class="l"><a class="l" href="#230">230: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'templates/render'</span>, <span class="php-var">$_params</span>);
</span><span id="231" class="l"><a class="l" href="#231">231: </a> }
</span><span id="232" class="l"><a class="l" href="#232">232: </a>
</span><span id="233" class="l"><a class="l" href="#233">233: </a>}
</span><span id="234" class="l"><a class="l" href="#234">234: </a>
</span><span id="235" class="l"><a class="l" href="#235">235: </a>
</span><span id="236" class="l"><a class="l" href="#236">236: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li class="active"><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Unknown_Export.html" title="Summary of Mandrill_Unknown_Export"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li class="active"><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Unknown_IP.html" title="Summary of Mandrill_Unknown_IP"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li class="active"><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Unknown_InboundDomain.html" title="Summary of Mandrill_Unknown_InboundDomain"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,289 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Mandrill/Exceptions.php</title>
<script type="text/javascript" src="resources/combined.js?394153670"></script>
<script type="text/javascript" src="elementlist.js?882160656"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-None.html">None</a>
</li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Mandrill.html">Mandrill</a></li>
<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
<li class="active"><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li>
<a href="class-Mandrill_Unknown_InboundRoute.html" title="Summary of Mandrill_Unknown_InboundRoute"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Error" href="#Mandrill_Error">Mandrill_Error</a> <span class="php-keyword1">extends</span> Exception {}
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">class</span> <a id="Mandrill_HttpError" href="#Mandrill_HttpError">Mandrill_HttpError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">/**
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * The parameters passed to the API call are invalid or not provided when required
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> */</span>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-keyword1">class</span> <a id="Mandrill_ValidationError" href="#Mandrill_ValidationError">Mandrill_ValidationError</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a>
</span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">/**
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * The provided API key is not a valid Mandrill API key
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Key" href="#Mandrill_Invalid_Key">Mandrill_Invalid_Key</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="15" class="l"><a class="l" href="#15"> 15: </a>
</span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">/**
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * The requested feature requires payment.
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">class</span> <a id="Mandrill_PaymentRequired" href="#Mandrill_PaymentRequired">Mandrill_PaymentRequired</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The provided subaccount id does not exist.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> */</span>
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Subaccount" href="#Mandrill_Unknown_Subaccount">Mandrill_Unknown_Subaccount</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The requested template does not exist
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Template" href="#Mandrill_Unknown_Template">Mandrill_Unknown_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> * The subsystem providing this API call is down for maintenance
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> */</span>
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-keyword1">class</span> <a id="Mandrill_ServiceUnavailable" href="#Mandrill_ServiceUnavailable">Mandrill_ServiceUnavailable</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">/**
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * The provided message id does not exist.
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> */</span>
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Message" href="#Mandrill_Unknown_Message">Mandrill_Unknown_Message</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * The requested tag does not exist or contains invalid characters
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> */</span>
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Tag_Name" href="#Mandrill_Invalid_Tag_Name">Mandrill_Invalid_Tag_Name</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">/**
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> * The requested email is not in the rejection list
</span></span><span id="48" class="l"><a class="l" href="#48"> 48: </a><span class="php-comment"> */</span>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Reject" href="#Mandrill_Invalid_Reject">Mandrill_Invalid_Reject</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">/**
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * The requested sender does not exist
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Sender" href="#Mandrill_Unknown_Sender">Mandrill_Unknown_Sender</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * The requested URL has not been seen in a tracked link
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Url" href="#Mandrill_Unknown_Url">Mandrill_Unknown_Url</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment">/**
</span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * The provided tracking domain does not exist.
</span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> */</span>
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_TrackingDomain" href="#Mandrill_Unknown_TrackingDomain">Mandrill_Unknown_TrackingDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * The given template name already exists or contains invalid characters
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> */</span>
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_Template" href="#Mandrill_Invalid_Template">Mandrill_Invalid_Template</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * The requested webhook does not exist
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Webhook" href="#Mandrill_Unknown_Webhook">Mandrill_Unknown_Webhook</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * The requested inbound domain does not exist
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> */</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundDomain" href="#Mandrill_Unknown_InboundDomain">Mandrill_Unknown_InboundDomain</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a>
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment"> * The provided inbound route does not exist.
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment"> */</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_InboundRoute" href="#Mandrill_Unknown_InboundRoute">Mandrill_Unknown_InboundRoute</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a><span class="php-comment">/**
</span></span><span id="87" class="l"><a class="l" href="#87"> 87: </a><span class="php-comment"> * The requested export job does not exist
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> */</span>
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Export" href="#Mandrill_Unknown_Export">Mandrill_Unknown_Export</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * A dedicated IP cannot be provisioned while another request is pending.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-keyword1">class</span> <a id="Mandrill_IP_ProvisionLimit" href="#Mandrill_IP_ProvisionLimit">Mandrill_IP_ProvisionLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a>
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">/**
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * The provided dedicated IP pool does not exist.
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> */</span>
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_Pool" href="#Mandrill_Unknown_Pool">Mandrill_Unknown_Pool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">/**
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * The user hasn't started sending yet.
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-keyword1">class</span> <a id="Mandrill_NoSendingHistory" href="#Mandrill_NoSendingHistory">Mandrill_NoSendingHistory</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="105" class="l"><a class="l" href="#105">105: </a>
</span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">/**
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment"> * The user's reputation is too low to continue.
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment"> */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a><span class="php-keyword1">class</span> <a id="Mandrill_PoorReputation" href="#Mandrill_PoorReputation">Mandrill_PoorReputation</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="110" class="l"><a class="l" href="#110">110: </a>
</span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment">/**
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * The provided dedicated IP does not exist.
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> */</span>
</span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_IP" href="#Mandrill_Unknown_IP">Mandrill_Unknown_IP</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="115" class="l"><a class="l" href="#115">115: </a>
</span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * You cannot remove the last IP from your default IP pool.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> */</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_EmptyDefaultPool" href="#Mandrill_Invalid_EmptyDefaultPool">Mandrill_Invalid_EmptyDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">/**
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * The default pool cannot be deleted.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> */</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteDefaultPool" href="#Mandrill_Invalid_DeleteDefaultPool">Mandrill_Invalid_DeleteDefaultPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">/**
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment"> * Non-empty pools cannot be deleted.
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment"> */</span>
</span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_DeleteNonEmptyPool" href="#Mandrill_Invalid_DeleteNonEmptyPool">Mandrill_Invalid_DeleteNonEmptyPool</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">/**
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment"> * The domain name is not configured for use as the dedicated IP's custom reverse DNS.
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment"> */</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNS" href="#Mandrill_Invalid_CustomDNS">Mandrill_Invalid_CustomDNS</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment">/**
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * A custom DNS change for this dedicated IP is currently pending.
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> */</span>
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">class</span> <a id="Mandrill_Invalid_CustomDNSPending" href="#Mandrill_Invalid_CustomDNSPending">Mandrill_Invalid_CustomDNSPending</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">/**
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> * Custom metadata field limit reached.
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment"> */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a><span class="php-keyword1">class</span> <a id="Mandrill_Metadata_FieldLimit" href="#Mandrill_Metadata_FieldLimit">Mandrill_Metadata_FieldLimit</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">/**
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment"> * The provided metadata field name does not exist.
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment"> */</span>
</span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-keyword1">class</span> <a id="Mandrill_Unknown_MetadataField" href="#Mandrill_Unknown_MetadataField">Mandrill_Unknown_MetadataField</a> <span class="php-keyword1">extends</span> Mandrill_Error {}
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More