function MCAPI::listSubscribe in Mailchimp 6.2

Same name and namespace in other branches

5.2 MCAPI.class.php \MCAPI::listSubscribe()
5 MCAPI.class.php \MCAPI::listSubscribe()
6 MCAPI.class.php \MCAPI::listSubscribe()
7 MCAPI.class.php \MCAPI::listSubscribe()

Subscribe the provided email to a list. By default this sends a confirmation email - you will not see new members until the link contained in it is clicked!

@example mcapi_listSubscribe.php @example xml-rpc_listSubscribe.php

Parameters

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

string $email_address the email address to subscribe:

array $merge_vars array of merges for the email (FNAME, LNAME, etc.) (see examples below for handling "blank" arrays). Note that a merge field can only hold up to 255 characters. Also, there are a few "special" keys:: string EMAIL set this to change the email address. This is only respected on calls using update_existing or when passed to listUpdateMember() string INTERESTS Set Interest Groups by passing a field named "INTERESTS" that contains a comma delimited list of Interest Groups to add. Commas in Interest Group names should be escaped with a backslash. ie, "," => "\," array GROUPINGS Set Interest Groups by Grouping. Each element in this array should be an array containing the "groups" parameter (same restrictions as INTERESTS above) and either an "id" or "name" parameter to specify the Grouping - get from listInterestGroupings() string OPTINIP Set the Opt-in IP fields. Abusing this may cause your account to be suspended. We do validate this and it must not be a private IP address.

Handling Field Data Types - most fields you can just pass a string and all is well. For some, though, that is not the case... Field values should be formatted as follows: string address For the string version of an Address, the fields should be delimited by 2 spaces. Address 2 can be skipped. The Country should be a 2 character ISO-3166-1 code and will default to your default country if not set array address For the array version of an Address, the requirements for Address 2 and Country are the same as with the string version. Then simply pass us an array with the keys addr1, addr2, city, state, zip, country and appropriate values for each

string date use YYYY-MM-DD to be safe. Generally, though, anything strtotime() understands we'll understand - <a href="http://us2.php.net/strtotime" target="_blank">http://us2.php.net/strtotime</a> string dropdown can be a normal string - we will validate that the value is a valid option string image must be a valid, existing url. we will check its existence string multi_choice can be a normal string - we will validate that the value is a valid option double number pass in a valid number - anything else will turn in to zero (0). Note, this will be rounded to 2 decimal places string phone If your account has the US Phone numbers option set, this must be in the form of NPA-NXX-LINE (404-555-1212). If not, we assume an International number and will simply set the field with what ever number is passed in. string website This is a standard string, but we will verify that it looks like a valid URL

string $email_type optional - email type preference for the email (html, text, or mobile defaults to html):

boolean $double_optin optional - flag to control whether a double opt-in confirmation message is sent, defaults to true. Abusing this may cause your account to be suspended.:

boolean $update_existing optional - flag to control whether a existing subscribers should be updated instead of throwing and error, defaults to false:

boolean $replace_interests - flag to determine whether we replace the interest groups with the groups provided, or we add the provided groups to the member's interest groups (optional, defaults to true):

boolean $send_welcome - if your double_optin is false and this is true, we will send your lists Welcome Email if this subscribe succeeds - this will *not* fire if we end up updating an existing subscriber. If double_optin is true, this has no effect. defaults to false.:

Return value

boolean true on success, false on failure. When using MCAPI.class.php, the value can be tested and error messages pulled from the MCAPI object (see below)

File

./MCAPI.class.php, line 1467

Class

MCAPI

Code

function listSubscribe($id, $email_address, $merge_vars, $email_type = 'html', $double_optin = true, $update_existing = false, $replace_interests = true, $send_welcome = false) {
  $params = array();
  $params["id"] = $id;
  $params["email_address"] = $email_address;
  $params["merge_vars"] = $merge_vars;
  $params["email_type"] = $email_type;
  $params["double_optin"] = $double_optin;
  $params["update_existing"] = $update_existing;
  $params["replace_interests"] = $replace_interests;
  $params["send_welcome"] = $send_welcome;
  return $this
    ->callServer("listSubscribe", $params);
}

You are here