Interface Swift_Transport_EsmtpHandler
Implemented by | Swift_Transport_Esmtp_AuthHandler |
---|
An ESMTP handler.
Public Methods
Method | Description | Defined By |
---|---|---|
afterEhlo() | Runs immediately after a EHLO has been issued. | Swift_Transport_EsmtpHandler |
exposeMixinMethods() | Returns an array of method names which are exposed to the Esmtp class. | Swift_Transport_EsmtpHandler |
getHandledKeyword() | Get the name of the ESMTP extension this handles. | Swift_Transport_EsmtpHandler |
getMailParams() | Get params which are appended to MAIL FROM:<>. | Swift_Transport_EsmtpHandler |
getPriorityOver() | Returns +1, -1 or 0 according to the rules for usort(). | Swift_Transport_EsmtpHandler |
getRcptParams() | Get params which are appended to RCPT TO:<>. | Swift_Transport_EsmtpHandler |
onCommand() | Runs when a command is due to be sent. | Swift_Transport_EsmtpHandler |
resetState() | Tells this handler to clear any buffers and reset its state. | Swift_Transport_EsmtpHandler |
setKeywordParams() | Set the parameters which the EHLO greeting indicated. | Swift_Transport_EsmtpHandler |
Method Details
Runs immediately after a EHLO has been issued.
public abstract void afterEhlo ( Swift_Transport_SmtpAgent $agent ) | ||
$agent | Swift_Transport_SmtpAgent | To read/write |
Returns an array of method names which are exposed to the Esmtp class.
public abstract string[] exposeMixinMethods ( ) |
Get the name of the ESMTP extension this handles.
public abstract bool getHandledKeyword ( ) |
Get params which are appended to MAIL FROM:<>.
public abstract string[] getMailParams ( ) |
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.
public abstract int getPriorityOver ( $esmtpKeyword ) | ||
$esmtpKeyword | string | To compare with |
Get params which are appended to RCPT TO:<>.
public abstract string[] getRcptParams ( ) |
Runs when a command is due to be sent.
public abstract void onCommand ( Swift_Transport_SmtpAgent $agent, $command, $codes = [], <b>&</b>$failedRecipients = null, <b>&</b>$stop = false ) | ||
$agent | Swift_Transport_SmtpAgent | To read/write |
$command | string | To send |
$codes | int | Expected in response |
$failedRecipients | string[] | To collect failures |
$stop | bool | To be set true by-reference if the command is now sent |
Tells this handler to clear any buffers and reset its state.
public abstract void resetState ( ) |
Set the parameters which the EHLO greeting indicated.
public abstract void setKeywordParams ( array $parameters ) | ||
$parameters | string[] |