/Swift/Connection.php

Description

Swift Mailer Connection Interface

All connection handlers extend this abstract class Please read the LICENSE file

Functions
getAttributes (line 65)

Get the list of attributes for the extension $name

  • throws: Swift_Connection_Exception If no such extension can be found
array getAttributes (string $name)
  • string $name: The name of the extension
hasExtension (line 58)

Check if an extension exists by the name $name

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

Check if the connection is up or not

boolean isAlive ()
postConnect (line 70)

Execute logic needed after SMTP greetings

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

Return the contents of the buffer

  • throws: Swift_Connection_Exception If the buffer cannot be read
string read ()
setExtension (line 52)

Add an extension which is available on this connection

void setExtension (string $name, [array $list = array()])
  • string $name: The name of the extension
  • array $list: The list of attributes for the extension
start (line 24)

Try to start the connection

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

Try to stop the connection

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

Write a command to the buffer

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

Documentation generated on Tue, 06 Mar 2007 23:32:22 +0000 by phpDocumentor 1.3.1