Address
in package
implements
IAddress
Mail Address Object
This object is used to define the address and label of a email address
Tags
Table of Contents
Interfaces
- IAddress
- Mail Address Interface
Properties
Methods
- __construct() : mixed
- initialize the mail address object
- getAddress() : string|null
- gets the mail address
- getLabel() : string|null
- gets the mail address label/name
- setAddress() : self
- sets the mail address
- setLabel() : self
- sets the mail address label/name
Properties
$address
protected
string|null
$address
= null
$label
protected
string|null
$label
= null
Methods
__construct()
initialize the mail address object
public
__construct([string|null $address = null ][, string|null $label = null ]) : mixed
Parameters
- $address : string|null = null
-
mail address (e.g test@example.com)
- $label : string|null = null
-
mail address label/name
Tags
getAddress()
gets the mail address
public
getAddress() : string|null
Tags
Return values
string|null —returns the mail address or null if one is not set
getLabel()
gets the mail address label/name
public
getLabel() : string|null
Tags
Return values
string|null —returns the mail address label/name or null if one is not set
setAddress()
sets the mail address
public
setAddress(string $value) : self
Parameters
- $value : string
-
mail address (e.g. test@example.com)
Tags
Return values
self —return this object for command chaining
setLabel()
sets the mail address label/name
public
setLabel(string $value) : self
Parameters
- $value : string
-
mail address label/name
Tags
Return values
self —return this object for command chaining