You are here

function mailchimp_is_subscribed in Mailchimp 7.3

Same name and namespace in other branches
  1. 8 mailchimp.module \mailchimp_is_subscribed()
  2. 7.5 mailchimp.module \mailchimp_is_subscribed()
  3. 7.2 mailchimp.module \mailchimp_is_subscribed()
  4. 7.4 mailchimp.module \mailchimp_is_subscribed()
  5. 2.x mailchimp.module \mailchimp_is_subscribed()

Check if the given email is subscribed to the given list.

Simple wrapper around mailchimp_get_memberinfo().

Parameters

string $list_id: Unique string identifier for the list on your MailChimp account.

string $email: Email address to check for on the identified MailChimp List

bool $reset: Set to TRUE to ignore the cache. (Used heavily in testing functions.)

Return value

bool Indicates subscription status.

7 calls to mailchimp_is_subscribed()
MailchimpListsTestCase::testIsSubscribed in modules/mailchimp_lists/tests/mailchimp_lists.test
Tests the status of a member's subscription to a list.
mailchimp_lists_field_get in modules/mailchimp_lists/includes/mailchimp_lists.field.inc
Entity field data callback for MailChimp subscription fields.
mailchimp_lists_field_widget_form in modules/mailchimp_lists/includes/mailchimp_lists.field.inc
Implements hook_field_widget_form().
mailchimp_lists_process_subscribe_form_choices in modules/mailchimp_lists/mailchimp_lists.module
Processor for various list form submissions.
mailchimp_lists_subscribe_form in modules/mailchimp_lists/mailchimp_lists.module
Return a form element for a single newsletter.

... See full list

File

./mailchimp.module, line 351
Mailchimp module.

Code

function mailchimp_is_subscribed($list_id, $email, $reset = FALSE) {
  $subscribed = FALSE;
  $memberinfo = mailchimp_get_memberinfo($list_id, $email, $reset);
  if (isset($memberinfo['status']) && $memberinfo['status'] == 'subscribed') {
    $subscribed = TRUE;
  }
  return $subscribed;
}