AbstractMailClient
in package
implements
MailClientInterface
AbstractYes
Abstract mail client class
Tags
Table of Contents
Interfaces
- MailClientInterface
- Mail client interface
Properties
- $folder : string
- Current folder
- $host : string|null
- Mail client host
- $password : string
- Password
- $port : int|string|null
- Mail client port
- $service : string|null
- Mail client service (pop, imap, nntp, etc.)
- $username : string
- Username
Methods
- __construct() : mixed
- Constructor
- getFolder() : string
- Get folder
- getHost() : string|null
- Get mail client host
- getPassword() : string
- Get password
- getPort() : int|string|null
- Get mail client port
- getService() : string|null
- Get mail client service
- getUsername() : string
- Get username
- setFolder() : AbstractMailClient
- Set folder
- setHost() : AbstractMailClient
- Set mail client host
- setPassword() : AbstractMailClient
- Set password
- setPort() : AbstractMailClient
- Set mail client port
- setService() : AbstractMailClient
- Set mail client service
- setUsername() : AbstractMailClient
- Set username
Properties
$folder
Current folder
protected
string
$folder
= ''
$host
Mail client host
protected
string|null
$host
= null
$password
Password
protected
string
$password
= ''
$port
Mail client port
protected
int|string|null
$port
= null
$service
Mail client service (pop, imap, nntp, etc.)
protected
string|null
$service
= null
$username
Username
protected
string
$username
= ''
Methods
__construct()
Constructor
public
__construct(string $host, int|string $port[, string|null $service = null ]) : mixed
Instantiate the mail client object
Parameters
- $host : string
- $port : int|string
- $service : string|null = null
getFolder()
Get folder
public
getFolder() : string
Return values
stringgetHost()
Get mail client host
public
getHost() : string|null
Return values
string|nullgetPassword()
Get password
public
getPassword() : string
Return values
stringgetPort()
Get mail client port
public
getPort() : int|string|null
Return values
int|string|nullgetService()
Get mail client service
public
getService() : string|null
Return values
string|nullgetUsername()
Get username
public
getUsername() : string
Return values
stringsetFolder()
Set folder
public
setFolder(string $folder) : AbstractMailClient
Parameters
- $folder : string
Return values
AbstractMailClientsetHost()
Set mail client host
public
setHost(string $host) : AbstractMailClient
Parameters
- $host : string
Return values
AbstractMailClientsetPassword()
Set password
public
setPassword(string $password) : AbstractMailClient
Parameters
- $password : string
Return values
AbstractMailClientsetPort()
Set mail client port
public
setPort(int|string $port) : AbstractMailClient
Parameters
- $port : int|string
Return values
AbstractMailClientsetService()
Set mail client service
public
setService(string $service) : AbstractMailClient
Parameters
- $service : string
Return values
AbstractMailClientsetUsername()
Set username
public
setUsername(string $username) : AbstractMailClient
Parameters
- $username : string