PHP Class Swift_Mime_Headers_PathHeader

Author: Chris Corbyn
Inheritance: extends Swift_Mime_Headers_AbstractHeader
Show file Open project: swiftmailer/swiftmailer Class Usage Examples

Public Methods

Method Description
__construct ( string $name, Egulias\EmailValidator\EmailValidator $emailValidator ) Creates a new PathHeader with the given $name.
getAddress ( ) : string Get the address which is used in this Header (if any).
getFieldBody ( ) : string Get the string value of the body in this Header.
getFieldBodyModel ( ) : mixed Get the model for the field body.
getFieldType ( ) : integer Get the type of Header that this instance represents.
setAddress ( string $address ) Set the Address which should appear in this Header.
setFieldBodyModel ( string $model ) Set the model for the field body.

Private Methods

Method Description
assertValidAddress ( string $address ) Throws an Exception if the address passed does not comply with RFC 2822.

Method Details

__construct() public method

Creates a new PathHeader with the given $name.
public __construct ( string $name, Egulias\EmailValidator\EmailValidator $emailValidator )
$name string
$emailValidator Egulias\EmailValidator\EmailValidator

getAddress() public method

Null is returned if no address is set.
public getAddress ( ) : string
return string

getFieldBody() public method

This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see {@link toString()} for that).
See also: toString()
public getFieldBody ( ) : string
return string

getFieldBodyModel() public method

This method returns a string email address.
public getFieldBodyModel ( ) : mixed
return mixed

getFieldType() public method

Get the type of Header that this instance represents.
public getFieldType ( ) : integer
return integer

setAddress() public method

Set the Address which should appear in this Header.
public setAddress ( string $address )
$address string

setFieldBodyModel() public method

This method takes a string for an address.
public setFieldBodyModel ( string $model )
$model string