Interface Swift_Transport_EsmtpHandler

An ESMTP handler.

Direct known implementers

Swift_Transport_Esmtp_AuthHandler

Package: Swift\Transport
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Transport/EsmtpHandler.php

Methods summary

`public boolean`	# `getHandledKeyword( )` Get the name of the ESMTP extension this handles. Get the name of the ESMTP extension this handles. Returns `boolean`
`public`	# `setKeywordParams( array $parameters )` Set the parameters which the EHLO greeting indicated. Set the parameters which the EHLO greeting indicated. Parameters `$parameters` `string[]` $parameters
`public`	# `afterEhlo( Swift_Transport_SmtpAgent $agent )` Runs immediately after a EHLO has been issued. Runs immediately after a EHLO has been issued. Parameters `$agent` `Swift_Transport_SmtpAgent` $agent to read/write
`public string[]`	# `getMailParams( )` Get params which are appended to MAIL FROM:<>. Get params which are appended to MAIL FROM:<>. Returns `string[]`
`public string[]`	# `getRcptParams( )` Get params which are appended to RCPT TO:<>. Get params which are appended to RCPT TO:<>. Returns `string[]`
`public`	# `onCommand( Swift_Transport_SmtpAgent $agent, string $command, int[] $codes = array(), string[] & $failedRecipients = null, boolean & $stop = false )` Runs when a command is due to be sent. Runs when a command is due to be sent. Parameters `$agent` `Swift_Transport_SmtpAgent` $agent to read/write `$command` `string` $command to send `$codes` `int[]` $codes expected in response `$failedRecipients` `string[]` &$failedRecipients `$stop` `boolean` &$stop to be set true if the command is now sent
`public integer`	# `getPriorityOver( string $esmtpKeyword )` 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. 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 `$esmtpKeyword` `string` $esmtpKeyword to compare with Returns `integer`
`public string[]`	# `exposeMixinMethods( )` Returns an array of method names which are exposed to the Esmtp class. Returns an array of method names which are exposed to the Esmtp class. Returns `string[]`
`public`	# `resetState( )` Tells this handler to clear any buffers and reset its state. Tells this handler to clear any buffers and reset its state.

Magic methods summary