API Documentation
\
Pop
Acl
Assertion
Policy
Audit
Adapter
Model
Auth
Cache
Adapter
Code
Generator
Traits
Reflection
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Record
Relationships
Sql
Migration
Parser
Predicate
Schema
Formatter
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Filter
Form
Element
Input
Select
Ftp
Http
Client
Server
Request
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Mime
Part
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Queue
Adapter
Processor
Jobs
Router
Match
Service
Session
Utils
Validator
View
Template
Stream
Popcorn

\Pop\Mail\Transport\SmtpAuthHandler

SMTP auth handler class

Summary

Methods
Properties
Constants
__construct()
setAuthenticators()
getAuthenticators()
setUsername()
getUsername()
setPassword()
getPassword()
setAuthMode()
getAuthMode()
getHandledKeyword()
setKeywordParams()
afterEhlo()
getMailParams()
getRcptParams()
onCommand()
getPriorityOver()
resetState()
No public properties found
No constants found
getAuthenticatorsForAgent()
No protected properties found
N/A
No private methods found
$authenticators
$username
$password
$authMode
$esmtpParams
N/A

Properties

$authenticators

$authenticators : array

Authenticators available to process the request.

Type

array

$username

$username : string

The username for authentication

Type

string

$password

$password : string

The password for authentication

Type

string

$authMode

$authMode : string

The auth mode for authentication

Type

string

$esmtpParams

$esmtpParams : array

The ESMTP AUTH parameters available

Type

array

Methods

__construct()

__construct(array  $authenticators)

Create a new AuthHandler with $authenticators for support

Parameters

array $authenticators

setAuthenticators()

setAuthenticators(array  $authenticators)

Set the Authenticators which can process a login request

Parameters

array $authenticators

getAuthenticators()

getAuthenticators() : array

Get the Authenticators which can process a login request

Returns

array

setUsername()

setUsername(string  $username)

Set the username to authenticate with

Parameters

string $username

getUsername()

getUsername() : string

Get the username to authenticate with

Returns

string

setPassword()

setPassword(string  $password)

Set the password to authenticate with

Parameters

string $password

getPassword()

getPassword() : string

Get the password to authenticate with

Returns

string

setAuthMode()

setAuthMode(string  $mode)

Set the auth mode to use to authenticate

Parameters

string $mode

getAuthMode()

getAuthMode() : string

Get the auth mode to use to authenticate

Returns

string

getHandledKeyword()

getHandledKeyword() : boolean

Get the name of the ESMTP extension this handles

Returns

boolean

setKeywordParams()

setKeywordParams(array  $parameters)

Set the parameters which the EHLO greeting indicated

Parameters

array $parameters

afterEhlo()

afterEhlo(\Pop\Mail\Transport\Smtp\AgentInterface  $agent)

Runs immediately after a EHLO has been issued

Parameters

\Pop\Mail\Transport\Smtp\AgentInterface $agent

to read/write

Throws

\Pop\Mail\Transport\Smtp\Exception

getMailParams()

getMailParams() : array<mixed,string>

Not used

Returns

array<mixed,string>

getRcptParams()

getRcptParams() : array<mixed,string>

Not used

Returns

array<mixed,string>

onCommand()

onCommand(\Pop\Mail\Transport\Smtp\AgentInterface  $agent, string  $command, array  $codes = array(), boolean  $stop = false)

Not used

Parameters

\Pop\Mail\Transport\Smtp\AgentInterface $agent

to read/write
string $command

to send
array $codes

expected in response
boolean $stop

to be set true by-reference if the command is now sent

getPriorityOver()

getPriorityOver(string  $esmtpKeyword) : integer

Returns +1, -1 or 0 according to the rules for usort().

This method is called to ensure extensions can be execute in an appropriate order.

Parameters

string $esmtpKeyword

to compare with

Returns

integer

resetState()

resetState()

Not used

getAuthenticatorsForAgent()

getAuthenticatorsForAgent() : array

Returns the authenticator list for the given agent

Throws

\Pop\Mail\Transport\Smtp\Exception

Returns

array