Class Horde_Kolab_Filter_Transport

Description

Provides a delivery mechanism for a mail message.

$Horde: framework/Kolab_Filter/lib/Horde/Kolab/Filter/Transport.php,v 1.4.2.4 2010/07/15 21:35:39 wrobel Exp $

Copyright 2004-2008 Klarälvdalens Datakonsult AB

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_Filter/lib/Horde/Kolab/Filter/Transport.php (line 22)


	
			
Direct descendents
Class Description
 class Horde_Kolab_Filter_Transport_echo Echos a mail for debugging.
 class Horde_Kolab_Filter_Transport_drop Drops a mail instead of delivering it.
 class Horde_Kolab_Filter_Transport_lda Provides DovecotLDA delivery.
 class Horde_Kolab_Filter_Transport_lmtp Provides LMTP for delivering a mail.
 class Horde_Kolab_Filter_Transport_smtp Provides SMTP for delivering mail.
 class Horde_Kolab_Filter_Transport_stdout Delivers a mail to STDOUT for debugging.
Variable Summary
 boolean $_got_newline
 array $_params
 mixed $_transport
Method Summary
 Horde_Kolab_Filter_Transport Horde_Kolab_Filter_Transport ( $params)
 PEAR_Error createErrorObject (array $reciperrors, [string $msg = null])
 void createTransport ()
 boolean|PEAR_Error data (string $data)
 boolean|PEAR_Error end ()
 Horde_Kolab_Filter_Transport|boolean &factory (string $driver, [array $params = array()])
 void quotedataline ( &$data, string $data)
 PEAR_error rewriteCode (PEAR_error $result)
 boolean|PEAR_Error start (string $sender, array $recips)
Variables
boolean $_got_newline (line 43)

Internal marker to indicate if we received a new line.

array $_params (line 29)

The connection parameters for the transport.

mixed $_transport (line 36)

The transport class delivering the message.

Methods
Constructor Horde_Kolab_Filter_Transport (line 48)

Constructor.

Horde_Kolab_Filter_Transport Horde_Kolab_Filter_Transport ( $params)
  • $params
createErrorObject (line 179)

Encapsulate multiple errors in one.

  • return: The combined error.
PEAR_Error createErrorObject (array $reciperrors, [string $msg = null])
  • array $reciperrors: The errors.
  • string $msg: A combined error message.
createTransport (line 88)

Create the transport class.

void createTransport ()
data (line 234)

Send message data.

  • return: True on success.
boolean|PEAR_Error data (string $data)
  • string $data: The text of the message.
end (line 251)

Finish sending data.

  • return: True on success.
boolean|PEAR_Error end ()
factory (line 71)

Attempts to return a concrete Horde_Kolab_Filter_Transport instance based on $driver.

  • return: The newly created concrete Horde_Kolab_Filter_Transport instance, or false on an error.
Horde_Kolab_Filter_Transport|boolean &factory (string $driver, [array $params = array()])
  • string $driver: The type of the concrete Horde_Kolab_Filter_Transport subclass to return. The class name is based on the Horde_Kolab_Filter_Transport driver ($driver). The code is dynamically included.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
quotedataline (line 204)

Modified implementation from Net_SMTP that supports dotstuffing even when getting the mail line-by line.

void quotedataline ( &$data, string $data)
  • string $data: Mail message data.
  • &$data
rewriteCode (line 282)

Rewrite the code to something postfix can understand.

  • return: An error with a rewritten error code.
PEAR_error rewriteCode (PEAR_error $result)
  • PEAR_error $result: The reponse of the transport.
start (line 100)

Starts transporting the message.

  • return: True on success, a PEAR_Error otherwise.
boolean|PEAR_Error start (string $sender, array $recips)
  • string $sender: The message sender.
  • array $recips: The recipients of the message.

Documentation generated on Sun, 30 Jan 2011 05:22:55 +0000 by phpDocumentor 1.4.3