Class Address

Summary

Fully Qualified Name: Zend\Mail\Address
Implements: AddressInterface

Description

Methods

Name Description Defined By
__construct() Constructor Address
fromString() Create an instance from a string value. Address
getComment() Retrieve comment, if any Address
getEmail() Retrieve email Address
getName() Retrieve name Address
toString() String representation of address Address

Method Details

__construct()

Constructor

Parameter Name Type Description
$email string
$name null|string
$comment null|string

Returns:

fromString()

Create an instance from a string value.

Parses a string representing a single address. If it is a valid format, it then creates and returns an instance of itself using the name and email it has parsed from the value.

Parameter Name Type Description
$address string
$comment null|string Comment

Returns: self

getComment()

Retrieve comment, if any

Returns: null|string

getEmail()

Retrieve email

Returns: string

getName()

Retrieve name

Returns: string

toString()

String representation of address

Returns: string

Top