[ Index ]

MailPress 544

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/Swiftmailer/classes/Swift/Mime/ -> SimpleMimeEntity.php (summary)

(no description)

File Size: 867 lines (24 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_Mime_SimpleMimeEntity:: (52 methods):
  __construct()
  generateId()
  getHeaders()
  getNestingLevel()
  getContentType()
  setContentType()
  getId()
  setId()
  getDescription()
  setDescription()
  getMaxLineLength()
  setMaxLineLength()
  getChildren()
  setChildren()
  getBody()
  setBody()
  getEncoder()
  setEncoder()
  getBoundary()
  setBoundary()
  charsetChanged()
  encoderChanged()
  toString()
  _bodyToString()
  __toString()
  toByteStream()
  _bodyToByteStream()
  _getIdField()
  _getHeaderFieldModel()
  _setHeaderFieldModel()
  _getHeaderParameter()
  _setHeaderParameter()
  _fixHeaders()
  _getCache()
  _getGrammar()
  _clearCache()
  getRandomId()
  _readStream()
  _setEncoding()
  _assertValidBoundary()
  _setContentTypeInHeaders()
  _setNestingLevel()
  _getCompoundLevel()
  _getNeededChildLevel()
  _createChild()
  _notifyEncoderChanged()
  _notifyCharsetChanged()
  _sortChildren()
  _childSortAlgorithm()
  __destruct()
  _assertValidId()
  __clone()


Class: Swift_Mime_SimpleMimeEntity  - X-Ref

A MIME entity, in a multipart message.

__construct(Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar)   X-Ref
Create a new SimpleMimeEntity with $headers, $encoder and $cache.

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

generateId()   X-Ref
Generate a new Content-ID or Message-ID for this MIME entity.

return: string

getHeaders()   X-Ref
Get the {@link Swift_Mime_HeaderSet} for this entity.

return: Swift_Mime_HeaderSet

getNestingLevel()   X-Ref
Get the nesting level of this entity.

return: int

getContentType()   X-Ref
Get the Content-type of this entity.

return: string

setContentType($type)   X-Ref
Set the Content-type of this entity.

param: string $type
return: Swift_Mime_SimpleMimeEntity

getId()   X-Ref
Get the CID of this entity.

The CID will only be present in headers if a Content-ID header is present.

return: string

setId($id)   X-Ref
Set the CID of this entity.

param: string $id
return: Swift_Mime_SimpleMimeEntity

getDescription()   X-Ref
Get the description of this entity.

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

return: string

setDescription($description)   X-Ref
Set the description of this entity.

This method sets a value in the Content-ID header.

param: string $description
return: Swift_Mime_SimpleMimeEntity

getMaxLineLength()   X-Ref
Get the maximum line length of the body of this entity.

return: int

setMaxLineLength($length)   X-Ref
Set the maximum line length of lines in this body.

Though not enforced by the library, lines should not exceed 1000 chars.

param: int $length
return: Swift_Mime_SimpleMimeEntity

getChildren()   X-Ref
Get all children added to this entity.

return: Swift_Mime_MimeEntity[]

setChildren(array $children, $compoundLevel = null)   X-Ref
Set all children of this entity.

param: Swift_Mime_MimeEntity[] $children
param: int                     $compoundLevel For internal use only
return: Swift_Mime_SimpleMimeEntity

getBody()   X-Ref
Get the body of this entity as a string.

return: string

setBody($body, $contentType = null)   X-Ref
Set the body of this entity, either as a string, or as an instance of
{@link Swift_OutputByteStream}.

param: mixed  $body
param: string $contentType optional
return: Swift_Mime_SimpleMimeEntity

getEncoder()   X-Ref
Get the encoder used for the body of this entity.

return: Swift_Mime_ContentEncoder

setEncoder(Swift_Mime_ContentEncoder $encoder)   X-Ref
Set the encoder used for the body of this entity.

param: Swift_Mime_ContentEncoder $encoder
return: Swift_Mime_SimpleMimeEntity

getBoundary()   X-Ref
Get the boundary used to separate children in this entity.

return: string

setBoundary($boundary)   X-Ref
Set the boundary used to separate children in this entity.

param: string $boundary
return: Swift_Mime_SimpleMimeEntity

charsetChanged($charset)   X-Ref
Receive notification that the charset of this entity, or a parent entity
has changed.

param: string $charset

encoderChanged(Swift_Mime_ContentEncoder $encoder)   X-Ref
Receive notification that the encoder of this entity or a parent entity
has changed.

param: Swift_Mime_ContentEncoder $encoder

toString()   X-Ref
Get this entire entity as a string.

return: string

_bodyToString()   X-Ref
Get this entire entity as a string.

return: string

__toString()   X-Ref
Returns a string representation of this object.

return: string

toByteStream(Swift_InputByteStream $is)   X-Ref
Write this entire entity to a {@see Swift_InputByteStream}.

param: Swift_InputByteStream

_bodyToByteStream(Swift_InputByteStream $is)   X-Ref
Write this entire entity to a {@link Swift_InputByteStream}.

param: Swift_InputByteStream

_getIdField()   X-Ref
Get the name of the header that provides the ID of this entity.


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


_setHeaderFieldModel($field, $model)   X-Ref
Set the model data for $field.


_getHeaderParameter($field, $parameter)   X-Ref
Get the parameter value of $parameter on $field header.


_setHeaderParameter($field, $parameter, $value)   X-Ref
Set the parameter value of $parameter on $field header.


_fixHeaders()   X-Ref
Re-evaluate what content type and encoding should be used on this entity.


_getCache()   X-Ref
Get the KeyCache used in this entity.

return: Swift_KeyCache

_getGrammar()   X-Ref
Get the grammar used for validation.

return: Swift_Mime_Grammar

_clearCache()   X-Ref
Empty the KeyCache for this entity.


getRandomId()   X-Ref
Returns a random Content-ID or Message-ID.

return: string

_readStream(Swift_OutputByteStream $os)   X-Ref
No description

_setEncoding($encoding)   X-Ref
No description

_assertValidBoundary($boundary)   X-Ref
No description

_setContentTypeInHeaders($type)   X-Ref
No description

_setNestingLevel($level)   X-Ref
No description

_getCompoundLevel($children)   X-Ref
No description

_getNeededChildLevel($child, $compoundLevel)   X-Ref
No description

_createChild()   X-Ref
No description

_notifyEncoderChanged(Swift_Mime_ContentEncoder $encoder)   X-Ref
No description

_notifyCharsetChanged($charset)   X-Ref
No description

_sortChildren()   X-Ref
No description

_childSortAlgorithm($a, $b)   X-Ref
No description

__destruct()   X-Ref
Empties it's own contents from the cache.


_assertValidId($id)   X-Ref
Throws an Exception if the id passed does not comply with RFC 2822.

param: string $id

__clone()   X-Ref
Make a deep copy of object.




Generated: Thu Apr 28 18:38:52 2016 Cross-referenced by PHPXref 0.7.1