1: <?php
2:
3: /*
4: * This file is part of SwiftMailer.
5: * (c) 2004-2009 Chris Corbyn
6: *
7: * For the full copyright and license information, please view the LICENSE
8: * file that was distributed with this source code.
9: */
10:
11: /**
12: * Provides an abstract way of specifying recipients for batch sending.
13: * @package Swift
14: * @subpackage Mailer
15: * @author Chris Corbyn
16: */
17: interface Swift_Mailer_RecipientIterator
18: {
19: /**
20: * Returns true only if there are more recipients to send to.
21: * @return boolean
22: */
23: public function hasNext();
24:
25: /**
26: * Returns an array where the keys are the addresses of recipients and the
27: * values are the names.
28: * e.g. ('foo@bar' => 'Foo') or ('foo@bar' => NULL)
29: * @return array
30: */
31: public function nextRecipient();
32: }
33: