Class Swift_Connection_NativeMail

Description

Swift mail() Connection NOTE: This class is nothing more than a stub. The MailSend plugin does the actual sending.

Located in /Swift/Connection/NativeMail.php (line 21)

Swift_ConnectionBase
   |
   --Swift_Connection_NativeMail
Variable Summary
Method Summary
Swift_Connection_NativeMail __construct ([string $additional_params = "-oi -f %s"])
boolean isAlive ()
void postConnect ( $instance)
string read ()
void setAdditionalMailParams (string $params)
void setResponse (string $int)
void start ()
void stop ()
void write (string $command, [ $end = "\r\n"])
Variables
Swift_Plugin_MailSend $plugin = null (line 37)

An instance of the MailSend plugin.

  • access: protected
string $pluginParams (line 32)

The 5th parameter in mail() is a sprintf() formatted string.

  • access: protected
string $response = "220 Stubbed" (line 27)

The response the stub will be giving next

  • var: Response
  • access: protected

Inherited Variables

Inherited from Swift_ConnectionBase

Swift_ConnectionBase::$extensions
Swift_ConnectionBase::$isESMTP
Methods
Constructor __construct (line 43)

Ctor.

  • access: public
Swift_Connection_NativeMail __construct ([string $additional_params = "-oi -f %s"])
  • string $additional_params: The 5th parameter in mail() as a sprintf() formatted string where %s is the sender address. This only comes into effect if safe_mode is OFF.
getAdditionalMailParams (line 72)

Get the 5th parameter in mail() as a sprintf() formatted string.

  • access: public
string getAdditionalMailParams ()
isAlive (line 132)

Check if the process is still alive

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

Sets the MailSend plugin in Swift once Swift has connected

  • access: public
void postConnect ( $instance)
  • Swift $instance: The current instance of Swift

Redefinition of:
Swift_ConnectionBase::postConnect()
Execute any needed logic after connecting and handshaking
read (line 81)

Read a full response from the buffer (this is spoofed if running in -t mode)

  • access: public
  • throws: Swift_ConnectionException Upon failure to read
string read ()
setAdditionalMailParams (line 60)

Set the 5th parameter in mail() as a sprintf() formatted string. Only used if safe_mode is off.

  • access: public
void setAdditionalMailParams (string $params)
  • string $params
setResponse (line 89)

Set the response this stub will return

  • access: public
void setResponse (string $int)
  • string $int: The response to send
start (line 116)

Try to start the connection

  • access: public
  • throws: Swift_ConnectionException Upon failure to start
void start ()
stop (line 124)

Try to close the connection

  • access: public
  • throws: Swift_ConnectionException Upon failure to close
void stop ()
write (line 98)

Write a command to the process (leave off trailing CRLF)

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

Inherited Methods

Inherited From Swift_ConnectionBase

Swift_ConnectionBase::getAttributes()
Swift_ConnectionBase::getRequiresEHLO()
Swift_ConnectionBase::hasExtension()
Swift_ConnectionBase::postConnect()
Swift_ConnectionBase::setExtension()
Swift_ConnectionBase::setRequiresEHLO()

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