Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Transport_EsmtpHandler

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Transport/EsmtpHandler.php

Interface Overview


An ESMTP handler.


Author(s):

  • Chris Corbyn

Methods


Child classes:


Class Details

[line 16]
An ESMTP handler.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method afterEhlo [line 37]

void afterEhlo( Swift_Transport_SmtpAgent $agent)

Runs immediately after a EHLO has been issued.



Tags:

access:  public


Parameters:

Swift_Transport_SmtpAgent   $agent   to read/write

[ Top ]

method exposeMixinMethods [line 80]

string[] exposeMixinMethods( )

Returns an array of method names which are exposed to the Esmtp class.



Tags:

access:  public


[ Top ]

method getHandledKeyword [line 23]

bool getHandledKeyword( )

Get the name of the ESMTP extension this handles.



Tags:

access:  public


[ Top ]

method getMailParams [line 44]

string[] getMailParams( )

Get params which are appended to MAIL FROM:<>.



Tags:

access:  public


[ Top ]

method getPriorityOver [line 73]

int 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.




Tags:

access:  public


Parameters:

string   $esmtpKeyword   to compare with

[ Top ]

method getRcptParams [line 51]

string[] getRcptParams( )

Get params which are appended to RCPT TO:<>.



Tags:

access:  public


[ Top ]

method onCommand [line 62]

void onCommand( Swift_Transport_SmtpAgent $agent, string $command, [int[] $codes = array()], [ &$failedRecipients = null], [ &$stop = false], string[] $failedRecipients, bool $stop)

Runs when a command is due to be sent.



Tags:

access:  public


Parameters:

Swift_Transport_SmtpAgent   $agent   to read/write
string   $command   to send
int[]   $codes   expected in response
string[]   $failedRecipients   to collect failures
bool   $stop   to be set true by-reference if the command is now sent
   &$failedRecipients  
   &$stop  

[ Top ]

method resetState [line 85]

void resetState( )

Tells this handler to clear any buffers and reset its state.



Tags:

access:  public


[ Top ]

method setKeywordParams [line 30]

void setKeywordParams( $parameters)

Set the parameters which the EHLO greeting indicated.



Tags:

access:  public


Parameters:

string[]   $parameters  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:48:22 +0000 by phpDocumentor 1.4.3