Documentation

Swift_Plugins_PopBeforeSmtpPlugin
in package
implements Swift_Events_TransportChangeListener, Swift_Plugins_Pop_Pop3Connection

Makes sure a connection to a POP3 host has been established prior to connecting to SMTP.

Tags
author

Chris Corbyn

Interfaces, Classes and Traits

Swift_Events_TransportChangeListener
Listens for changes within the Transport system.
Swift_Plugins_Pop_Pop3Connection
Pop3Connection interface for connecting and disconnecting to a POP3 host.

Table of Contents

$connection  : mixed
A delegate connection to use (mostly a test hook)
$crypto  : mixed
Encryption type to use (if any)
$host  : mixed
Hostname of the POP3 server
$password  : mixed
Password to use (if any)
$port  : mixed
Port number to connect on
$socket  : mixed
Established connection via TCP socket
$timeout  : mixed
Connect timeout in seconds
$transport  : mixed
SMTP Transport to bind to
$username  : mixed
Username to use (if any)
__construct()  : mixed
Create a new PopBeforeSmtpPlugin for $host and $port.
beforeTransportStarted()  : mixed
Invoked just before a Transport is started.
beforeTransportStopped()  : mixed
Not used.
bindSmtp()  : mixed
Bind this plugin to a specific SMTP transport instance.
connect()  : mixed
Connect to the POP3 host and authenticate.
disconnect()  : mixed
Disconnect from the POP3 host.
setConnection()  : $this
Set a Pop3Connection to delegate to instead of connecting directly.
setPassword()  : $this
Set the password to use when connecting (if needed).
setTimeout()  : $this
Set the connection timeout in seconds (default 10).
setUsername()  : $this
Set the username to use when connecting (if needed).
transportStarted()  : mixed
Not used.
transportStopped()  : mixed
Not used.
assertOk()  : mixed
command()  : mixed
getHostString()  : mixed

Properties

$connection

A delegate connection to use (mostly a test hook)

private mixed $connection

Methods

__construct()

Create a new PopBeforeSmtpPlugin for $host and $port.

public __construct(string $host[, int $port = 110 ][, string $crypto = null ]) : mixed
Parameters
$host : string

Hostname or IP. Literal IPv6 addresses should be wrapped in square brackets.

$port : int = 110
$crypto : string = null

as "tls" or "ssl"

Return values
mixed —

disconnect()

Disconnect from the POP3 host.

public disconnect() : mixed
Return values
mixed —

setPassword()

Set the password to use when connecting (if needed).

public setPassword(string $password) : $this
Parameters
$password : string
Return values
$this —

setTimeout()

Set the connection timeout in seconds (default 10).

public setTimeout(int $timeout) : $this
Parameters
$timeout : int
Return values
$this —

setUsername()

Set the username to use when connecting (if needed).

public setUsername(string $username) : $this
Parameters
$username : string
Return values
$this —

assertOk()

private assertOk(mixed $response) : mixed
Parameters
$response : mixed
Return values
mixed —

command()

private command(mixed $command) : mixed
Parameters
$command : mixed
Return values
mixed —

Search results