<!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/Urls.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 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> <a href="class-Mandrill_Urls.html" title="Summary of Mandrill_Urls"><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"><?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_Urls" href="#Mandrill_Urls">Mandrill_Urls</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>->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 100 most clicked URLs </span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @return array the 100 most clicked URLs and their stats </span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * - return[] struct the individual URL stats </span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * - url string the URL to be tracked </span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * - sent integer the number of emails that contained the URL </span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * - clicks integer the number of times the URL has been clicked from a tracked email </span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * - unique_clicks integer the number of unique emails that have generated clicks for this URL </span></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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() { </span><span id="18" class="l"><a class="l" href="#18"> 18: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(); </span><span id="19" class="l"><a class="l" href="#19"> 19: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->master->call(<span class="php-quote">'urls/list'</span>, <span class="php-var">$_params</span>); </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><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-comment"> * Return the 100 most clicked URLs that match the search query given </span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * @param string $q a search query </span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * @return array the 100 most clicked URLs matching the search query </span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * - return[] struct the URL matching the query </span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * - url string the URL to be tracked </span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * - sent integer the number of emails that contained the URL </span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * - clicks integer the number of times the URL has been clicked from a tracked email </span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * - unique_clicks integer the number of unique emails that have generated clicks for this URL </span></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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_search" href="#_search">search</a>(<span class="php-var">$q</span>) { </span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">"q"</span> => <span class="php-var">$q</span>); </span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->master->call(<span class="php-quote">'urls/search'</span>, <span class="php-var">$_params</span>); </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><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-comment">/** </span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * Return the recent history (hourly stats for the last 30 days) for a url </span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @param string $url an existing URL </span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * @return array the array of history information </span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * - return[] struct the information for a single hour </span></span><span id="42" class="l"><a class="l" href="#42"> 42: </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="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * - sent integer the number of emails that were sent with the URL during the hour </span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * - clicks integer the number of times the URL was clicked during the hour </span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * - unique_clicks integer the number of unique clicks generated for emails sent with this URL during the hour </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="_timeSeries" href="#_timeSeries">timeSeries</a>(<span class="php-var">$url</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">"url"</span> => <span class="php-var">$url</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>->master->call(<span class="php-quote">'urls/time-series'</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"> * Get the list of tracking domains set up for this account </span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * @return array the tracking domains and their status </span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * - return[] struct the individual tracking domain </span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * - domain string the tracking domain name </span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * - 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 </span></span><span id="58" class="l"><a class="l" href="#58"> 58: </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="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> * - cname struct details about the domain's CNAME record </span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment"> * - valid boolean whether the domain's CNAME record is valid for use with Mandrill </span></span><span id="61" class="l"><a class="l" href="#61"> 61: </a><span class="php-comment"> * - 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. </span></span><span id="62" class="l"><a class="l" href="#62"> 62: </a><span class="php-comment"> * - error string an error describing the CNAME record, or null if the record is correct </span></span><span id="63" class="l"><a class="l" href="#63"> 63: </a><span class="php-comment"> * - valid_tracking boolean whether this domain can be used as a tracking domain for email. </span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> */</span> </span><span id="65" class="l"><a class="l" href="#65"> 65: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_trackingDomains" href="#_trackingDomains">trackingDomains</a>() { </span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(); </span><span id="67" class="l"><a class="l" href="#67"> 67: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->master->call(<span class="php-quote">'urls/tracking-domains'</span>, <span class="php-var">$_params</span>); </span><span id="68" class="l"><a class="l" href="#68"> 68: </a> } </span><span id="69" class="l"><a class="l" href="#69"> 69: </a> </span><span id="70" class="l"><a class="l" href="#70"> 70: </a> <span class="php-comment">/** </span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * Add a tracking domain to your account </span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * @param string $domain a domain name </span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @return struct information about the domain </span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * - domain string the tracking domain name </span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * - 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 </span></span><span id="76" class="l"><a class="l" href="#76"> 76: </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="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> * - cname struct details about the domain's CNAME record </span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment"> * - valid boolean whether the domain's CNAME record is valid for use with Mandrill </span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment"> * - 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. </span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * - error string an error describing the CNAME record, or null if the record is correct </span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> * - valid_tracking boolean whether this domain can be used as a tracking domain for email. </span></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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_addTrackingDomain" href="#_addTrackingDomain">addTrackingDomain</a>(<span class="php-var">$domain</span>) { </span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">"domain"</span> => <span class="php-var">$domain</span>); </span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->master->call(<span class="php-quote">'urls/add-tracking-domain'</span>, <span class="php-var">$_params</span>); </span><span id="86" class="l"><a class="l" href="#86"> 86: </a> } </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 class="php-comment">/** </span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> * Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call </span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * @param string $domain an existing tracking domain name </span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @return struct information about the tracking domain </span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * - domain string the tracking domain name </span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * - 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 </span></span><span id="94" class="l"><a class="l" href="#94"> 94: </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="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * - cname struct details about the domain's CNAME record </span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * - valid boolean whether the domain's CNAME record is valid for use with Mandrill </span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> * - 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. </span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * - error string an error describing the CNAME record, or null if the record is correct </span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * - valid_tracking boolean whether this domain can be used as a tracking domain for email. </span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> */</span> </span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_checkTrackingDomain" href="#_checkTrackingDomain">checkTrackingDomain</a>(<span class="php-var">$domain</span>) { </span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">"domain"</span> => <span class="php-var">$domain</span>); </span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->master->call(<span class="php-quote">'urls/check-tracking-domain'</span>, <span class="php-var">$_params</span>); </span><span id="104" class="l"><a class="l" href="#104">104: </a> } </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><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></code></pre> <div id="footer"> API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> </div> </div> </div> </body> </html>