Overview

Namespaces

  • None
  • PHP

Classes

  • Mailchimp
  • Mailchimp_Campaigns
  • Mailchimp_Ecomm
  • Mailchimp_Folders
  • Mailchimp_Gallery
  • Mailchimp_Helper
  • Mailchimp_Lists
  • Mailchimp_Mobile
  • Mailchimp_Neapolitan
  • Mailchimp_Reports
  • Mailchimp_Templates
  • Mailchimp_Users
  • Mailchimp_Vip

Exceptions

  • Mailchimp_Absplit_UnknownError
  • Mailchimp_Absplit_UnknownSplitTest
  • Mailchimp_Absplit_UnknownTestType
  • Mailchimp_Absplit_UnknownWaitUnit
  • Mailchimp_Absplit_UnknownWinnerType
  • Mailchimp_Absplit_WinnerNotSelected
  • Mailchimp_Avesta_Db_Exception
  • Mailchimp_Campaign_BounceMissing
  • Mailchimp_Campaign_DoesNotExist
  • Mailchimp_Campaign_InvalidAbsplit
  • Mailchimp_Campaign_InvalidAuto
  • Mailchimp_Campaign_InvalidContent
  • Mailchimp_Campaign_InvalidOption
  • Mailchimp_Campaign_InvalidRss
  • Mailchimp_Campaign_InvalidSegment
  • Mailchimp_Campaign_InvalidStatus
  • Mailchimp_Campaign_InvalidTemplate
  • Mailchimp_Campaign_NotSaved
  • Mailchimp_Campaign_StatsNotAvailable
  • Mailchimp_Email_AlreadySubscribed
  • Mailchimp_Email_AlreadyUnsubscribed
  • Mailchimp_Email_NotExists
  • Mailchimp_Email_NotSubscribed
  • Mailchimp_Error
  • Mailchimp_HttpError
  • Mailchimp_Invalid_Analytics
  • Mailchimp_Invalid_ApiKey
  • Mailchimp_Invalid_AppKey
  • Mailchimp_Invalid_DateTime
  • Mailchimp_Invalid_EcommOrder
  • Mailchimp_Invalid_Email
  • Mailchimp_Invalid_Folder
  • Mailchimp_Invalid_IP
  • Mailchimp_Invalid_Options
  • Mailchimp_Invalid_PagingLimit
  • Mailchimp_Invalid_PagingStart
  • Mailchimp_Invalid_SendType
  • Mailchimp_Invalid_Template
  • Mailchimp_Invalid_TrackingOptions
  • Mailchimp_Invalid_URL
  • Mailchimp_List_AlreadySubscribed
  • Mailchimp_List_CannotRemoveEmailMerge
  • Mailchimp_List_DoesNotExist
  • Mailchimp_List_InvalidBounceMember
  • Mailchimp_List_InvalidImport
  • Mailchimp_List_InvalidInterestFieldType
  • Mailchimp_List_InvalidInterestGroup
  • Mailchimp_List_InvalidMergeField
  • Mailchimp_List_InvalidOption
  • Mailchimp_List_InvalidUnsubMember
  • Mailchimp_List_Merge_InvalidMergeID
  • Mailchimp_List_MergeFieldRequired
  • Mailchimp_List_NotSubscribed
  • Mailchimp_List_TooManyInterestGroups
  • Mailchimp_List_TooManyMergeFields
  • Mailchimp_Max_Size_Reached
  • Mailchimp_MC_ContentImport_InvalidArchive
  • Mailchimp_MC_InvalidPayment
  • Mailchimp_MC_PastedList_Duplicate
  • Mailchimp_MC_PastedList_InvalidImport
  • Mailchimp_MC_SearchException
  • Mailchimp_Module_Unknown
  • Mailchimp_MonthlyPlan_Unknown
  • Mailchimp_Order_TypeUnknown
  • Mailchimp_Parse_Exception
  • Mailchimp_PDOException
  • Mailchimp_Request_TimedOut
  • Mailchimp_ServerError_InvalidParameters
  • Mailchimp_ServerError_MethodUnknown
  • Mailchimp_Too_Many_Connections
  • Mailchimp_Unknown_Exception
  • Mailchimp_User_CannotSendCampaign
  • Mailchimp_User_Disabled
  • Mailchimp_User_DoesExist
  • Mailchimp_User_DoesNotExist
  • Mailchimp_User_InvalidAction
  • Mailchimp_User_InvalidRole
  • Mailchimp_User_MissingEmail
  • Mailchimp_User_MissingModuleOutbox
  • Mailchimp_User_ModuleAlreadyPurchased
  • Mailchimp_User_ModuleNotPurchased
  • Mailchimp_User_NotApproved
  • Mailchimp_User_NotEnoughCredit
  • Mailchimp_User_UnderMaintenance
  • Mailchimp_User_Unknown
  • Mailchimp_ValidationError
  • Mailchimp_XML_RPC2_Exception
  • Mailchimp_XML_RPC2_FaultException
  • Mailchimp_Zend_Uri_Exception
  • Overview
  • Namespace
  • Class
  • Tree
  1: <?php
  2: 
  3: class Mailchimp_Vip {
  4:     public function __construct(Mailchimp $master) {
  5:         $this->master = $master;
  6:     }
  7: 
  8:     /**
  9:      * Retrieve all Activity (opens/clicks) for VIPs over the past 10 days
 10:      * @return array structs for each activity recorded.
 11:      *     - action string The action taken - either "open" or "click"
 12:      *     - timestamp string The datetime the action occurred in GMT
 13:      *     - url string IF the action is a click, the url that was clicked
 14:      *     - unique_id string The campaign_id of the List the Member appears on
 15:      *     - title string The campaign title
 16:      *     - list_name string The name of the List the Member appears on
 17:      *     - list_id string The id of the List the Member appears on
 18:      *     - email string The email address of the member
 19:      *     - fname string IF a FNAME merge field exists on the list, that value for the member
 20:      *     - lname string IF a LNAME merge field exists on the list, that value for the member
 21:      *     - member_rating int the rating of the subscriber. This will be 1 - 5 as described <a href="http://eepurl.com/f-2P" target="_blank">here</a>
 22:      *     - member_since string the datetime the member was added and/or confirmed
 23:      *     - geo associative_array the geographic information if we have it. including:
 24:      *         - latitude string the latitude
 25:      *         - longitude string the longitude
 26:      *         - gmtoff string GMT offset
 27:      *         - dstoff string GMT offset during daylight savings (if DST not observered, will be same as gmtoff
 28:      *         - timezone string the timezone we've place them in
 29:      *         - cc string 2 digit ISO-3166 country code
 30:      *         - region string generally state, province, or similar
 31:      */
 32:     public function activity() {
 33:         $_params = array();
 34:         return $this->master->call('vip/activity', $_params);
 35:     }
 36: 
 37:     /**
 38:      * Add VIPs (previously called Golden Monkeys)
 39:      * @param string $id
 40:      * @param array $emails
 41:      *     - email string an email address - for new subscribers obviously this should be used
 42:      *     - euid string the unique id for an email address (not list related) - the email "id" returned from listMemberInfo, Webhooks, Campaigns, etc.
 43:      *     - leid string the list email id (previously called web_id) for a list-member-info type call. this doesn't change when the email address changes
 44:      * @return associative_array of data and success/error counts
 45:      *     - success_count int the number of successful adds
 46:      *     - error_count int the number of unsuccessful adds
 47:      *     - errors array array of error structs including:
 48:      *         - email associative_array whatever was passed in the email parameter
 49:      *             - email string the email address added
 50:      *             - euid string the email unique id
 51:      *             - leid string the list member's truly unique id
 52:      *         - code string the error code
 53:      *         - error string the error message
 54:      *     - data array array of structs for each member added
 55:      *         - email associative_array whatever was passed in the email parameter
 56:      *             - email string the email address added
 57:      *             - euid string the email unique id
 58:      *             - leid string the list member's truly unique id
 59:      */
 60:     public function add($id, $emails) {
 61:         $_params = array("id" => $id, "emails" => $emails);
 62:         return $this->master->call('vip/add', $_params);
 63:     }
 64: 
 65:     /**
 66:      * Remove VIPs - this does not affect list membership
 67:      * @param string $id
 68:      * @param array $emails
 69:      *     - email string an email address - for new subscribers obviously this should be used
 70:      *     - euid string the unique id for an email address (not list related) - the email "id" returned from listMemberInfo, Webhooks, Campaigns, etc.
 71:      *     - leid string the list email id (previously called web_id) for a list-member-info type call. this doesn't change when the email address changes
 72:      * @return associative_array of data and success/error counts
 73:      *     - success_count int the number of successful deletions
 74:      *     - error_count int the number of unsuccessful deletions
 75:      *     - errors array array of error structs including:
 76:      *         - email associative_array whatever was passed in the email parameter
 77:      *             - email string the email address
 78:      *             - euid string the email unique id
 79:      *             - leid string the list member's truly unique id
 80:      *         - code string the error code
 81:      *         - msg string the error message
 82:      *     - data array array of structs for each member deleted
 83:      *         - email associative_array whatever was passed in the email parameter
 84:      *             - email string the email address
 85:      *             - euid string the email unique id
 86:      *             - leid string the list member's truly unique id
 87:      */
 88:     public function del($id, $emails) {
 89:         $_params = array("id" => $id, "emails" => $emails);
 90:         return $this->master->call('vip/del', $_params);
 91:     }
 92: 
 93:     /**
 94:      * Retrieve all Golden Monkey(s) for an account
 95:      * @return array structs for each Golden Monkey, including:
 96:      *     - list_id string The id of the List the Member appears on
 97:      *     - list_name string The name of the List the Member appears on
 98:      *     - email string The email address of the member
 99:      *     - fname string IF a FNAME merge field exists on the list, that value for the member
100:      *     - lname string IF a LNAME merge field exists on the list, that value for the member
101:      *     - member_rating int the rating of the subscriber. This will be 1 - 5 as described <a href="http://eepurl.com/f-2P" target="_blank">here</a>
102:      *     - member_since string the datetime the member was added and/or confirmed
103:      */
104:     public function members() {
105:         $_params = array();
106:         return $this->master->call('vip/members', $_params);
107:     }
108: 
109: }
110: 
111: 
112: 
API documentation generated by ApiGen 2.8.0