Inheritance diagram for Swift_Mime_Message:

Public Member Functions
	generateId ()

	getBcc ()

	getCc ()

	getDate ()

	getFrom ()

	getReplyTo ()

	getReturnPath ()

	getSender ()

	getSubject ()

	getTo ()

	setBcc ($addresses, $name=null)

	setCc ($addresses, $name=null)

	setDate ($date)

	setFrom ($addresses, $name=null)

	setReplyTo ($addresses, $name=null)

	setReturnPath ($address)

	setSender ($address, $name=null)

	setSubject ($subject)

	setTo ($addresses, $name=null)

Public Member Functions inherited from Swift_Mime_MimeEntity
	getBody ()

	getChildren ()

	getContentType ()

	getHeaders ()

	getId ()

	getNestingLevel ()

	setBody ($body, $contentType=null)

	setChildren (array $children)

	toByteStream (Swift_InputByteStream $is)

	toString ()

Public Member Functions inherited from Swift_Mime_CharsetObserver
	charsetChanged ($charset)

Public Member Functions inherited from Swift_Mime_EncodingObserver
	encoderChanged (Swift_Mime_ContentEncoder $encoder)

Additional Inherited Members
Public Attributes inherited from Swift_Mime_MimeEntity
const	LEVEL_ALTERNATIVE = 4096

const	LEVEL_MIXED = 256

const	LEVEL_RELATED = 65536

const	LEVEL_TOP = 16

Detailed Description

Definition at line 21 of file Message.php.

Member Function Documentation

Swift_Mime_Message::generateId ( )

Generates a valid Message-ID and switches to it.

Returns: string

Referenced by Swift_Transport_SendmailTransport\send(), Swift_Transport_MailTransport\send(), and Swift_Transport_AbstractSmtpTransport\send().

Here is the caller graph for this function:

Swift_Mime_Message::getBcc ( )

Get the Bcc addresses for this message.

This method always returns an associative array, whereby the keys provide the actual email addresses.

Returns: string[]

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Mailer\batchSend(), Swift_Transport_SendmailTransport\send(), Swift_Transport_MailTransport\send(), and Swift_Transport_AbstractSmtpTransport\send().

Here is the caller graph for this function:

Swift_Mime_Message::getCc ( )

Get the Cc addresses for this message.

This method always returns an associative array, whereby the keys provide the actual email addresses.

Returns: string[]

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Mailer\batchSend(), Swift_Transport_SendmailTransport\send(), Swift_Transport_MailTransport\send(), and Swift_Transport_AbstractSmtpTransport\send().

Here is the caller graph for this function:

Swift_Mime_Message::getDate ( )

Get the origination date of the message as a UNIX timestamp.

Returns: int

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::getFrom ( )

Get the From address(es) of this message.

This method always returns an associative array where the keys are the addresses.

Returns: string[]

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Transport_MailTransport\_getReversePath(), and Swift_Transport_AbstractSmtpTransport\_getReversePath().

Here is the caller graph for this function:

Swift_Mime_Message::getReplyTo ( )

Get the Reply-To addresses for this message.

This method always returns an associative array where the keys provide the email addresses.

Returns: string[]

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::getReturnPath ( )

Get the return-path (bounce-detect) address.

Returns: string

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Transport_MailTransport\_getReversePath(), and Swift_Transport_AbstractSmtpTransport\_getReversePath().

Here is the caller graph for this function:

Swift_Mime_Message::getSender ( )

Get the sender address for this message.

This has a higher significance than the From address.

Returns: string

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Transport_MailTransport\_getReversePath(), and Swift_Transport_AbstractSmtpTransport\_getReversePath().

Here is the caller graph for this function:

Swift_Mime_Message::getSubject ( )

Get the subject of the message.

Returns: string

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::getTo ( )

Get the To addresses for this message.

This method always returns an associative array, whereby the keys provide the actual email addresses.

Returns: string[]

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Mailer\batchSend(), Swift_Transport_SendmailTransport\send(), Swift_Transport_MailTransport\send(), and Swift_Transport_AbstractSmtpTransport\send().

Here is the caller graph for this function:

Swift_Mime_Message::setBcc	(	$addresses,
		$name = `null`
	)

Set the Bcc address(es).

Recipients set in this field will receive a 'blind-carbon-copy' of this message.

In other words, they will get the message, but any other recipients of the message will have no such knowledge of their receipt of it.

This method has the same synopsis as setFrom() and setTo().

Parameters

mixed	$addresses
string	$name	optional

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Transport_AbstractSmtpTransport\_sendBcc(), Swift_Mailer\batchSend(), and Swift_Transport_AbstractSmtpTransport\send().

Here is the caller graph for this function:

Swift_Mime_Message::setCc	(	$addresses,
		$name = `null`
	)

Set the Cc address(es).

Recipients set in this field will receive a 'carbon-copy' of this message.

This method has the same synopsis as setFrom() and setTo().

Parameters

mixed	$addresses
string	$name	optional

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Mailer\batchSend().

Here is the caller graph for this function:

Swift_Mime_Message::setDate ( $date )

Set the origination date of the message as a UNIX timestamp.

Parameters

int $date

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::setFrom	(	$addresses,
		$name = `null`
	)

Set the From address of this message.

It is permissible for multiple From addresses to be set using an array.

If multiple From addresses are used, you SHOULD set the Sender address and according to RFC 2822, MUST set the sender address.

An array can be used if display names are to be provided: i.e. array('email.nosp@m.@add.nosp@m.ress..nosp@m.com' => 'Real Name').

If the second parameter is provided and the first is a string, then $name is associated with the address.

Parameters

mixed	$addresses
string	$name	optional

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::setReplyTo	(	$addresses,
		$name = `null`
	)

Set the Reply-To address(es).

Any replies from the receiver will be sent to this address.

It is permissible for multiple reply-to addresses to be set using an array.

This method has the same synopsis as setFrom() and setTo().

If the second parameter is provided and the first is a string, then $name is associated with the address.

Parameters

mixed	$addresses
string	$name	optional

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::setReturnPath ( $address )

Set the return-path (bounce-detect) address.

Parameters

string $address

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::setSender	(	$address,
		$name = `null`
	)

Set the sender of this message.

If multiple addresses are present in the From field, this SHOULD be set.

According to RFC 2822 it is a requirement when there are multiple From addresses, but Swift itself does not require it directly.

An associative array (with one element!) can be used to provide a display- name: i.e. array('email' => 'Real Name').

If the second parameter is provided and the first is a string, then $name is associated with the address.

Parameters

mixed	$address
string	$name	optional

Implemented in Swift_Mime_SimpleMessage.

Swift_Mime_Message::setSubject ( $subject )

Set the subject of the message.

Parameters

string $subject

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Plugins_DecoratorPlugin\_restoreMessage().

Here is the caller graph for this function:

Swift_Mime_Message::setTo	(	$addresses,
		$name = `null`
	)

Set the To address(es).

Recipients set in this field will receive a copy of this message.

This method has the same synopsis as setFrom() and setCc().

If the second parameter is provided and the first is a string, then $name is associated with the address.

Parameters

mixed	$addresses
string	$name	optional

Implemented in Swift_Mime_SimpleMessage.

Referenced by Swift_Mailer\batchSend().

Here is the caller graph for this function:

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

L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Mime/Message.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation