Class Swift_Mime_SimpleMimeEntity

A MIME entity, in a multipart message.

Swift_Mime_SimpleMimeEntity implements Swift_Mime_MimeEntity

Direct known subclasses

Swift_Mime_Attachment, Swift_Mime_MimePart

Indirect known subclasses

Swift_Attachment, Swift_EmbeddedFile, Swift_Image, Swift_Message, Swift_Mime_EmbeddedFile, Swift_Mime_SimpleMessage, Swift_MimePart

Package: Swift\Mime
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Mime/SimpleMimeEntity.php

Methods summary
`public`	# `__construct( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar )` Create a new SimpleMimeEntity with $headers, $encoder and $cache. Create a new SimpleMimeEntity with $headers, $encoder and $cache. Parameters `$headers` `$encoder` `$cache` `$grammar`
`public string`	# `generateId( )` Generate a new Content-ID or Message-ID for this MIME entity. Generate a new Content-ID or Message-ID for this MIME entity. Returns string
`public Swift_Mime_HeaderSet`	# `getHeaders( )` Get the `Swift_Mime_HeaderSet` for this entity. Get the `Swift_Mime_HeaderSet` for this entity. Returns `Swift_Mime_HeaderSet` Implementation of `Swift_Mime_MimeEntity::getHeaders()`
`public integer`	# `getNestingLevel( )` Get the nesting level of this entity. Get the nesting level of this entity. Returns integer See `Swift_Mime_MimeEntity::LEVEL_TOP`, `Swift_Mime_MimeEntity::LEVEL_MIXED`, `Swift_Mime_MimeEntity::LEVEL_RELATED`, `Swift_Mime_MimeEntity::LEVEL_ALTERNATIVE` Implementation of `Swift_Mime_MimeEntity::getNestingLevel()`
`public string`	# `getContentType( )` Get the Content-type of this entity. Get the Content-type of this entity. Returns string Implementation of `Swift_Mime_MimeEntity::getContentType()`
`public Swift_Mime_SimpleMimeEntity`	# `setContentType( string $type )` Set the Content-type of this entity. Set the Content-type of this entity. Parameters `$type` Returns `Swift_Mime_SimpleMimeEntity`
`public string`	# `getId( )` Get the CID of this entity. The CID will only be present in headers if a Content-ID header is present. Get the CID of this entity. The CID will only be present in headers if a Content-ID header is present. Returns string Implementation of `Swift_Mime_MimeEntity::getId()`
`public Swift_Mime_SimpleMimeEntity`	# `setId( string $id )` Set the CID of this entity. Set the CID of this entity. Parameters `$id` Returns `Swift_Mime_SimpleMimeEntity`
`public string`	# `getDescription( )` Get the description of this entity. This value comes from the Content-Description header if set. Get the description of this entity. This value comes from the Content-Description header if set. Returns string
`public Swift_Mime_SimpleMimeEntity`	# `setDescription( string $description )` Set the description of this entity. This method sets a value in the Content-ID header. Set the description of this entity. This method sets a value in the Content-ID header. Parameters `$description` Returns `Swift_Mime_SimpleMimeEntity`
`public integer`	# `getMaxLineLength( )` Get the maximum line length of the body of this entity. Get the maximum line length of the body of this entity. Returns integer
`public Swift_Mime_SimpleMimeEntity`	# `setMaxLineLength( integer $length )` Set the maximum line length of lines in this body. Though not enforced by the library, lines should not exceed 1000 chars. Set the maximum line length of lines in this body. Though not enforced by the library, lines should not exceed 1000 chars. Parameters `$length` Returns `Swift_Mime_SimpleMimeEntity`
`public array`	# `getChildren( )` Get all children added to this entity. Get all children added to this entity. Returns array of Swift_Mime_Entity Implementation of `Swift_Mime_MimeEntity::getChildren()`
`public Swift_Mime_SimpleMimeEntity`	# `setChildren( array $children, integer $compoundLevel = null )` Set all children of this entity. Set all children of this entity. Parameters `$children` Swiift_Mime_Entity instances `$compoundLevel` For internal use only Returns `Swift_Mime_SimpleMimeEntity` Implementation of `Swift_Mime_MimeEntity::setChildren()`
`public string`	# `getBody( )` Get the body of this entity as a string. Get the body of this entity as a string. Returns string Implementation of `Swift_Mime_MimeEntity::getBody()`
`public Swift_Mime_SimpleMimeEntity`	# `setBody( mixed $body, string $contentType = null )` Set the body of this entity, either as a string, or as an instance of `Swift_OutputByteStream`. Set the body of this entity, either as a string, or as an instance of `Swift_OutputByteStream`. Parameters `$body` `$contentType` optional Returns `Swift_Mime_SimpleMimeEntity` Implementation of `Swift_Mime_MimeEntity::setBody()`
`public Swift_Mime_ContentEncoder`	# `getEncoder( )` Get the encoder used for the body of this entity. Get the encoder used for the body of this entity. Returns `Swift_Mime_ContentEncoder`
`public Swift_Mime_SimpleMimeEntity`	# `setEncoder( Swift_Mime_ContentEncoder $encoder )` Set the encoder used for the body of this entity. Set the encoder used for the body of this entity. Parameters `$encoder` Returns `Swift_Mime_SimpleMimeEntity`
`public string`	# `getBoundary( )` Get the boundary used to separate children in this entity. Get the boundary used to separate children in this entity. Returns string
`public Swift_Mime_SimpleMimeEntity`	# `setBoundary( string $boundary )` Set the boundary used to separate children in this entity. Set the boundary used to separate children in this entity. Parameters `$boundary` Returns `Swift_Mime_SimpleMimeEntity` Throws `Swift_RfcComplianceException`
`public`	# `charsetChanged( string $charset )` Receive notification that the charset of this entity, or a parent entity has changed. Receive notification that the charset of this entity, or a parent entity has changed. Parameters `$charset` Implementation of `Swift_Mime_CharsetObserver::charsetChanged()`
`public`	# `encoderChanged( Swift_Mime_ContentEncoder $encoder )` Receive notification that the encoder of this entity or a parent entity has changed. Receive notification that the encoder of this entity or a parent entity has changed. Parameters `$encoder` Implementation of `Swift_Mime_EncodingObserver::encoderChanged()`
`public string`	# `toString( )` Get this entire entity as a string. Get this entire entity as a string. Returns string Implementation of `Swift_Mime_MimeEntity::toString()`
`public string`	# `__toString( )` Returns a string representation of this object. Returns a string representation of this object. Returns string See `Swift_Mime_SimpleMimeEntity::toString()`
`public`	# `toByteStream( Swift_InputByteStream $is )` Write this entire entity to a `Swift_InputByteStream`. Write this entire entity to a `Swift_InputByteStream`. Parameters `$is` Implementation of `Swift_Mime_MimeEntity::toByteStream()`
`protected`	# `_getIdField( )` Get the name of the header that provides the ID of this entity Get the name of the header that provides the ID of this entity
`protected`	# `_getHeaderFieldModel( $field )` Get the model data (usually an array or a string) for $field. Get the model data (usually an array or a string) for $field.
`protected`	# `_setHeaderFieldModel( $field, $model )` Set the model data for $field. Set the model data for $field.
`protected`	# `_getHeaderParameter( $field, $parameter )` Get the parameter value of $parameter on $field header. Get the parameter value of $parameter on $field header.
`protected`	# `_setHeaderParameter( $field, $parameter, $value )` Set the parameter value of $parameter on $field header. Set the parameter value of $parameter on $field header.
`protected`	# `_fixHeaders( )` Re-evaluate what content type and encoding should be used on this entity. Re-evaluate what content type and encoding should be used on this entity.
`protected`	# `_getCache( )` Get the KeyCache used in this entity. Get the KeyCache used in this entity.
`protected Swift_Mime_Grammar`	# `_getGrammar( )` Get the grammar used for validation. Get the grammar used for validation. Returns `Swift_Mime_Grammar`
`protected`	# `_clearCache( )` Empty the KeyCache for this entity. Empty the KeyCache for this entity.
`protected string`	# `getRandomId( )` Returns a random Content-ID or Message-ID. Returns a random Content-ID or Message-ID. Returns string
`private`	# `_readStream( Swift_OutputByteStream $os )`
`private`	# `_setEncoding( $encoding )`
`private`	# `_assertValidBoundary( $boundary )`
`private`	# `_setContentTypeInHeaders( $type )`
`private`	# `_setNestingLevel( $level )`
`private`	# `_getCompoundLevel( $children )`
`private`	# `_getNeededChildLevel( $child, $compoundLevel )`
`private`	# `_createChild( )`
`private`	# `_notifyEncoderChanged( Swift_Mime_ContentEncoder $encoder )`
`private`	# `_notifyCharsetChanged( $charset )`
`private`	# `_sortChildren( )`
`private`	# `_childSortAlgorithm( $a, $b )`
`public`	# `__destruct( )` Empties it's own contents from the cache. Empties it's own contents from the cache.
`private`	# `_assertValidId( string $id )` Throws an Exception if the id passed does not comply with RFC 2822. Throws an Exception if the id passed does not comply with RFC 2822. Parameters `$id` Throws `Swift_RfcComplianceException`

Constants inherited from Swift_Mime_MimeEntity
`LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED, LEVEL_TOP`

Properties summary
`private`	`$_headers` A collection of Headers for this mime entity A collection of Headers for this mime entity	#
`private`	`$_body` The body as a string, or a stream The body as a string, or a stream	#
`private`	`$_encoder` The encoder that encodes the body into a streamable format The encoder that encodes the body into a streamable format	#
`private`	`$_grammar` The grammar to use for id validation The grammar to use for id validation	#
`private`	`$_boundary` A mime bounary, if any is used A mime bounary, if any is used	#
`private array`	`$_compositeRanges` Mime types to be used based on the nesting level Mime types to be used based on the nesting level	# `array( 'multipart/mixed' => array(self::LEVEL_TOP, self::LEVEL_MIXED), 'multipart/alternative' => array(self::LEVEL_MIXED, self::LEVEL_ALTERNATIVE), 'multipart/related' => array(self::LEVEL_ALTERNATIVE, self::LEVEL_RELATED) )`
`private array`	`$_compoundLevelFilters` A set of filter rules to define what level an entity should be nested at A set of filter rules to define what level an entity should be nested at	# `array()`
`private integer`	`$_nestingLevel` The nesting level of this entity The nesting level of this entity	# `Swift_Mime_MimeEntity::LEVEL_ALTERNATIVE`
`private`	`$_cache` A KeyCache instance used during encoding and streaming A KeyCache instance used during encoding and streaming	#
`private array`	`$_immediateChildren` Direct descendants of this entity Direct descendants of this entity	# `array()`
`private array`	`$_children` All descendants of this entity All descendants of this entity	# `array()`
`private integer`	`$_maxLineLength` The maximum line length of the body of this entity The maximum line length of the body of this entity	# `78`
`private array`	`$_alternativePartOrder` The order in which alternative mime types should appear The order in which alternative mime types should appear	# `array( 'text/plain' => 1, 'text/html' => 2, 'multipart/related' => 3 )`
`private`	`$_id` The CID of this entity The CID of this entity	#
`private`	`$_cacheKey` The key used for accessing the cache The key used for accessing the cache	#
`protected`	`$_userContentType`	#

Packages

Classes

Interfaces

Class Swift_Mime_SimpleMimeEntity

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Returns

Implementation of

Returns

See

Implementation of

Returns

Implementation of

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Parameters

Implementation of

Parameters

Implementation of

Returns

Implementation of

Returns

See

Parameters

Implementation of

Returns

Returns

Parameters

Throws