Inheritance diagram for Swift_Mime_SimpleMessage:

Public Member Functions
	__construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, $charset=null)

	__toString ()

	addBcc ($address, $name=null)

	addCc ($address, $name=null)

	addFrom ($address, $name=null)

	addReplyTo ($address, $name=null)

	addTo ($address, $name=null)

	attach (Swift_Mime_MimeEntity $entity)

	detach (Swift_Mime_MimeEntity $entity)

	embed (Swift_Mime_MimeEntity $entity)

	getBcc ()

	getCc ()

	getDate ()

	getFrom ()

	getNestingLevel ()

	getPriority ()

	getReadReceiptTo ()

	getReplyTo ()

	getReturnPath ()

	getSender ()

	getSubject ()

	getTo ()

	setBcc ($addresses, $name=null)

	setCc ($addresses, $name=null)

	setDate ($date)

	setFrom ($addresses, $name=null)

	setPriority ($priority)

	setReadReceiptTo ($addresses)

	setReplyTo ($addresses, $name=null)

	setReturnPath ($address)

	setSender ($address, $name=null)

	setSubject ($subject)

	setTo ($addresses, $name=null)

	toByteStream (Swift_InputByteStream $is)

	toString ()

Public Member Functions inherited from Swift_Mime_MimePart
	__construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, $charset=null)

	charsetChanged ($charset)

	getCharset ()

	getDelSp ()

	getFormat ()

	getNestingLevel ()

	setBody ($body, $contentType=null, $charset=null)

	setCharset ($charset)

	setDelSp ($delsp=true)

	setFormat ($format)

Public Member Functions inherited from Swift_Mime_SimpleMimeEntity
	__construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache)

	__destruct ()

	__toString ()

	charsetChanged ($charset)

	encoderChanged (Swift_Mime_ContentEncoder $encoder)

	generateId ()

	getBody ()

	getBoundary ()

	getChildren ()

	getContentType ()

	getDescription ()

	getEncoder ()

	getHeaders ()

	getId ()

	getMaxLineLength ()

	getNestingLevel ()

	setBody ($body, $contentType=null)

	setBoundary ($boundary)

	setChildren (array $children, $compoundLevel=null)

	setContentType ($type)

	setDescription ($description)

	setEncoder (Swift_Mime_ContentEncoder $encoder)

	setId ($id)

	setMaxLineLength ($length)

	toByteStream (Swift_InputByteStream $is)

	toString ()

Public Member Functions inherited from Swift_Mime_MimeEntity
	setChildren (array $children)

Public Member Functions inherited from Swift_Mime_Message
	generateId ()

Protected Member Functions
	_getIdField ()

Protected Member Functions inherited from Swift_Mime_MimePart
	_fixHeaders ()

	_setNestingLevel ($level)

Protected Member Functions inherited from Swift_Mime_SimpleMimeEntity
	_clearCache ()

	_fixHeaders ()

	_getCache ()

	_getHeaderFieldModel ($field)

	_getHeaderParameter ($field, $parameter)

	_getIdField ()

	_setHeaderFieldModel ($field, $model)

	_setHeaderParameter ($field, $parameter, $value)

	getRandomId ()

Private Member Functions
	_becomeMimePart ()

	_getTopNestingLevel ()

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

Protected Attributes inherited from Swift_Mime_MimePart
	$_userCharset

	$_userDelSp

	$_userFormat

Detailed Description

Definition at line 23 of file SimpleMessage.php.

Constructor & Destructor Documentation

Swift_Mime_SimpleMessage::__construct	(	Swift_Mime_HeaderSet	$headers,
		Swift_Mime_ContentEncoder	$encoder,
		Swift_KeyCache	$cache,
			$charset = `null`
	)

Create a new SimpleMessage with $headers, $encoder and $cache.

Parameters

Swift_Mime_HeaderSet	$headers
Swift_Mime_ContentEncoder	$encoder
Swift_KeyCache	$cache
string	$charset

Definition at line 34 of file SimpleMessage.php.

References __construct(), Swift_Mime_MimeEntity\getHeaders(), Swift_Mime_MimeEntity\getId(), setDate(), and Swift_Mime_SimpleMimeEntity\setId().

Here is the call graph for this function:

Member Function Documentation

Swift_Mime_SimpleMessage::__toString ( )

Returns a string representation of this object.

Returns: string

See Also: toString()

Definition at line 547 of file SimpleMessage.php.

References toString().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::_becomeMimePart ( )

private

Turn the body of this message into a child of itself if needed

Definition at line 581 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getCache(), _getTopNestingLevel(), Swift_Mime_MimeEntity\getBody(), Swift_Mime_SimpleMimeEntity\getEncoder(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by toByteStream(), and toString().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::_getIdField ( )

protected

See Also: Swift_Mime_SimpleMimeEntity::_getIdField()

Definition at line 573 of file SimpleMessage.php.

Swift_Mime_SimpleMessage::_getTopNestingLevel ( )

private

Get the highest nesting level nested inside this message

Definition at line 595 of file SimpleMessage.php.

References Swift_Mime_MimeEntity\getChildren(), and getNestingLevel().

Referenced by _becomeMimePart().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::addBcc	(	$address,
		$name = `null`
	)

Add a Bcc: address to this message.

If $name is passed this name will be associated with the address.

Parameters

string	$address
string	$name	optional

Definition at line 372 of file SimpleMessage.php.

References getBcc(), and setBcc().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::addCc	(	$address,
		$name = `null`
	)

Add a Cc: address to this message.

If $name is passed this name will be associated with the address.

Parameters

string	$address
string	$name	optional

Definition at line 324 of file SimpleMessage.php.

References getCc(), and setCc().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::addFrom	(	$address,
		$name = `null`
	)

Add a From: address to this message.

If $name is passed this name will be associated with the address.

Parameters

string	$address
string	$name	optional

Definition at line 174 of file SimpleMessage.php.

References getFrom(), and setFrom().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::addReplyTo	(	$address,
		$name = `null`
	)

Add a Reply-To: address to this message.

If $name is passed this name will be associated with the address.

Parameters

string	$address
string	$name	optional

Definition at line 224 of file SimpleMessage.php.

References getReplyTo(), and setReplyTo().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::addTo	(	$address,
		$name = `null`
	)

Add a To: address to this message.

If $name is passed this name will be associated with the address.

Parameters

string	$address
string	$name	optional

Definition at line 274 of file SimpleMessage.php.

References getTo(), and setTo().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::attach ( Swift_Mime_MimeEntity $entity )

Attach a Swift_Mime_MimeEntity such as an Attachment or MimePart.

Parameters

Swift_Mime_MimeEntity $entity

Definition at line 485 of file SimpleMessage.php.

References Swift_Mime_MimeEntity\getChildren(), and Swift_Mime_MimeEntity\setChildren().

Referenced by Swift_Message\addPart(), and embed().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::detach ( Swift_Mime_MimeEntity $entity )

Remove an already attached entity.

Parameters

Swift_Mime_MimeEntity $entity

Definition at line 495 of file SimpleMessage.php.

References Swift_Mime_MimeEntity\getChildren(), and Swift_Mime_MimeEntity\setChildren().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::embed ( Swift_Mime_MimeEntity $entity )

Attach a Swift_Mime_MimeEntity and return it's CID source. This method should be used when embedding images or other data in a message.

Parameters

Swift_Mime_MimeEntity $entity

Returns: string

Definition at line 515 of file SimpleMessage.php.

References attach(), and Swift_Mime_MimeEntity\getId().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getBcc ( )

Get the Bcc addresses of this message.

Returns: array

Implements Swift_Mime_Message.

Definition at line 407 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Referenced by addBcc().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::getCc ( )

Get the Cc address of this message.

Returns: array

Implements Swift_Mime_Message.

Definition at line 359 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Referenced by addCc().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::getDate ( )

Get the date at which this message was created.

Returns: int

Implements Swift_Mime_Message.

Definition at line 110 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getFrom ( )

Get the from address of this message.

Returns: string

Implements Swift_Mime_Message.

Definition at line 211 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Referenced by addFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::getNestingLevel ( )

Always returns LEVEL_TOP for a message instance.

Returns: int

Implements Swift_Mime_MimeEntity.

Definition at line 66 of file SimpleMessage.php.

Referenced by _getTopNestingLevel().

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::getPriority ( )

Get the priority of this message. The returned value is an integer where 1 is the highest priority and 5 is the lowest.

Returns: int

Definition at line 450 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getReadReceiptTo ( )

Get the addresses to which a read-receipt will be sent.

Returns: string

Definition at line 476 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getReplyTo ( )

Get the reply-to address of this message.

Returns: string

Implements Swift_Mime_Message.

Definition at line 261 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Referenced by addReplyTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::getReturnPath ( )

Get the return-path (bounce address) of this message.

Returns: string

Implements Swift_Mime_Message.

Definition at line 132 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getSender ( )

Get the sender of this message.

Returns: string

Implements Swift_Mime_Message.

Definition at line 161 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getSubject ( )

Get the subject of this message.

Returns: string

Implements Swift_Mime_Message.

Definition at line 88 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::getTo ( )

Get the To addresses of this message.

Returns: array

Implements Swift_Mime_Message.

Definition at line 311 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_getHeaderFieldModel().

Referenced by addTo().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the Bcc addresses of this message.

If $name is passed and the first parameter is a string, this name will be associated with the address.

Parameters

array	$addresses
string	$name	optional

Implements Swift_Mime_Message.

Definition at line 388 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by addBcc().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the Cc addresses of this message.

If $name is passed and the first parameter is a string, this name will be associated with the address.

Parameters

array	$addresses
string	$name	optional

Implements Swift_Mime_Message.

Definition at line 340 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by addCc().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::setDate ( $date )

Set the date at which this message was created.

Parameters

int $date

Implements Swift_Mime_Message.

Definition at line 97 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the from address of this message.

You may pass an array of addresses if this message is from multiple people.

If $name is passed and the first parameter is a string, this name will be associated with the address.

Parameters

string	$addresses
string	$name	optional

Implements Swift_Mime_Message.

Definition at line 192 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by addFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::setPriority ( $priority )

Set the priority of this message. The value is an integer where 1 is the highest priority and 5 is the lowest.

Parameters

int $priority

Definition at line 417 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), elseif(), and Swift_Mime_MimeEntity\getHeaders().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::setReadReceiptTo ( $addresses )

Ask for a delivery receipt from the recipient to be sent to $addresses

Parameters

array $addresses

Definition at line 462 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Here is the call graph for this function:

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

Set the reply-to address of this message.

You may pass an array of addresses if replies will go to multiple people.

If $name is passed and the first parameter is a string, this name will be associated with the address.

Parameters

string	$addresses
string	$name	optional

Implements Swift_Mime_Message.

Definition at line 242 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by addReplyTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::setReturnPath ( $address )

Set the return-path (the bounce address) of this message.

Parameters

string $address

Implements Swift_Mime_Message.

Definition at line 119 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Here is the call graph for this function:

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

Set the sender of this message. This does not override the From field, but it has a higher significance.

Parameters

string	$sender
string	$name	optional

Implements Swift_Mime_Message.

Definition at line 143 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::setSubject ( $subject )

Set the subject of this message.

Parameters

string $subject

Implements Swift_Mime_Message.

Definition at line 75 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by Swift_Message\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set the to addresses of this message.

If multiple recipients will receive the message and array should be used.

If $name is passed and the first parameter is a string, this name will be associated with the address.

Parameters

array	$addresses
string	$name	optional

Implements Swift_Mime_Message.

Definition at line 292 of file SimpleMessage.php.

References Swift_Mime_SimpleMimeEntity\_setHeaderFieldModel(), and Swift_Mime_MimeEntity\getHeaders().

Referenced by addTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Mime_SimpleMessage::toByteStream ( Swift_InputByteStream $is )

Write this message to a Swift_InputByteStream.

Parameters

Swift_InputByteStream $is

Implements Swift_Mime_MimeEntity.

Definition at line 556 of file SimpleMessage.php.

References _becomeMimePart(), Swift_Mime_MimeEntity\getBody(), Swift_Mime_MimeEntity\getChildren(), and Swift_Mime_MimeEntity\setChildren().

Here is the call graph for this function:

Swift_Mime_SimpleMessage::toString ( )

Get this message as a complete string.

Returns: string

Implements Swift_Mime_MimeEntity.

Definition at line 525 of file SimpleMessage.php.

References _becomeMimePart(), Swift_Mime_MimeEntity\getBody(), Swift_Mime_MimeEntity\getChildren(), and Swift_Mime_MimeEntity\setChildren().

Referenced by __toString().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation