Class Swift_RecipientList

Description

Swift's Recipient List container. Contains To, Cc, Bcc

Located in /Swift/RecipientList.php (line 21)

Swift_AddressContainer
   |
   --Swift_RecipientList
Variable Summary
array $bcc
array $cc
array,Swift_Iterator $iterators
array $to
Method Summary
void add (string $address, [string $name = ""], [string $where = "to"])
void addBcc (mixed $address, [string $name = null])
void addCc (mixed $address, [string $name = null])
void addTo (mixed $address, [string $name = null])
void flush ()
void flushBcc ()
void flushCc ()
void flushTo ()
array getBcc ()
array getCc ()
Swift_Iterator getIterator (string $where)
array getTo ()
void remove (string $address, [string $where = "to"])
void removeBcc (mixed $address)
void removeCc (mixed $address)
void removeTo (mixed $address)
void setIterator (Swift_Iterator $it,  $where)
Variables
array $bcc = array() (line 37)

The recipients in the Bcc: header

  • access: protected
array $cc = array() (line 32)

The recipients in the Cc: header

  • access: protected
array,Swift_Iterator $iterators = array("to" => null, "cc" => null, "bcc" => null) (line 44)

Iterators to use when getting lists back out.

If any iterators are present here, their relevant "addXX()" methods will be useless. As per the last note, any iterators need to be pre-configured before Swift::send() is called.

  • access: protected
array $to = array() (line 27)

The recipients in the To: header

  • access: protected
Methods
add (line 52)

Add a recipient.

  • access: public
void add (string $address, [string $name = ""], [string $where = "to"])
  • string $address: The address
  • string $name: The name
  • string $where: The field (to, cc or bcc)
addBcc (line 196)

Add a Bcc: recipient

  • access: public
void addBcc (mixed $address, [string $name = null])
  • mixed $address: The address to add. Can be a string or Swift_Address
  • string $name: The personal name, optional
addCc (line 162)

Add a Cc: recipient

  • access: public
void addCc (mixed $address, [string $name = null])
  • mixed $address: The address to add. Can be a string or Swift_Address
  • string $name: The personal name, optional
addTo (line 128)

Add a To: recipient

  • access: public
void addTo (mixed $address, [string $name = null])
  • mixed $address: The address to add. Can be a string or Swift_Address
  • string $name: The personal name, optional
flush (line 228)

Empty the entire list

  • access: public
void flush ()
flushBcc (line 220)

Empty all Bcc: addresses

  • access: public
void flushBcc ()
flushCc (line 186)

Empty all Cc: addresses

  • access: public
void flushCc ()
flushTo (line 152)

Empty all To: addresses

  • access: public
void flushTo ()
getBcc (line 205)

Get an array of addresses in the Bcc: field

The array contains Swift_Address objects

  • access: public
array getBcc ()
getCc (line 171)

Get an array of addresses in the Cc: field

The array contains Swift_Address objects

  • access: public
array getCc ()
getIterator (line 100)

Get an iterator object for all the recipients in the given field.

  • access: public
Swift_Iterator getIterator (string $where)
  • string $where: The field name (to, cc or bcc)
getTo (line 137)

Get an array of addresses in the To: field

The array contains Swift_Address objects

  • access: public
array getTo ()
remove (line 82)

Remove a recipient.

  • access: public
void remove (string $address, [string $where = "to"])
  • string $address: The address
  • string $where: The field (to, cc or bcc)
removeBcc (line 213)

Remove a Bcc: recipient from the list

  • access: public
void removeBcc (mixed $address)
  • mixed $address: The address to remove. Can be Swift_Address or a string
removeCc (line 179)

Remove a Cc: recipient from the list

  • access: public
void removeCc (mixed $address)
  • mixed $address: The address to remove. Can be Swift_Address or a string
removeTo (line 145)

Remove a To: recipient from the list

  • access: public
void removeTo (mixed $address)
  • mixed $address: The address to remove. Can be Swift_Address or a string
setIterator (line 116)

Override the loading of the default iterator (Swift_ArrayIterator) and use the one given here.

  • access: public
void setIterator (Swift_Iterator $it,  $where)
  • Swift_Iterator $it: The iterator to use. It must be populated already.
  • $where

Documentation generated on Wed, 26 Mar 2008 20:33:10 +1100 by phpDocumentor 1.3.1