summaryrefslogtreecommitdiff
path: root/Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php
diff options
context:
space:
mode:
authoryehudah <yehudah@b8457f37-d9ea-0310-8a92-e5e31aec5664>2019-11-25 08:22:35 +0000
committeryehudah <yehudah@b8457f37-d9ea-0310-8a92-e5e31aec5664>2019-11-25 08:22:35 +0000
commitc61784411988d36d9bbd93cd3a97e773990af342 (patch)
tree924e6e9dea2ba7b1eedb14d0c4b03a38aefdf179 /Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php
parent907ce8c044159ca8da6ccce3ec5362ac61e7c142 (diff)
downloadPost-SMTP-c61784411988d36d9bbd93cd3a97e773990af342.zip
Adding a folder
Diffstat (limited to 'Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php')
-rw-r--r--Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php108
1 files changed, 108 insertions, 0 deletions
diff --git a/Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php b/Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php
new file mode 100644
index 0000000..333eaeb
--- /dev/null
+++ b/Postman/Postman-Mail/mailchimp-mandrill-api-php-da3adc10042e/src/Mandrill/Urls.php
@@ -0,0 +1,108 @@
+<?php
+
+class Postman_Mandrill_Urls {
+ public function __construct(Postman_Mandrill $master) {
+ $this->master = $master;
+ }
+
+ /**
+ * Get the 100 most clicked URLs
+ * @return array 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
+ */
+ public function getList() {
+ $_params = array();
+ return $this->master->call('urls/list', $_params);
+ }
+
+ /**
+ * Return the 100 most clicked URLs that match the search query given
+ * @param string $q a search query
+ * @return array 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
+ */
+ public function search($q) {
+ $_params = array("q" => $q);
+ return $this->master->call('urls/search', $_params);
+ }
+
+ /**
+ * Return the recent history (hourly stats for the last 30 days) for a url
+ * @param string $url an existing URL
+ * @return array 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
+ */
+ public function timeSeries($url) {
+ $_params = array("url" => $url);
+ return $this->master->call('urls/time-series', $_params);
+ }
+
+ /**
+ * Get the list of tracking domains set up for this account
+ * @return array 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.
+ */
+ public function trackingDomains() {
+ $_params = array();
+ return $this->master->call('urls/tracking-domains', $_params);
+ }
+
+ /**
+ * Add a tracking domain to your account
+ * @param string $domain a domain name
+ * @return struct 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.
+ */
+ public function addTrackingDomain($domain) {
+ $_params = array("domain" => $domain);
+ return $this->master->call('urls/add-tracking-domain', $_params);
+ }
+
+ /**
+ * Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
+ * @param string $domain an existing tracking domain name
+ * @return struct 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.
+ */
+ public function checkTrackingDomain($domain) {
+ $_params = array("domain" => $domain);
+ return $this->master->call('urls/check-tracking-domain', $_params);
+ }
+
+}
+
+