function mailchimp_test_list_segment in Mailchimp 7.3

Same name and namespace in other branches

1. 8 modules/mailchimp_campaign/mailchimp_campaign.module \mailchimp_test_list_segment()
2. 7.5 modules/mailchimp_campaign/mailchimp_campaign.module \mailchimp_test_list_segment()
3. 7.4 modules/mailchimp_campaign/mailchimp_campaign.module \mailchimp_test_list_segment()
4. 2.x modules/mailchimp_campaign/mailchimp_campaign.module \mailchimp_test_list_segment()

Tests a list segment, returning the number of subscribers in the segment.

Parameters

string $list_id: The list ID.

string $list_segment_id: The list segment ID.

Return value

int The number of subscribers contained in the segment.

1 call to mailchimp_test_list_segment()

mailchimp_campaign_save_campaign in modules/mailchimp_campaign/mailchimp_campaign.module

Save a campaign in MailChimp and as a Drupal entity.

File

modules/mailchimp_campaign/mailchimp_campaign.module, line 922

Module file for mailchimp_campaign.

Code

function mailchimp_test_list_segment($list_id, $list_segment_id) {
  $mcapi = mailchimp_get_api_object();
  try {
    if (!$mcapi) {
      throw new MailchimpException('Cannot get campaign list segment without MailChimp API. Check API key has been entered.');
    }
    $result = $mcapi->campaigns
      ->segmentTest($list_id, array(
      'saved_segment_id' => $list_segment_id,
    ));
  } catch (Mailchimp_Error $e) {
    drupal_set_message($e
      ->getMessage(), 'error');
    watchdog('mailchimp_campaign', 'An error occurred testing a list segment: @msg', array(
      '@msg' => $e
        ->getMessage(),
    ), WATCHDOG_ERROR);
    return NULL;
  }
  return $result['total'];
}