Class Swift_ConnectionBase

Description

Implements interfaces:

Swift Connection Base Class

Located in /Swift/ConnectionBase.php (line 22)


	
			
Direct descendents
Class Description
Swift_Connection_Multi Swift Multi Connection
Swift_Connection_NativeMail Swift mail() Connection NOTE: This class is nothing more than a stub. The MailSend plugin does the actual sending.
Swift_Connection_Rotator Swift Rotator Connection
Swift_Connection_Sendmail Swift Sendmail Connection
Swift_Connection_SMTP Swift SMTP Connection
Variable Summary
array $extensions
boolean $isESMTP
Method Summary
array getAttributes (string $extension)
boolean getRequiresEHLO ()
boolean hasExtension (string $name)
void postConnect ( $instance)
void setExtension (string $name, [array $options = array()])
void setRequiresEHLO (boolean $set)
Variables
array $extensions = array() (line 28)

Any extensions the server might support

  • access: protected
boolean $isESMTP = false (line 33)

True if the connection is ESMTP.

  • access: protected
Methods
getAttributes (line 68)

Get the list of attributes supported by the given extension

  • return: The list of attributes
  • access: public
  • throws: Swift_ConnectionException If the extension cannot be found
array getAttributes (string $extension)
  • string $extension: The name of the connection

Implementation of:
Swift_Connection::getAttributes()
Get the list of attributes for the extension $name

Redefined in descendants as:
getRequiresEHLO (line 85)

Returns TRUE if the connection needs a EHLO greeting.

  • access: public
boolean getRequiresEHLO ()

Implementation of:
Swift_Connection::getRequiresEHLO()
Returns TRUE if the connection needs a EHLO greeting.
hasExtension (line 54)

Check if a given extension has been set as available

  • access: public
boolean hasExtension (string $name)
  • string $name: The name of the extension

Implementation of:
Swift_Connection::hasExtension()
Check if an extension exists by the name $name

Redefined in descendants as:
postConnect (line 61)

Execute any needed logic after connecting and handshaking

  • access: public
void postConnect ( $instance)

Implementation of:
Swift_Connection::postConnect()
Execute logic needed after SMTP greetings

Redefined in descendants as:
setExtension (line 40)

Set an extension which the connection reports to support

  • access: public
void setExtension (string $name, [array $options = array()])
  • string $name: Extension name
  • array $options: Attributes of the extension

Implementation of:
Swift_Connection::setExtension()
Add an extension which is available on this connection

Redefined in descendants as:
setRequiresEHLO (line 93)

Set TRUE if the connection needs a EHLO greeting.

  • access: public
void setRequiresEHLO (boolean $set)
  • boolean $set

Implementation of:
Swift_Connection::setRequiresEHLO()
Set if the connection needs a EHLO greeting.

Documentation generated on Wed, 26 Mar 2008 20:33:04 +1100 by phpDocumentor 1.3.1