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_Users

Located at Mailchimp/Users.php
Methods summary
public
# __construct( Mailchimp $master )
public associative_array
# invite( string $email, string $role = 'viewer', string $msg = '' )

Invite a user to your account

Invite a user to your account

Parameters

$email
string
$email
$role
string
$role
$msg
string
$msg

Returns

associative_array
the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
public associative_array
# inviteResend( string $email )

Resend an invite a user to your account. Note, if the same address has been invited multiple times, this will simpy re-send the most recent invite

Resend an invite a user to your account. Note, if the same address has been invited multiple times, this will simpy re-send the most recent invite

Parameters

$email
string
$email

Returns

associative_array
the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
public associative_array
# inviteRevoke( string $email )

Revoke an invitation sent to a user to your account. Note, if the same address has been invited multiple times, this will simpy revoke the most recent invite

Revoke an invitation sent to a user to your account. Note, if the same address has been invited multiple times, this will simpy revoke the most recent invite

Parameters

$email
string
$email

Returns

associative_array
the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
public array
# invites( )

Retrieve the list of pending users invitations have been sent for.

Retrieve the list of pending users invitations have been sent for.

Returns

array
structs for each invitation, including: - email string the email address the invitation was sent to - role string the role that will be assigned if they accept - sent_at string the time the invitation was sent. this will change if it's resent. - expiration string the expiration time for the invitation. this will change if it's resent. - msg string the welcome message included with the invitation
public associative_array
# loginRevoke( string $username )

Revoke access for a specified login

Revoke access for a specified login

Parameters

$username
string
$username

Returns

associative_array
the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
public array
# logins( )

Retrieve the list of active logins.

Retrieve the list of active logins.

Returns

array
structs for each user, including: - id int the login id for this login - username string the username used to log in - name string a display name for the account - empty first/last names will return the username - email string the email tied to the account used for passwords resets and the ilk - role string the role assigned to the account - avatar string if available, the url for the login's avatar
public associative_array
# profile( )

Retrieve the profile for the login owning the provided API Key

Retrieve the profile for the login owning the provided API Key

Returns

associative_array
the current user's details, including: - id int the login id for this login - username string the username used to log in - name string a display name for the account - empty first/last names will return the username - email string the email tied to the account used for passwords resets and the ilk - role string the role assigned to the account - avatar string if available, the url for the login's avatar
API documentation generated by ApiGen 2.8.0