\Swift_Mime_MimePart
A MIME part, in a multipart message.
- Author: Chris Corbyn
Synopsis
class Swift_Mime_MimePart
extends Swift_Mime_SimpleMimeEntity
{
- // members
- protected $_userFormat;
- protected $_userCharset;
- protected $_userDelSp;
- private $_nestingLevel;
- // Inherited members from Swift_Mime_SimpleMimeEntity
- protected $_userContentType;
- // methods
- public void __construct()
- public Swift_Mime_MimePart setBody()
- public string getCharset()
- public Swift_Mime_MimePart setCharset()
- public string getFormat()
- public Swift_Mime_MimePart setFormat()
- public boolean getDelSp()
- public Swift_Mime_MimePart setDelSp()
- public int getNestingLevel()
- public void charsetChanged()
- protected void _fixHeaders()
- protected void _setNestingLevel()
- protected void _convertString()
- // Inherited methods from Swift_Mime_SimpleMimeEntity
- public void __construct()
- public string generateId()
- public Swift_Mime_HeaderSet getHeaders()
- public integer getNestingLevel()
- public string getContentType()
- public Swift_Mime_SimpleMimeEntity setContentType()
- public string getId()
- public Swift_Mime_SimpleMimeEntity setId()
- public string getDescription()
- public Swift_Mime_SimpleMimeEntity setDescription()
- public integer getMaxLineLength()
- public Swift_Mime_SimpleMimeEntity setMaxLineLength()
- public array getChildren()
- public Swift_Mime_SimpleMimeEntity setChildren()
- public string getBody()
- public Swift_Mime_SimpleMimeEntity setBody()
- public Swift_Mime_ContentEncoder getEncoder()
- public Swift_Mime_SimpleMimeEntity setEncoder()
- public string getBoundary()
- public Swift_Mime_SimpleMimeEntity setBoundary()
- public void charsetChanged()
- public void encoderChanged()
- public string toString()
- protected string _bodyToString()
- public string __toString()
- public void toByteStream()
- protected void _bodyToByteStream()
- protected void _getIdField()
- protected void _getHeaderFieldModel()
- protected void _setHeaderFieldModel()
- protected void _getHeaderParameter()
- protected void _setHeaderParameter()
- protected void _fixHeaders()
- protected Swift_KeyCache _getCache()
- protected Swift_Mime_Grammar _getGrammar()
- protected void _clearCache()
- protected string getRandomId()
- public void __destruct()
Hierarchy
Extends
Extended by
Tasks
Line | Task |
---|---|
283 | Try to refactor this logic |
Constants
Name | Value |
---|---|
LEVEL_TOP | 16 |
LEVEL_MIXED | 256 |
LEVEL_ALTERNATIVE | 4096 |
LEVEL_RELATED | 65536 |
Members
private
-
$_nestingLevel
The nesting level of this MimePart
protected
-
$_userCharset
The charset last specified by the user - $_userContentType
-
$_userDelSp
The delsp parameter last specified by the user -
$_userFormat
The format parameter last specified by the user
Methods
protected
- _convertString() — Encode charset when charset is not utf-8
- _fixHeaders() — Fix the content-type and encoding of this entity
- _setNestingLevel() — Set the nesting level of this entity
public
- __construct() — Create a new MimePart with $headers, $encoder and $cache.
- charsetChanged() — Receive notification that the charset has changed on this document, or a parent document.
- getCharset() — Get the character set of this entity.
- getDelSp() — Test if delsp is being used for this entity.
- getFormat() — Get the format of this entity (i.e. flowed or fixed).
- getNestingLevel() — Get the nesting level of this entity.
- setBody() — Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.
- setCharset() — Set the character set of this entity.
- setDelSp() — Turn delsp on or off for this entity.
- setFormat() — Set the format of this entity (flowed or fixed).
Inherited from Swift_Mime_SimpleMimeEntity
protected
- _bodyToByteStream() — Write this entire entity to a {@link Swift_InputByteStream}.
- _bodyToString() — Get this entire entity as a string.
- _clearCache() — Empty the KeyCache for this entity.
- _fixHeaders() — Re-evaluate what content type and encoding should be used on this entity.
- _getCache() — Get the KeyCache used in this entity.
- _getGrammar() — Get the grammar used for validation.
- _getHeaderFieldModel() — Get the model data (usually an array or a string) for $field.
- _getHeaderParameter() — Get the parameter value of $parameter on $field header.
- _getIdField() — Get the name of the header that provides the ID of this entity
- _setHeaderFieldModel() — Set the model data for $field.
- _setHeaderParameter() — Set the parameter value of $parameter on $field header.
- getRandomId() — Returns a random Content-ID or Message-ID.
public
- __toString() — Returns a string representation of this object.
- charsetChanged() — Receive notification that the charset of this entity, or a parent entity has changed.
- encoderChanged() — Receive notification that the encoder of this entity or a parent entity has changed.
- generateId() — Generate a new Content-ID or Message-ID for this MIME entity.
- getBody() — Get the body of this entity as a string.
- getBoundary() — Get the boundary used to separate children in this entity.
- getChildren() — Get all children added to this entity.
- getContentType() — Get the Content-type of this entity.
- getDescription() — Get the description of this entity.
- getEncoder() — Get the encoder used for the body of this entity.
- getHeaders() — Get the {@link Swift_Mime_HeaderSet} for this entity.
- getId() — Get the CID of this entity.
- getMaxLineLength() — Get the maximum line length of the body of this entity.
- getNestingLevel() — Get the nesting level of this entity.
- setBody() — Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.
- setBoundary() — Set the boundary used to separate children in this entity.
- setChildren() — Set all children of this entity.
- setContentType() — Set the Content-type of this entity.
- setDescription() — Set the description of this entity.
- setEncoder() — Set the encoder used for the body of this entity.
- setId() — Set the CID of this entity.
- setMaxLineLength() — Set the maximum line length of lines in this body.
- toByteStream() — Write this entire entity to a {@see Swift_InputByteStream}.
- toString() — Get this entire entity as a string.