Mailchimp library, usable from CI code
Library with utility queries to interface Mailchimp v3 API
Inspired by the work of ThinkShout: https://github.com/thinkshout/mailchimp-api-php
Methods summary
public
|
|
public
object
|
#
getLists( array $parameters = array('fields' => 'lists.id,lists.name,lists.stats.member_count,lists.stats.merge_field_count') )
Gets information about all lists owned by the authenticated account.
Gets information about all lists owned by the authenticated account.
Parameters
- $parameters
Associative array of optional request parameters.
By the default it places a simple query to list name & id and count of members & merge_fields
NOTE: no space between , and next word is allowed. You will not get the filter to work in full but just the first tag
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists
|
public
object
|
#
getList( string $list_id, array $parameters = array('fields' => 'id,name,stats.member_count,stats.merge_field_count') )
Gets a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $parameters
- Associative array of optional request parameters.
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists_list_id
|
public
object
|
#
getMembers( string $list_id, array $count, $offset, $parameters = array('fields' => 'members.id,members.email_address,members.unique_email_id,members.status,members.merge_fields') )
Gets information about all members of a MailChimp list.
Gets information about all members of a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $count
$parameters
Associative array of optional request parameters.
- $offset
- $parameters
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members
|
public
object
|
#
getMemberInfoById( string $list_id, string $md5id, array $parameters = array('fields' => 'email_address,status,merge_fields') )
Gets information about a member of a MailChimp list.
Gets information about a member of a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $md5id
- The member's email address md5 hash which is the id.
- $parameters
- Associative array of optional request parameters.
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members_subscriber_hash
|
public
object
|
#
getMemberInfo( string $list_id, string $email, array $parameters = array() )
Gets information about a member of a MailChimp list.
Gets information about a member of a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $email
- The member's email address.
- $parameters
- Associative array of optional request parameters.
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members_subscriber_hash
|
public
object
|
#
getMemberActivity( string $list_id, string $email, array $parameters = array() )
Gets activity related to a member of a MailChimp list.
Gets activity related to a member of a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $email
- The member's email address.
- $parameters
- Associative array of optional request parameters.
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/activity/#read-get_lists_list_id_members_subscriber_hash_activity
|
public
object
|
#
addMember( string $list_id, string $email, array $first_name, $last_name, $parameters = array() )
Adds a new member to a MailChimp list.
Adds a new member to a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $email
- The email address to add.
- $first_name
$parameters
Associative array of optional request parameters.
- $last_name
- $parameters
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#create-post_lists_list_id_members
|
public
object
|
#
removeMember( string $list_id, string $email )
Removes a member from a MailChimp list.
Removes a member from a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $email
- The member's email address.
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#delete-delete_lists_list_id_members_subscriber_hash
|
public
object
|
#
updateMember( string $list_id, string $email, array $first_name, $last_name, $parameters = array() )
Updates a member of a MailChimp list.
Updates a member of a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $email
- The member's email address.
- $first_name
$parameters
Associative array of optional request parameters.
- $last_name
- $parameters
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#edit-patch_lists_list_id_members_subscriber_hash
|
public
object
|
#
addOrUpdateMember( string $list_id, string $email, array $first_name, $last_name, $status, $parameters = array() )
Adds a new or update an existing member of a MailChimp list.
Adds a new or update an existing member of a MailChimp list.
Parameters
- $list_id
- The ID of the list.
- $email
- The member's email address.
- $first_name
$parameters
Associative array of optional request parameters.
- $last_name
- $status
- $parameters
Returns
object
See
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#edit-put_lists_list_id_members_subscriber_hash
|