Interface Swift_Mime_MimeEntity

A MIME entity, such as an attachment.

Swift_Mime_MimeEntity implements Swift_Mime_CharsetObserver, Swift_Mime_EncodingObserver

Direct known implementers

Swift_Mime_Message, Swift_Mime_SimpleMimeEntity

Indirect known implementers

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

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

Methods summary

`public integer`	# `getNestingLevel( )` Get the level at which this entity shall be nested in final document. The lower the value, the more outermost the entity will be nested. Get the level at which this entity shall be nested in final document. The lower the value, the more outermost the entity will be nested. Returns `integer` See `Swift_Mime_MimeEntity::LEVEL_TOP`, `Swift_Mime_MimeEntity::LEVEL_MIXED`, `Swift_Mime_MimeEntity::LEVEL_RELATED`, `Swift_Mime_MimeEntity::LEVEL_ALTERNATIVE`
`public string`	# `getContentType( )` Get the qualified content-type of this mime entity. Get the qualified content-type of this mime entity. Returns `string`
`public string`	# `getId( )` Returns a unique ID for this entity. For most entities this will likely be the Content-ID, though it has no explicit semantic meaning and can be considered an identifier for programming logic purposes. If a Content-ID header is present, this value SHOULD match the value of the header. Returns a unique ID for this entity. For most entities this will likely be the Content-ID, though it has no explicit semantic meaning and can be considered an identifier for programming logic purposes. If a Content-ID header is present, this value SHOULD match the value of the header. Returns `string`
`public Swift_Mime_MimeEntity[]`	# `getChildren( )` Get all children nested inside this entity. These are not just the immediate children, but all children. Get all children nested inside this entity. These are not just the immediate children, but all children. Returns `Swift_Mime_MimeEntity[]`
`public`	# `setChildren( array $children )` Set all children nested inside this entity. This includes grandchildren. Set all children nested inside this entity. This includes grandchildren. Parameters `$children` `Swift_Mime_MimeEntity[]` $children
`public Swift_Mime_Header[]`	# `getHeaders( )` Get the collection of Headers in this Mime entity. Get the collection of Headers in this Mime entity. Returns `Swift_Mime_Header[]`
`public string`	# `getBody( )` Get the body content of this entity as a string. Returns NULL if no body has been set. Get the body content of this entity as a string. Returns NULL if no body has been set. Returns `string`
`public`	# `setBody( string $body, string $contentType = null )` Set the body content of this entity as a string. Set the body content of this entity as a string. Parameters `$body` `string` $body `$contentType` `string` $contentType optional
`public string`	# `toString( )` Get this entire entity in its string form. Get this entire entity in its string form. Returns `string`
`public`	# `toByteStream( Swift_InputByteStream $is )` Get this entire entity as a ByteStream. Get this entire entity as a ByteStream. Parameters `$is` `Swift_InputByteStream` $is to write to

Methods inherited from Swift_Mime_CharsetObserver

charsetChanged()

Methods inherited from Swift_Mime_EncodingObserver

encoderChanged()

Magic methods summary

Constants summary

`integer`	`LEVEL_TOP`	`16`	# Main message document; there can only be one of these Main message document; there can only be one of these
`integer`	`LEVEL_MIXED`	`256`	# An entity which nests with the same precedence as an attachment An entity which nests with the same precedence as an attachment
`integer`	`LEVEL_ALTERNATIVE`	`4096`	# An entity which nests with the same precedence as a mime part An entity which nests with the same precedence as a mime part
`integer`	`LEVEL_RELATED`	`65536`	# An entity which nests with the same precedence as embedded content An entity which nests with the same precedence as embedded content

Packages

Classes

Interfaces

Interface Swift_Mime_MimeEntity

Direct known implementers

Indirect known implementers

Methods summary

Returns

See

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Methods inherited from Swift_Mime_CharsetObserver

Methods inherited from Swift_Mime_EncodingObserver

Magic methods summary

Constants summary