Collaboration diagram for Message:

Public Member Functions
	setFrom ($address)

	setSender ($address)

	getTo ()

	getCC ()

	getBCC ()

	getFrom ()

	addTo ($address)

	resetTo ()

	addCc ($address)

	resetCc ()

	addBcc ($address)

	resetBcc ()

	setSubject ($subject)

	setBody (Body &$body)

	addBodyRelatedAttachment (RelatedAttachment &$attachment)

	resetBodyRelatedAttachment ()

	setAltBody (Body &$body)

	addAttachment (Attachment &$attachment)

	resetAttachment ()

	send ()

Data Fields
const	className = __CLASS__

	$from = null

	$sender = null

	$to = array()

	$cc = array()

	$bcc = array()

	$subject = ''

	$body = null

	$bodyRelated = array()

	$altBody = null

	$attachments = array()

Protected Member Functions
	addressesToString (array $tAddresses)

Detailed Description

Definition at line 44 of file Class.Message.php.

Member Function Documentation

addAttachment ( Attachment & $attachment )

Add attachments.

Parameters

Attachment $attachment

Definition at line 302 of file Class.Message.php.

addBcc ( $address )

Add 'Bcc:' recipients.

Parameters

Address | string $address

Definition at line 237 of file Class.Message.php.

addBodyRelatedAttachment ( RelatedAttachment & $attachment )

Add an attachment related to the body (with the use of cid:xxx URLs).

Parameters

RelatedAttachment $attachment

Definition at line 277 of file Class.Message.php.

addCc ( $address )

Add 'Cc:' recipients.

Parameters

Address | string $address

Definition at line 215 of file Class.Message.php.

addressesToString ( array $tAddresses )

protected

Parameters

Address[] $tAddresses

Returns: string

Definition at line 174 of file Class.Message.php.

addTo ( $address )

Add 'To:' recipients.

Parameters

Address | string $address

Definition at line 193 of file Class.Message.php.

getBCC ( )

Get Bcc email addresses

Returns: string

Definition at line 159 of file Class.Message.php.

Here is the call graph for this function:

getCC ( )

Get Cc email addresses

Returns: string

Definition at line 152 of file Class.Message.php.

Here is the call graph for this function:

getFrom ( )

Get From email address

Returns: string

Definition at line 166 of file Class.Message.php.

Here is the call graph for this function:

getTo ( )

Get To email addresses

Returns: string

Definition at line 144 of file Class.Message.php.

Here is the call graph for this function:

resetAttachment ( )

Reset list of attachments.

Definition at line 309 of file Class.Message.php.

resetBcc ( )

Reset list of 'Bcc:' recipients.

Definition at line 250 of file Class.Message.php.

resetBodyRelatedAttachment ( )

Reset list of body's related attachments.

Definition at line 284 of file Class.Message.php.

resetCc ( )

Reset list of 'Cc:' recipients.

Definition at line 228 of file Class.Message.php.

resetTo ( )

Reset list of 'To:' recipients

Definition at line 206 of file Class.Message.php.

send ( )

Send the message

Returns: string error message on failure or empty string if successful

Definition at line 318 of file Class.Message.php.

setAltBody ( Body & $body )

Set alternate body (e.g. plain text view of a main HTML body).

Parameters

Body $body

Definition at line 293 of file Class.Message.php.

setBody ( Body & $body )

Set main mail's body.

Parameters

Body $body

Definition at line 268 of file Class.Message.php.

setFrom ( $address )

Set 'From:' address used by the mail's body 'From:' field and the SMTP protocol.

Parameters

Address | string $address

Definition at line 112 of file Class.Message.php.

setSender ( $address )

Set SMTP sender transport address ('MAIL FROM:')

Parameters

Address | string $address

Definition at line 128 of file Class.Message.php.

setSubject ( $subject )

Set mail's 'Subject:' field.

Parameters

$subject

Definition at line 259 of file Class.Message.php.

Field Documentation

$altBody = null

Definition at line 81 of file Class.Message.php.

$attachments = array()

Definition at line 85 of file Class.Message.php.

$bcc = array()

Definition at line 68 of file Class.Message.php.

$body = null

Definition at line 73 of file Class.Message.php.

$bodyRelated = array()

Definition at line 77 of file Class.Message.php.

$cc = array()

Definition at line 64 of file Class.Message.php.

$from = null

Definition at line 50 of file Class.Message.php.

$sender = null

Definition at line 56 of file Class.Message.php.

$subject = ''

Definition at line 69 of file Class.Message.php.

$to = array()

Definition at line 60 of file Class.Message.php.

const className = __CLASS__

Definition at line 46 of file Class.Message.php.

The documentation for this class was generated from the following file:

Class.Message.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

Field Documentation