Docs For Class Swift_RecipientList

Description

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

author: Chris Corbyn <chris@w3style.co.uk>

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

Swift_AddressContainer
   |
   --Swift_RecipientList

Method Summary

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 ()

array getTo ()

void removeBcc (mixed $address)

void removeCc (mixed $address)

void removeTo (mixed $address)

Methods

addBcc (line 139)

Add a Bcc: recipient

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 91)

Add a Cc: recipient

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 43)

Add a To: recipient

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 185)

Empty the entire list

void flush ()

flushBcc (line 177)

Empty all Bcc: addresses

void flushBcc ()

flushCc (line 129)

Empty all Cc: addresses

void flushCc ()

flushTo (line 81)

Empty all To: addresses

void flushTo ()

getBcc (line 156)

Get an array of addresses in the Bcc: field

The array contains Swift_Address objects

array getBcc ()

getCc (line 108)

Get an array of addresses in the Cc: field

The array contains Swift_Address objects

array getCc ()

getTo (line 60)

Get an array of addresses in the To: field

The array contains Swift_Address objects

array getTo ()

removeBcc (line 164)

Remove a Bcc: recipient from the list

void removeBcc (mixed $address)

mixed $address: The address to remove. Can be Swift_Address or a string

removeCc (line 116)

Remove a Cc: recipient from the list

void removeCc (mixed $address)

mixed $address: The address to remove. Can be Swift_Address or a string

removeTo (line 68)

Remove a To: recipient from the list

void removeTo (mixed $address)

mixed $address: The address to remove. Can be Swift_Address or a string