Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Mime_MimeEntity

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/MimeEntity.php

Interface Overview

Swift_Mime_CharsetObserver
   |
   --Swift_Mime_MimeEntity

A MIME entity, such as an attachment.


Author(s):

  • Chris Corbyn

Constants

Methods


Child classes:

Swift_Mime_Message
A Message (RFC 2822) object.

Inherited Methods

Class: Swift_Mime_CharsetObserver

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

Class Details

[line 16]
A MIME entity, such as an attachment.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method getBody [line 94]

string|null getBody( )

Get the body content of this entity as a string.

Returns NULL if no body has been set.




Tags:

access:  public


[ Top ]

method getChildren [line 69]

Swift_Mime_MimeEntity[] getChildren( )

Get all children nested inside this entity.

These are not just the immediate children, but all children.




Tags:

access:  public


[ Top ]

method getContentType [line 46]

string getContentType( )

Get the qualified content-type of this mime entity.



Tags:

access:  public


[ Top ]

method getHeaders [line 85]

Swift_Mime_HeaderSet getHeaders( )

Get the collection of Headers in this Mime entity.



Tags:

access:  public


[ Top ]

method getId [line 60]

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.




Tags:

access:  public


[ Top ]

method getNestingLevel [line 39]

int 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.




Tags:



[ Top ]

method setBody [line 102]

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

Set the body content of this entity as a string.



Tags:

access:  public


Parameters:

string   $body  
string   $contentType   optional

[ Top ]

method setChildren [line 78]

void setChildren( $children)

Set all children nested inside this entity.

This includes grandchildren.




Tags:

access:  public


Parameters:

Swift_Mime_MimeEntity[]   $children  

[ Top ]

method toByteStream [line 116]

void toByteStream( Swift_InputByteStream $is)

Get this entire entity as a ByteStream.



Tags:

access:  public


Parameters:

Swift_InputByteStream   $is   to write to

[ Top ]

method toString [line 109]

string toString( )

Get this entire entity in its string form.



Tags:

access:  public


[ Top ]


Class Constants

LEVEL_ALTERNATIVE =  4096

[line 25]

An entity which nests with the same precedence as a mime part


[ Top ]

LEVEL_MIXED =  256

[line 22]

An entity which nests with the same precedence as an attachment


[ Top ]

LEVEL_RELATED =  65536

[line 28]

An entity which nests with the same precedence as embedded content


[ Top ]

LEVEL_TOP =  16

[line 19]

Main message document; there can only be one of these


[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:52:23 +0000 by phpDocumentor 1.4.3