Docs For Class Deliver

Description

Delivers messages using the sendmail binary

author: Marc Groot Koerkamp

Located in /class/deliver/Deliver_SendMail.class.php (line 25)

Deliver
   |
   --Deliver_SendMail

Variable Summary

string $sendmail_args

string $sendmail_command

Method Summary

void Deliver_SendMail ([array $params = array()])

void __construct ([array $params = array()])

boolean finalizeStream (resource $stream)

resource initStream (Message $message, string $sendmail_path, [ $ignore_1 = 0], [ $ignore_2 = ''], [ $ignore_3 = ''], [ $ignore_4 = ''], [ $ignore_5 = ''], [ $ignore_6 = false], [ $ignore_7 = ''], [ $ignore_8 = array()], mixed $ignore_x)

Variables

string $sendmail_args = '-i -t' (line 39)

Extra sendmail arguments

Parameter can be set in class constructor function.

WARNING: Introduction of this parameter broke backwards compatibility with workarounds specific to qmail-inject.

If parameter needs some security modifications, it should be set to private in PHP 5+ in order to prevent uncontrolled access.

since: 1.5.1

string $sendmail_command = '' (line 47)

Stores used sendmail command Private variable that is used to inform about used sendmail command.

since: 1.5.1

Methods

Constructor Deliver_SendMail (line 72)

Constructor (PHP4 style, kept for compatibility reasons)

since: 1.5.1

void Deliver_SendMail ([array $params = array()])

array $params: configuration options. array key = option name, array value = option value.

Constructor __construct (line 56)

Constructor (PHP5 style, required in some future version of PHP)

since: 1.5.1

void __construct ([array $params = array()])

array $params: configuration options. array key = option name, array value = option value.

finalizeStream (line 123)

Closes process handle.

access: public

boolean finalizeStream (resource $stream)

resource $stream

initStream (line 105)

function initStream

Initialise the sendmail connection.

access: public

resource initStream (Message $message, string $sendmail_path, [ $ignore_1 = 0], [ $ignore_2 = ''], [ $ignore_3 = ''], [ $ignore_4 = ''], [ $ignore_5 = ''], [ $ignore_6 = false], [ $ignore_7 = ''], [ $ignore_8 = array()], mixed $ignore_x)

Message $message: Message object containing the from address
string $sendmail_path: Location of sendmail binary
mixed $ignore_x: Eight extra arguments that the parent class requires which are not used here
$ignore_1
$ignore_2
$ignore_3
$ignore_4
$ignore_5
$ignore_6
$ignore_7
$ignore_8

Redefinition of:

Deliver::initStream(): function initStream - reserved for extended functionality

Inherited Methods

Inherited From Deliver

Deliver::calculate_references()
Deliver::clean_crlf()
Deliver::foldLine()
Deliver::getBCC()
Deliver::initStream()
Deliver::ip2hex()
Deliver::mail()
Deliver::mimeBoundary()
Deliver::prepareMIME_Header()
Deliver::prepareRFC822_Header()
Deliver::preWriteToStream()
Deliver::send_mail()
Deliver::strip_crlf()
Deliver::timezone()
Deliver::writeBody()
Deliver::writeBodyPart()
Deliver::writeToStream()

Class Deliver_SendMail

Inherited Methods