\Pop\Mail\Transport\SmtpHandlerInterface

SMTP handler interface

Summary

Methods
Constants
getHandledKeyword()
setKeywordParams()
afterEhlo()
getMailParams()
getRcptParams()
onCommand()
getPriorityOver()
resetState()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

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

getMailParams()

getMailParams() : array<mixed,string>

Get params which are appended to MAIL FROM:<>

Returns

array<mixed,string>

getRcptParams()

getRcptParams() : array<mixed,string>

Get params which are appended to RCPT TO:<>

Returns

array<mixed,string>

onCommand()

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

Runs when a command is due to be sent

Parameters

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

to read/write

string $command

to send

array<mixed,integer> $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() 

Tells this handler to clear any buffers and reset its state