Documentation

HandlerInterface
in

SMTP handler interface

Tags
category

Pop

author

Chris Corbyn, from the SwiftMailer library https://github.com/swiftmailer/swiftmailer

version
4.0.0

Table of Contents

Methods

afterEhlo()  : void
Runs immediately after a EHLO has been issued
getHandledKeyword()  : string
Get the name of the ESMTP extension this handles
getMailParams()  : array<string|int, mixed>
Get params which are appended to MAIL FROM:<>
getPriorityOver()  : int
Returns +1, -1 or 0 according to the rules for usort().
getRcptParams()  : array<string|int, mixed>
Get params which are appended to RCPT TO:<>
onCommand()  : void
Runs when a command is due to be sent
resetState()  : void
Tells this handler to clear any buffers and reset its state
setKeywordParams()  : void
Set the parameters which the EHLO greeting indicated

Methods

getHandledKeyword()

Get the name of the ESMTP extension this handles

public getHandledKeyword() : string
Return values
string

getMailParams()

Get params which are appended to MAIL FROM:<>

public getMailParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPriorityOver()

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

public getPriorityOver(string $esmtpKeyword) : int

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

Parameters
$esmtpKeyword : string

to compare with

Return values
int

getRcptParams()

Get params which are appended to RCPT TO:<>

public getRcptParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

onCommand()

Runs when a command is due to be sent

public onCommand(AgentInterface $agent, string $command[, array<string|int, mixed> $codes = [] ][, bool &$stop = false ]) : void
Parameters
$agent : AgentInterface

to read/write

$command : string

to send

$codes : array<string|int, mixed> = []

expected in response

$stop : bool = false

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

resetState()

Tells this handler to clear any buffers and reset its state

public resetState() : void

setKeywordParams()

Set the parameters which the EHLO greeting indicated

public setKeywordParams(array<string|int, mixed> $parameters) : void
Parameters
$parameters : array<string|int, mixed> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results