Interface Swift_Connection

Description

Swift Connection Interface

Lists methods which are required by any connections

Located in /Swift/Connection.php (line 18)


	
			
Method Summary
array getAttributes (string $name)
boolean getRequiresEHLO ()
boolean hasExtension (string $name)
boolean isAlive ()
void postConnect ( $instance)
string read ()
void setExtension (string $name, [array $list = array()])
void setRequiresEHLO (boolean $set)
void start ()
void stop ()
void write (string $command, [ $end = "\r\n"])
Methods
getAttributes (line 65)

Get the list of attributes for the extension $name

  • access: public
  • throws: Swift_ConnectionException If no such extension can be found
array getAttributes (string $name)
  • string $name: The name of the extension
getRequiresEHLO (line 75)

Returns TRUE if the connection needs a EHLO greeting.

  • access: public
boolean getRequiresEHLO ()
hasExtension (line 58)

Check if an extension exists by the name $name

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

Check if the connection is up or not

  • access: public
boolean isAlive ()
postConnect (line 70)

Execute logic needed after SMTP greetings

  • access: public
void postConnect ( $instance)
  • Swift $instance: An instance of Swift
read (line 30)

Return the contents of the buffer

  • access: public
  • throws: Swift_ConnectionException If the buffer cannot be read
string read ()
setExtension (line 52)

Add an extension which is available on this connection

  • access: public
void setExtension (string $name, [array $list = array()])
  • string $name: The name of the extension
  • array $list: The list of attributes for the extension
setRequiresEHLO (line 80)

Set if the connection needs a EHLO greeting.

  • access: public
void setRequiresEHLO (boolean $set)
  • boolean $set
start (line 24)

Try to start the connection

  • access: public
  • throws: Swift_ConnectionException If the connection cannot be started
void start ()
stop (line 41)

Try to stop the connection

  • access: public
  • throws: Swift_ConnectionException If the connection cannot be closed/stopped
void stop ()
write (line 36)

Write a command to the buffer

  • access: public
  • throws: Swift_ConnectionException If the write fails
void write (string $command, [ $end = "\r\n"])
  • string $command: The command to send
  • $end

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