function MCAPI::listMemberInfo in Mailchimp 6.2

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::listMemberInfo()
2. 5 MCAPI.class.php \MCAPI::listMemberInfo()
3. 6 MCAPI.class.php \MCAPI::listMemberInfo()
4. 7 MCAPI.class.php \MCAPI::listMemberInfo()

Get all the information for a particular member of a list

Related

@example mcapi_listMemberInfo.php @example xml-rpc_listMemberInfo.php

@returnf string id The unique id for this email address on an account @returnf string email The email address associated with this record @returnf string email_type The type of emails this customer asked to get: html, text, or mobile @returnf array merges An associative array of all the merge tags and the data for those tags for this email address. <em>Note</em>: Interest Groups are returned as comma delimited strings - if a group name contains a comma, it will be escaped with a backslash. ie, "," =&gt; "\,". Groupings will be returned with their "id" and "name" as well as a "groups" field formatted just like Interest Groups @returnf string status The subscription status for this email address, either subscribed, unsubscribed or cleaned @returnf string ip_opt IP Address this address opted in from. @returnf string ip_signup IP Address this address signed up from. @returnf int member_rating the rating of the subscriber. This will be 1 - 5 as described <a href="http://eepurl.com/f-2P" target="_blank">here</a> @returnf string campaign_id If the user is unsubscribed and they unsubscribed from a specific campaign, that campaign_id will be listed, otherwise this is not returned. @returnf array lists An associative array of the other lists this member belongs to - the key is the list id and the value is their status in that list. @returnf date timestamp The time this email address was added to the list @returnf date info_changed The last time this record was changed. If the record is old enough, this may be blank. @returnf integer web_id The Member id used in our web app, allows you to create a link directly to it

Parameters

string $id the list id to connect to. Get by calling lists():

string $email_address the member email address to get information for OR the "id" for the member returned from listMemberInfo, Webhooks, and Campaigns:

Return value

array array of list member info (see Returned Fields for details)

File

./MCAPI.class.php, line 1633

Class

MCAPI

Code

function listMemberInfo($id, $email_address) {
  $params = array();
  $params["id"] = $id;
  $params["email_address"] = $email_address;
  return $this
    ->callServer("listMemberInfo", $params);
}