function MCAPI::lists in Mailchimp 6.2

Same name and namespace in other branches

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

Retrieve all of the lists defined for your user account

Related

@example mcapi_lists.php @example xml-rpc_lists.php

@returnf string id The list id for this list. This will be used for all other list management functions. @returnf integer web_id The list id used in our web app, allows you to create a link directly to it @returnf string name The name of the list. @returnf date date_created The date that this list was created. @returnf integer member_count The number of active members in the given list. @returnf integer unsubscribe_count The number of members who have unsubscribed from the given list. @returnf integer cleaned_count The number of members cleaned from the given list. @returnf boolean email_type_option Whether or not the List supports multiple formats for emails or just HTML @returnf string default_from_name Default From Name for campaigns using this list @returnf string default_from_email Default From Email for campaigns using this list @returnf string default_subject Default Subject Line for campaigns using this list @returnf string default_language Default Language for this list's forms @returnf double list_rating An auto-generated activity score for the list (0 - 5) @returnf integer member_count_since_send The number of active members in the given list since the last campaign was sent @returnf integer unsubscribe_count_since_send The number of members who have unsubscribed from the given list since the last campaign was sent @returnf integer cleaned_count_since_send The number of members cleaned from the given list since the last campaign was sent

Return value

array list of your Lists and their associated information (see Returned Fields for description)

File

./MCAPI.class.php, line 1012

Class

MCAPI

Code

function lists() {
  $params = array();
  return $this
    ->callServer("lists", $params);
}