function mailchimp_segment_batch_add_subscribers in Mailchimp 7.3

Same name and namespace in other branches

1. 7.5 mailchimp.module \mailchimp_segment_batch_add_subscribers()
2. 7.4 mailchimp.module \mailchimp_segment_batch_add_subscribers()

Add a batch of email addresses to a static segment of a list.

Parameters

string $list_id: ID of a MailChimp list

string $segment_id: ID of a segment of the MailChimp list

array $batch: Batch of email addresses to add to the segment (does NOT subscribe new)

Return value

int Successful subscribe count

3 calls to mailchimp_segment_batch_add_subscribers()

MailchimpListsTestCase::testAddSegmentBatchSubscribers in modules/mailchimp_lists/tests/mailchimp_lists.test

Tests adding batch subscribers to a list segment.

mailchimp_lists_add_to_segment_action in modules/mailchimp_lists/mailchimp_lists.module

Action function for the Add To Segment action.

mailchimp_segment_add_subscriber in ./mailchimp.module

Add a specific subscriber to a static segment of a list.

1 string reference to 'mailchimp_segment_batch_add_subscribers'

mailchimp_segment_add_subscriber in ./mailchimp.module

Add a specific subscriber to a static segment of a list.

File

./mailchimp.module, line 875

Mailchimp module.

Code

function mailchimp_segment_batch_add_subscribers($list_id, $segment_id, $batch) {
  $count = 0;
  try {
    $mcapi = mailchimp_get_api_object();
    if (!$mcapi) {
      throw new MailchimpException('Cannot batch add segment subscribers without MailChimp API. Check API key has been entered.');
    }
    $results = $mcapi->lists
      ->staticSegmentMembersAdd($list_id, $segment_id, $batch);
    $count = isset($results['success_count']) ? $results['success_count'] : 0;
  } catch (Exception $e) {
    watchdog('mailchimp', 'An error occurred on batch segment add. List: @list_id Segment: @segment_id. "%message"', array(
      '@list_id' => $list_id,
      '@segment_id' => $segment_id,
      '%message' => $e
        ->getMessage(),
    ), WATCHDOG_ERROR);
  }
  return $count;
}