Docs For Class Swift_Mime_SimpleMimeEntity

Swift_Mime_SimpleMimeEntity __construct(
Swift_Mime_HeaderSet
$headers, Swift_Mime_ContentEncoder
$encoder, Swift_KeyCache
$cache)

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

Tags:

access:

public

Overridden in child classes as:

Swift_Mime_MimePart::__construct(): Create a new MimePart with $headers, $encoder and $cache.

Swift_MimePart::__construct(): Create a new MimePart.

Swift_Mime_SimpleMessage::__construct(): Create a new SimpleMessage with $headers, $encoder and $cache.

Swift_Message::__construct(): Create a new Message.

Swift_Mime_Attachment::__construct(): Create a new Attachment with $headers, $encoder and $cache.

Swift_Attachment::__construct(): Create a new Attachment.

Swift_Mime_EmbeddedFile::__construct(): Creates a new Attachment with $headers and $encoder.

Swift_EmbeddedFile::__construct(): Create a new EmbeddedFile.

Swift_Image::__construct(): Create a new EmbeddedFile.

Parameters:

Swift_Mime_HeaderSet	$headers
Swift_Mime_ContentEncoder	$encoder
Swift_KeyCache	$cache

[ Top ]

void __destruct(
)

Empties it's own contents from the cache.

Tags:

access:

public

[ Top ]

void charsetChanged(
string
$charset)

Receive notification that the charset of this entity, or a parent entity has changed.

Tags:

access:

public

Overridden in child classes as:

Swift_Mime_MimePart::charsetChanged(): Receive notification that the charset has changed on this document, or a parent document.

Implementation of:

Swift_Mime_CharsetObserver::charsetChanged(): Notify this observer that the entity's charset has changed.

Parameters:

string

$charset

[ Top ]

void encoderChanged(
Swift_Mime_ContentEncoder
$encoder)

Receive notification that the encoder of this entity or a parent entity has changed.

Tags:

access:

public

Parameters:

Swift_Mime_ContentEncoder

$encoder

[ Top ]

string generateId(
)

Generate a new Content-ID or Message-ID for this MIME entity.

Tags:

access:

public

[ Top ]

string getBody(
)

Get the body of this entity as a string.

Tags:

access:

public

Implementation of:

Swift_Mime_MimeEntity::getBody(): Get the body content of this entity as a string.

[ Top ]

string getBoundary(
)

Get the boundary used to separate children in this entity.

Tags:

access:

public

[ Top ]

array getChildren(
)

Get all children added to this entity.

Tags:

return:	of Swift_Mime_Entity
access:	public

Implementation of:

Swift_Mime_MimeEntity::getChildren(): Get all children nested inside this entity.

[ Top ]

string getContentType(
)

Get the Content-type of this entity.

Tags:

access:

public

Implementation of:

Swift_Mime_MimeEntity::getContentType(): Get the qualified content-type of this mime entity.

[ Top ]

string getDescription(
)

Get the description of this entity.

This value comes from the Content-Description header if set.

Tags:

access:

public

[ Top ]

Swift_Mime_ContentEncoder getEncoder(
)

Get the encoder used for the body of this entity.

Tags:

access:

public

[ Top ]

Swift_Mime_HeaderSet getHeaders(
)

Get the Swift_Mime_HeaderSet for this entity.

Tags:

access:

public

Implementation of:

Swift_Mime_MimeEntity::getHeaders(): Get the collection of Headers in this Mime entity.

[ Top ]

string getId(
)

Get the CID of this entity.

The CID will only be present in headers if a Content-ID header is present.

Tags:

access:

public

Implementation of:

Swift_Mime_MimeEntity::getId(): Returns a unique ID for this entity.

[ Top ]

int getMaxLineLength(
)

Get the maximum line length of the body of this entity.

Tags:

access:

public

[ Top ]

int getNestingLevel(
)

Get the nesting level of this entity.

Tags:

see:	LEVEL_TOP, LEVEL_MIXED, LEVEL_RELATED, LEVEL_ALTERNATIVE
access:	public

Overridden in child classes as:

Swift_Mime_MimePart::getNestingLevel(): Get the nesting level of this entity.

Swift_Mime_SimpleMessage::getNestingLevel(): Always returns LEVEL_TOP for a message instance.

Swift_Mime_Attachment::getNestingLevel(): Get the nesting level used for this attachment.

Swift_Mime_EmbeddedFile::getNestingLevel(): Get the nesting level of this EmbeddedFile.

Implementation of:

Swift_Mime_MimeEntity::getNestingLevel(): Get the level at which this entity shall be nested in final document.

[ Top ]

string getRandomId(
)

Returns a random Content-ID or Message-ID.

Tags:

access:

protected

[ Top ]

void setBody(
mixed
$body, [string
$contentType = null])

Set the body of this entity, either as a string, or as an instance of Swift_OutputByteStream.

Tags:

access:

public

Overridden in child classes as:

Swift_Mime_MimePart::setBody(): Set the body of this entity, either as a string, or as an instance of Swift_OutputByteStream.

Implementation of:

Swift_Mime_MimeEntity::setBody(): Set the body content of this entity as a string.

Parameters:

mixed	$body
string	$contentType	optional

[ Top ]

void setBoundary(
string
$boundary)

Set the boundary used to separate children in this entity.

Tags:

throws:	Swift_RfcComplianceException
access:	public

Parameters:

string

$boundary

[ Top ]

void setChildren(

$children, [int
$compoundLevel = null])

Set all children of this entity.

Tags:

access:

public

Implementation of:

Swift_Mime_MimeEntity::setChildren(): Set all children nested inside this entity.

Parameters:

array	$children	Swiift_Mime_Entity instances
int	$compoundLevel	For internal use only

[ Top ]

void setContentType(
string
$type)

Set the Content-type of this entity.

Tags:

access:

public

Parameters:

string

$type

[ Top ]

void setDescription(
string
$description)

Set the description of this entity.

This method sets a value in the Content-ID header.

Tags:

access:

public

Parameters:

string

$description

[ Top ]

void setEncoder(
Swift_Mime_ContentEncoder
$encoder)

Set the encoder used for the body of this entity.

Tags:

access:

public

Parameters:

Swift_Mime_ContentEncoder

$encoder

[ Top ]

void setId(
string
$id)

Set the CID of this entity.

Tags:

access:

public

Parameters:

string

$id

[ Top ]

void setMaxLineLength(
int
$length)

Set the maximum line length of lines in this body.

Though not enforced by the library, lines should not exceed 1000 chars.

Tags:

access:

public

Parameters:

int

$length

[ Top ]

void toByteStream(
Swift_InputByteStream
$is)

Write this entire entity to a Swift_InputByteStream.

Tags:

access:

public

Overridden in child classes as:

Swift_Mime_SimpleMessage::toByteStream(): Write this message to a Swift_InputByteStream.

Implementation of:

Swift_Mime_MimeEntity::toByteStream(): Get this entire entity as a ByteStream.

Parameters:

Swift_InputByteStream

$is

[ Top ]

string toString(
)

Get this entire entity as a string.

Tags:

access:

public

Overridden in child classes as:

Swift_Mime_SimpleMessage::toString(): Get this message as a complete string.

Implementation of:

Swift_Mime_MimeEntity::toString(): Get this entire entity in its string form.

[ Top ]

void _clearCache(
)

Empty the KeyCache for this entity.

Tags:

access:

protected

[ Top ]

void _fixHeaders(
)

Re-evaluate what content type and encoding should be used on this entity.

Tags:

access:

protected

Overridden in child classes as:

Swift_Mime_MimePart::_fixHeaders(): Fix the content-type and encoding of this entity

[ Top ]

void _getCache(
)

Get the KeyCache used in this entity.

Tags:

access:

protected

[ Top ]

void _getHeaderFieldModel(

$field)

Get the model data (usually an array or a string) for $field.

Tags:

access:

protected

Parameters:

$field

[ Top ]

void _getHeaderParameter(

$field, 
$parameter)

Get the parameter value of $parameter on $field header.

Tags:

access:

protected

Parameters:

	$field
	$parameter

[ Top ]

void _getIdField(
)

Get the name of the header that provides the ID of this entity

Tags:

access:

protected

Overridden in child classes as:

Swift_Mime_SimpleMessage::_getIdField()

[ Top ]

void _setHeaderFieldModel(

$field, 
$model)

Set the model data for $field.

Tags:

access:

protected

Parameters:

	$field
	$model

[ Top ]

void _setHeaderParameter(

$field, 
$parameter, 
$value)

Set the parameter value of $parameter on $field header.

Tags:

access:

protected

Parameters:

	$field
	$parameter
	$value

[ Top ]

string __toString(
)

Returns a string representation of this object.

Tags:

see:	Swift_Mime_SimpleMimeEntity::toString()
access:	public

Overridden in child classes as:

Swift_Mime_SimpleMessage::__toString(): Returns a string representation of this object.

[ Top ]

Class: Swift_Mime_SimpleMimeEntity

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$_userContentType =

Tags:

Class Methods

constructor __construct [line 83]

Tags:

Parameters:

destructor __destruct [line 798]

Tags:

method charsetChanged [line 418]

Tags:

Parameters:

method encoderChanged [line 428]

Tags:

Parameters:

method generateId [line 123]

Tags:

method getBody [line 334]

Tags:

method getBoundary [line 392]

Tags:

method getChildren [line 244]

Tags:

method getContentType [line 152]

Tags:

method getDescription [line 201]

Tags:

method getEncoder [line 366]

Tags:

method getHeaders [line 133]

Tags:

method getId [line 175]

Tags:

method getMaxLineLength [line 224]

Tags:

method getNestingLevel [line 143]

Tags:

method getRandomId [line 646]

Tags:

method setBody [line 347]

Tags:

Parameters:

method setBoundary [line 406]

Tags:

Parameters:

method setChildren [line 254]

Tags:

Parameters:

method setContentType [line 161]

Tags:

Parameters:

method setDescription [line 211]

Tags:

Parameters:

method setEncoder [line 375]

Tags:

Parameters:

method setId [line 186]

Tags:

Parameters:

method setMaxLineLength [line 234]

Tags:

Parameters:

method toByteStream [line 487]

Tags:

Parameters:

method toString [line 437]

Tags:

method _clearCache [line 637]

Tags:

method _fixHeaders [line 610]

Tags: