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

Class: Swift_Mime_SimpleMimeEntity

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

Class Overview


A MIME entity, in a multipart message.


Author(s):

  • Chris Corbyn

Implements interfaces:

Variables

Methods


Child classes:

Swift_Mime_Attachment
An attachment, in a multipart message.
Swift_Mime_MimePart
A MIME part, in a multipart message.

Class Details

[line 16]
A MIME entity, in a multipart message.



Tags:

author:  Chris Corbyn


[ Top ]


Class Variables

$_userContentType =

[line 71]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 81]

Swift_Mime_SimpleMimeEntity __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.



Tags:

access:  public


Overridden in child classes as:

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.
Swift_Mime_MimePart::__construct()
Create a new MimePart with $headers, $encoder and $cache.
Swift_Mime_SimpleMessage::__construct()
Create a new SimpleMessage with $headers, $encoder and $cache.
Swift_Message::__construct()
Create a new Message.
Swift_MimePart::__construct()
Create a new MimePart.

Parameters:

Swift_Mime_HeaderSet   $headers  
Swift_Mime_ContentEncoder   $encoder  
Swift_KeyCache   $cache  
Swift_Mime_Grammar   $grammar  

[ Top ]

destructor __destruct [line 810]

void __destruct( )

Empties it's own contents from the cache.



Tags:

access:  public


[ Top ]

method charsetChanged [line 441]

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 ]

method encoderChanged [line 452]

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 ]

method generateId [line 120]

string generateId( )

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



Tags:

access:  public


[ Top ]

method getBody [line 346]

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 ]

method getBoundary [line 409]

string getBoundary( )

Get the boundary used to separate children in this entity.



Tags:

access:  public


[ Top ]

method getChildren [line 268]

Swift_Mime_MimeEntity[] getChildren( )

Get all children added to this entity.



Tags:

access:  public



Implementation of:
Swift_Mime_MimeEntity::getChildren()
Get all children nested inside this entity.
[ Top ]

method getContentType [line 154]

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 ]

method getDescription [line 214]

string getDescription( )

Get the description of this entity.

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




Tags:

access:  public


[ Top ]

method getEncoder [line 379]

Swift_Mime_ContentEncoder getEncoder( )

Get the encoder used for the body of this entity.



Tags:

access:  public


[ Top ]

method getHeaders [line 132]

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 ]

method getId [line 183]

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 ]

method getMaxLineLength [line 242]

int getMaxLineLength( )

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



Tags:

access:  public


[ Top ]

method getNestingLevel [line 144]

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_Attachment::getNestingLevel()
Get the nesting level used for this attachment.
Swift_Mime_EmbeddedFile::getNestingLevel()
Get the nesting level of this EmbeddedFile.
Swift_Mime_MimePart::getNestingLevel()
Get the nesting level of this entity.
Swift_Mime_SimpleMessage::getNestingLevel()
Always returns LEVEL_TOP for a message instance.


Implementation of:
Swift_Mime_MimeEntity::getNestingLevel()
Get the level at which this entity shall be nested in final document.
[ Top ]

method getRandomId [line 673]

string getRandomId( )

Returns a random Content-ID or Message-ID.



Tags:

access:  protected


[ Top ]

method setBody [line 360]

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.



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 ]

method setBoundary [line 427]

Swift_Mime_SimpleMimeEntity setBoundary( string $boundary)

Set the boundary used to separate children in this entity.



Tags:

throws:  Swift_RfcComplianceException
access:  public


Parameters:

string   $boundary  

[ Top ]

method setChildren [line 281]

Swift_Mime_SimpleMimeEntity 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:

Swift_Mime_MimeEntity[]   $children  
int   $compoundLevel   For internal use only

[ Top ]

method setContentType [line 166]

Swift_Mime_SimpleMimeEntity setContentType( string $type)

Set the Content-type of this entity.



Tags:

access:  public


Parameters:

string   $type  

[ Top ]

method setDescription [line 228]

Swift_Mime_SimpleMimeEntity 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 ]

method setEncoder [line 391]

Swift_Mime_SimpleMimeEntity setEncoder( Swift_Mime_ContentEncoder $encoder)

Set the encoder used for the body of this entity.



Tags:

access:  public


Parameters:

Swift_Mime_ContentEncoder   $encoder  

[ Top ]

method setId [line 197]

Swift_Mime_SimpleMimeEntity setId( string $id)

Set the CID of this entity.



Tags:

access:  public


Parameters:

string   $id  

[ Top ]

method setMaxLineLength [line 256]

Swift_Mime_SimpleMimeEntity 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 ]

method toByteStream [line 517]

void toByteStream( Swift_InputByteStream $is)

Write this entire entity to a {@see Swift_InputByteStream}.



Tags:

access:  public


Overridden in child classes as:

Swift_Mime_SimpleMessage::toByteStream()
Write this message to a Swift_InputByteStream.
Swift_Message::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 ]

method toString [line 462]

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.
Swift_Message::toString()
Get this message as a complete string.


Implementation of:
Swift_Mime_MimeEntity::toString()
Get this entire entity in its string form.
[ Top ]

method _bodyToByteStream [line 530]

void _bodyToByteStream( Swift_InputByteStream $is)

Write this entire entity to a Swift_InputByteStream.



Tags:

access:  protected


Parameters:

Swift_InputByteStream   $is  

[ Top ]

method _bodyToString [line 475]

string _bodyToString( )

Get this entire entity as a string.



Tags:

access:  protected


[ Top ]

method _clearCache [line 663]

void _clearCache( )

Empty the KeyCache for this entity.



Tags:

access:  protected


[ Top ]

method _fixHeaders [line 627]

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 ]

method _getCache [line 645]

Swift_KeyCache _getCache( )

Get the KeyCache used in this entity.



Tags:

access:  protected


[ Top ]

method _getGrammar [line 655]

Swift_Mime_Grammar _getGrammar( )

Get the grammar used for validation.



Tags:

access:  protected


[ Top ]

method _getHeaderFieldModel [line 579]

void _getHeaderFieldModel( $field)

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



Tags:

access:  protected


Parameters:

   $field  

[ Top ]

method _getHeaderParameter [line 603]

void _getHeaderParameter( $field, $parameter)

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



Tags:

access:  protected


Parameters:

   $field  
   $parameter  

[ Top ]

method _getIdField [line 571]

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 ]

method _setHeaderFieldModel [line 589]

void _setHeaderFieldModel( $field, $model)

Set the model data for $field.



Tags:

access:  protected


Parameters:

   $field  
   $model  

[ Top ]

method _setHeaderParameter [line 613]

void _setHeaderParameter( $field, $parameter, $value)

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



Tags:

access:  protected


Parameters:

   $field  
   $parameter  
   $value  

[ Top ]

method __clone [line 832]

void __clone( )

Make a deep copy of object.



Tags:

access:  public


Overridden in child classes as:

Swift_Message::__clone()
Clone Message Signers.

[ Top ]

method __toString [line 507]

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 ]


Documentation generated on Sun, 02 Oct 2016 07:54:44 +0000 by phpDocumentor 1.4.3