aboutsummaryrefslogtreecommitdiff
path: root/h-source/External/swiftmailer/lib/classes/Swift/Mailer/RecipientIterator.php
blob: 2713841663b779d39c4b8041f33def33e5c66991 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Provides an abstract way of specifying recipients for batch sending.
 * @package Swift
 * @subpackage Mailer
 * @author Chris Corbyn
 */
interface Swift_Mailer_RecipientIterator
{
  
  /**
   * Returns true only if there are more recipients to send to.
   * @return boolean
   */
  public function hasNext();
  
  /**
   * Returns an array where the keys are the addresses of recipients and the
   * values are the names.
   * e.g. ('foo@bar' => 'Foo') or ('foo@bar' => NULL)
   * @return array
   */
  public function nextRecipient();
  
}