You are here

function mailchimp_is_subscribed in Mailchimp 7.4

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.3 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.

9 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_automations_trigger_workflow in modules/mailchimp_automations/mailchimp_automations.module
Triggers a workflow automation via the Mailchimp API.
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.

... See full list

File

./mailchimp.module, line 545
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;
}