Documentation

AbstractClient
in package
implements ClientInterface

Abstract mail client class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
3.6.0

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

$service

Mail client service (pop, imap, nntp, etc.)

protected string $service = null

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

Search results