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

Class Mailchimp_Vip

Located at Mailchimp/Vip.php
Methods summary
public
# __construct( Mailchimp $master )
public array
# activity( )

Retrieve all Activity (opens/clicks) for VIPs over the past 10 days

Retrieve all Activity (opens/clicks) for VIPs over the past 10 days

Returns

array
structs for each activity recorded. - action string The action taken - either "open" or "click" - timestamp string The datetime the action occurred in GMT - url string IF the action is a click, the url that was clicked - unique_id string The campaign_id of the List the Member appears on - title string The campaign title - list_name string The name of the List the Member appears on - list_id string The id of the List the Member appears on - email string The email address of the member - fname string IF a FNAME merge field exists on the list, that value for the member - lname string IF a LNAME merge field exists on the list, that value for the member - member_rating int the rating of the subscriber. This will be 1 - 5 as described here - member_since string the datetime the member was added and/or confirmed - geo associative_array the geographic information if we have it. including: - latitude string the latitude - longitude string the longitude - gmtoff string GMT offset - dstoff string GMT offset during daylight savings (if DST not observered, will be same as gmtoff - timezone string the timezone we've place them in - cc string 2 digit ISO-3166 country code - region string generally state, province, or similar
public associative_array
# add( string $id, array $emails )

Add VIPs (previously called Golden Monkeys)

Add VIPs (previously called Golden Monkeys)

Parameters

$id
string
$id
$emails
array
$emails - email string an email address - for new subscribers obviously this should be used - euid string the unique id for an email address (not list related) - the email "id" returned from listMemberInfo, Webhooks, Campaigns, etc. - 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

Returns

associative_array
of data and success/error counts - success_count int the number of successful adds - error_count int the number of unsuccessful adds - errors array array of error structs including: - email associative_array whatever was passed in the email parameter - email string the email address added - euid string the email unique id - leid string the list member's truly unique id - code string the error code - error string the error message - data array array of structs for each member added - email associative_array whatever was passed in the email parameter - email string the email address added - euid string the email unique id - leid string the list member's truly unique id
public associative_array
# del( string $id, array $emails )

Remove VIPs - this does not affect list membership

Remove VIPs - this does not affect list membership

Parameters

$id
string
$id
$emails
array
$emails - email string an email address - for new subscribers obviously this should be used - euid string the unique id for an email address (not list related) - the email "id" returned from listMemberInfo, Webhooks, Campaigns, etc. - 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

Returns

associative_array
of data and success/error counts - success_count int the number of successful deletions - error_count int the number of unsuccessful deletions - errors array array of error structs including: - email associative_array whatever was passed in the email parameter - email string the email address - euid string the email unique id - leid string the list member's truly unique id - code string the error code - msg string the error message - data array array of structs for each member deleted - email associative_array whatever was passed in the email parameter - email string the email address - euid string the email unique id - leid string the list member's truly unique id
public array
# members( )

Retrieve all Golden Monkey(s) for an account

Retrieve all Golden Monkey(s) for an account

Returns

array
structs for each Golden Monkey, including: - list_id string The id of the List the Member appears on - list_name string The name of the List the Member appears on - email string The email address of the member - fname string IF a FNAME merge field exists on the list, that value for the member - lname string IF a LNAME merge field exists on the list, that value for the member - member_rating int the rating of the subscriber. This will be 1 - 5 as described here - member_since string the datetime the member was added and/or confirmed
API documentation generated by ApiGen 2.8.0