AbstractClient
in package
implements
ClientInterface
Abstract mail client class
Tags
Interfaces, Classes, Traits and Enums
- ClientInterface
- Mail client interface
Table of Contents
- $folder : string
- Current folder
- $host : string
- Mail client host
- $password : string
- Password
- $port : int
- Mail client port
- $service : string
- Mail client service (pop, imap, nntp, etc.)
- $username : string
- Username
- __construct() : mixed
- Constructor
- getFolder() : string
- Get folder
- getHost() : string
- Get mail client host
- getPassword() : string
- Get password
- getPort() : int
- Get mail client port
- getService() : string
- Get mail client service
- getUsername() : string
- Get username
- setFolder() : AbstractClient
- Set folder
- setHost() : AbstractClient
- Set mail client host
- setPassword() : AbstractClient
- Set password
- setPort() : AbstractClient
- Set mail client port
- setService() : AbstractClient
- Set mail client service
- setUsername() : AbstractClient
- Set username
Properties
$folder
Current folder
protected
string
$folder
= ''
$host
Mail client host
protected
string
$host
= null
$password
Password
protected
string
$password
= ''
$port
Mail client port
protected
int
$port
= null
$service
Mail client service (pop, imap, nntp, etc.)
protected
string
$service
= null
$username
Username
protected
string
$username
= ''
Methods
__construct()
Constructor
public
__construct(string $host, int $port[, string $service = null ]) : mixed
Instantiate the mail client object
Parameters
- $host : string
- $port : int
- $service : string = null
Return values
mixed —getFolder()
Get folder
public
getFolder() : string
Return values
string —getHost()
Get mail client host
public
getHost() : string
Return values
string —getPassword()
Get password
public
getPassword() : string
Return values
string —getPort()
Get mail client port
public
getPort() : int
Return values
int —getService()
Get mail client service
public
getService() : string
Return values
string —getUsername()
Get username
public
getUsername() : string
Return values
string —setFolder()
Set folder
public
setFolder(string $folder) : AbstractClient
Parameters
- $folder : string
Return values
AbstractClient —setHost()
Set mail client host
public
setHost(string $host) : AbstractClient
Parameters
- $host : string
Return values
AbstractClient —setPassword()
Set password
public
setPassword(string $password) : AbstractClient
Parameters
- $password : string
Return values
AbstractClient —setPort()
Set mail client port
public
setPort(int $port) : AbstractClient
Parameters
- $port : int
Return values
AbstractClient —setService()
Set mail client service
public
setService(string $service) : AbstractClient
Parameters
- $service : string
Return values
AbstractClient —setUsername()
Set username
public
setUsername(string $username) : AbstractClient
Parameters
- $username : string