Class: Swift_Mime_MimePart

Source Location: /vendors/swift/classes/Swift/Mime/MimePart.php

Class Overview

Swift_Mime_SimpleMimeEntity
   |
   --Swift_Mime_MimePart

A MIME part, in a multipart message.

Author(s):

Chris Corbyn

Variables

Methods

Child classes:

Swift_MimePart: A MIME part, in a multipart message.

Swift_Mime_SimpleMessage: The default email message class.

Inherited Variables

Class: Swift_Mime_SimpleMimeEntity

Swift_Mime_SimpleMimeEntity::$_userContentType

Inherited Methods

Class: Swift_Mime_SimpleMimeEntity

Swift_Mime_SimpleMimeEntity::__construct(): Create a new SimpleMimeEntity with $headers, $encoder and $cache.
Swift_Mime_SimpleMimeEntity::charsetChanged(): Receive notification that the charset of this entity, or a parent entity has changed.
Swift_Mime_SimpleMimeEntity::encoderChanged(): Receive notification that the encoder of this entity or a parent entity has changed.
Swift_Mime_SimpleMimeEntity::generateId(): Generate a new Content-ID or Message-ID for this MIME entity.
Swift_Mime_SimpleMimeEntity::getBody(): Get the body of this entity as a string.
Swift_Mime_SimpleMimeEntity::getBoundary(): Get the boundary used to separate children in this entity.
Swift_Mime_SimpleMimeEntity::getChildren(): Get all children added to this entity.
Swift_Mime_SimpleMimeEntity::getContentType(): Get the Content-type of this entity.
Swift_Mime_SimpleMimeEntity::getDescription(): Get the description of this entity.
Swift_Mime_SimpleMimeEntity::getEncoder(): Get the encoder used for the body of this entity.
Swift_Mime_SimpleMimeEntity::getHeaders(): Get the Swift_Mime_HeaderSet for this entity.
Swift_Mime_SimpleMimeEntity::getId(): Get the CID of this entity.
Swift_Mime_SimpleMimeEntity::getMaxLineLength(): Get the maximum line length of the body of this entity.
Swift_Mime_SimpleMimeEntity::getNestingLevel(): Get the nesting level of this entity.
Swift_Mime_SimpleMimeEntity::getRandomId(): Returns a random Content-ID or Message-ID.
Swift_Mime_SimpleMimeEntity::setBody(): Set the body of this entity, either as a string, or as an instance of Swift_OutputByteStream.
Swift_Mime_SimpleMimeEntity::setBoundary(): Set the boundary used to separate children in this entity.
Swift_Mime_SimpleMimeEntity::setChildren(): Set all children of this entity.
Swift_Mime_SimpleMimeEntity::setContentType(): Set the Content-type of this entity.
Swift_Mime_SimpleMimeEntity::setDescription(): Set the description of this entity.
Swift_Mime_SimpleMimeEntity::setEncoder(): Set the encoder used for the body of this entity.
Swift_Mime_SimpleMimeEntity::setId(): Set the CID of this entity.
Swift_Mime_SimpleMimeEntity::setMaxLineLength(): Set the maximum line length of lines in this body.
Swift_Mime_SimpleMimeEntity::toByteStream(): Write this entire entity to a Swift_InputByteStream.
Swift_Mime_SimpleMimeEntity::toString(): Get this entire entity as a string.
Swift_Mime_SimpleMimeEntity::_clearCache(): Empty the KeyCache for this entity.
Swift_Mime_SimpleMimeEntity::_fixHeaders(): Re-evaluate what content type and encoding should be used on this entity.
Swift_Mime_SimpleMimeEntity::_getCache(): Get the KeyCache used in this entity.
Swift_Mime_SimpleMimeEntity::_getHeaderFieldModel(): Get the model data (usually an array or a string) for $field.
Swift_Mime_SimpleMimeEntity::_getHeaderParameter(): Get the parameter value of $parameter on $field header.
Swift_Mime_SimpleMimeEntity::_getIdField(): Get the name of the header that provides the ID of this entity
Swift_Mime_SimpleMimeEntity::_setHeaderFieldModel(): Set the model data for $field.
Swift_Mime_SimpleMimeEntity::_setHeaderParameter(): Set the parameter value of $parameter on $field header.
Swift_Mime_SimpleMimeEntity::__destruct(): Empties it's own contents from the cache.
Swift_Mime_SimpleMimeEntity::__toString(): Returns a string representation of this object.

Class Details

[line 23]
A MIME part, in a multipart message.

Tags:

author:	Chris Corbyn
filesource:	Source Code for this file

[ Top ]

Class Variables

$_userCharset =

[line 30]

The charset last specified by the user

Tags:

access:

protected

Type:

mixed

[ Top ]

$_userDelSp =

[line 33]

The delsp parameter last specified by the user

Tags:

access:

protected

Type:

mixed

[ Top ]

$_userFormat =

[line 27]

The format parameter last specified by the user

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 46]

Swift_Mime_MimePart __construct(
Swift_Mime_HeaderSet
$headers, Swift_Mime_ContentEncoder
$encoder, Swift_KeyCache
$cache, [string
$charset = null])

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

Parameters:

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

[ Top ]

method charsetChanged [line 165]

void charsetChanged(
string
$charset)

Receive notification that the charset has changed on this document, or a parent document.

Tags:

access:

public

Overrides Swift_Mime_SimpleMimeEntity::charsetChanged() (Receive notification that the charset of this entity, or a parent entity has changed.)

Parameters:

string

$charset

[ Top ]

method getCharset [line 80]

string getCharset(
)

Get the character set of this entity.

Tags:

access:

public

[ Top ]

method getDelSp [line 129]

boolean getDelSp(
)

Test if delsp is being used for this entity.

Tags:

access:

public

[ Top ]

method getFormat [line 107]

string getFormat(
)

Get the format of this entity (i.e. flowed or fixed).

Tags:

access:

public

[ Top ]

method getNestingLevel [line 154]

int getNestingLevel(
)

Get the nesting level of this entity.

Tags:

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

Overridden in child classes as:

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

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

[ Top ]

method setBody [line 65]

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

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

Tags:

access:

public

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

Parameters:

mixed	$body
string	$contentType	optional
string	$charset	optional

[ Top ]

method setCharset [line 90]

void setCharset(
string
$charset)

Set the character set of this entity.

Tags:

access:

public

Parameters:

string

$charset

[ Top ]

method setDelSp [line 141]

void setDelSp(
[boolean
$delsp = true])

Turn delsp on or off for this entity.

Tags:

access:

public

Parameters:

boolean

$delsp

[ Top ]

method setFormat [line 117]

void setFormat(
string
$format)

Set the format of this entity (flowed or fixed).

Tags:

access:

public

Parameters:

string

$format

[ Top ]

method _fixHeaders [line 173]

void _fixHeaders(
)

Fix the content-type and encoding of this entity

Tags:

access:

protected

Overrides Swift_Mime_SimpleMimeEntity::_fixHeaders() (Re-evaluate what content type and encoding should be used on this entity.)

[ Top ]

method _setNestingLevel [line 191]

void _setNestingLevel(

$level)

Set the nesting level of this entity

Tags:

access:

protected

Parameters:

$level

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:33:46 -0500 by phpDocumentor 1.4.3