Class Swift_Address

Description

Swift_Address is just a lone e-mail address reprsented as an object

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

Swift_AddressContainer
   |
   --Swift_Address
Variable Summary
string $address
string $name
Method Summary
Swift_Address __construct (string $address, [string $name = null])
string build ([boolean $smtp = false])
string getAddress ()
string getName ()
void setAddress (string $address)
void setName (string $name)
string __toString ()
Variables
string $address = null (line 26)

The e-mail address portion

  • access: protected
string $name = null (line 31)

The personal name part

  • access: protected
Methods
Constructor __construct (line 38)

Constructor

  • access: public
Swift_Address __construct (string $address, [string $name = null])
  • string $address: The address portion
  • string $name: The personal name, optional
build (line 81)

Build the address the way it should be structured

  • access: public
string build ([boolean $smtp = false])
  • boolean $smtp: If the string will be sent to a SMTP server as an envelope
getAddress (line 55)

Get the address portion

  • access: public
string getAddress ()
getName (line 72)

Get personal name portion

  • access: public
string getName ()
setAddress (line 47)

Set the email address

  • access: public
void setAddress (string $address)
  • string $address
setName (line 63)

Set the personal name

  • access: public
void setName (string $name)
  • string $name
__toString (line 100)

PHP's casting conversion

  • access: public
string __toString ()

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