Class Swift_Mime_MimePart
Inheritance | Swift_Mime_MimePart » Swift_Mime_SimpleMimeEntity |
---|---|
Implements | Swift_Mime_MimeEntity |
Subclasses | Swift_Message, Swift_MimePart, Swift_Mime_SimpleMessage, Swift_SignedMessage |
A MIME part, in a multipart message.
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$_userCharset | The charset last specified by the user | Swift_Mime_MimePart | |
$_userContentType | Swift_Mime_SimpleMimeEntity | ||
$_userDelSp | The delsp parameter last specified by the user | Swift_Mime_MimePart | |
$_userFormat | The format parameter last specified by the user | Swift_Mime_MimePart |
Public Methods
Method | Description | Defined By |
---|---|---|
__clone() | Make a deep copy of object. | Swift_Mime_SimpleMimeEntity |
__construct() | Create a new MimePart with $headers, $encoder and $cache. | Swift_Mime_MimePart |
__destruct() | Empties it's own contents from the cache. | Swift_Mime_SimpleMimeEntity |
__toString() | Returns a string representation of this object. | Swift_Mime_SimpleMimeEntity |
charsetChanged() | Receive notification that the charset has changed on this document, or a parent document. | Swift_Mime_MimePart |
encoderChanged() | Receive notification that the encoder of this entity or a parent entity has changed. | Swift_Mime_SimpleMimeEntity |
generateId() | Generate a new Content-ID or Message-ID for this MIME entity. | Swift_Mime_SimpleMimeEntity |
getBody() | Get the body of this entity as a string. | Swift_Mime_SimpleMimeEntity |
getBoundary() | Get the boundary used to separate children in this entity. | Swift_Mime_SimpleMimeEntity |
getCharset() | Get the character set of this entity. | Swift_Mime_MimePart |
getChildren() | Get all children added to this entity. | Swift_Mime_SimpleMimeEntity |
getContentType() | Get the Content-type of this entity. | Swift_Mime_SimpleMimeEntity |
getDelSp() | Test if delsp is being used for this entity. | Swift_Mime_MimePart |
getDescription() | Get the description of this entity. | Swift_Mime_SimpleMimeEntity |
getEncoder() | Get the encoder used for the body of this entity. | Swift_Mime_SimpleMimeEntity |
getFormat() | Get the format of this entity (i.e. flowed or fixed). | Swift_Mime_MimePart |
getHeaders() | Get the {@link Swift_Mime_HeaderSet} for this entity. | Swift_Mime_SimpleMimeEntity |
getId() | Get the CID of this entity. | Swift_Mime_SimpleMimeEntity |
getMaxLineLength() | Get the maximum line length of the body of this entity. | Swift_Mime_SimpleMimeEntity |
getNestingLevel() | Get the nesting level of this entity. | Swift_Mime_MimePart |
setBody() | Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}. | Swift_Mime_MimePart |
setBoundary() | Set the boundary used to separate children in this entity. | Swift_Mime_SimpleMimeEntity |
setCharset() | Set the character set of this entity. | Swift_Mime_MimePart |
setChildren() | Set all children of this entity. | Swift_Mime_SimpleMimeEntity |
setContentType() | Set the Content-type of this entity. | Swift_Mime_SimpleMimeEntity |
setDelSp() | Turn delsp on or off for this entity. | Swift_Mime_MimePart |
setDescription() | Set the description of this entity. | Swift_Mime_SimpleMimeEntity |
setEncoder() | Set the encoder used for the body of this entity. | Swift_Mime_SimpleMimeEntity |
setFormat() | Set the format of this entity (flowed or fixed). | Swift_Mime_MimePart |
setId() | Set the CID of this entity. | Swift_Mime_SimpleMimeEntity |
setMaxLineLength() | Set the maximum line length of lines in this body. | Swift_Mime_SimpleMimeEntity |
toByteStream() | Write this entire entity to a {@see Swift_InputByteStream}. | Swift_Mime_SimpleMimeEntity |
toString() | Get this entire entity as a string. | Swift_Mime_SimpleMimeEntity |
Protected Methods
Method | Description | Defined By |
---|---|---|
_bodyToByteStream() | Write this entire entity to a {@link Swift_InputByteStream}. | Swift_Mime_SimpleMimeEntity |
_bodyToString() | Get this entire entity as a string. | Swift_Mime_SimpleMimeEntity |
_clearCache() | Empty the KeyCache for this entity. | Swift_Mime_SimpleMimeEntity |
_convertString() | Encode charset when charset is not utf-8 | Swift_Mime_MimePart |
_fixHeaders() | Fix the content-type and encoding of this entity | Swift_Mime_MimePart |
_getCache() | Get the KeyCache used in this entity. | Swift_Mime_SimpleMimeEntity |
_getGrammar() | Get the grammar used for validation. | Swift_Mime_SimpleMimeEntity |
_getHeaderFieldModel() | Get the model data (usually an array or a string) for $field. | Swift_Mime_SimpleMimeEntity |
_getHeaderParameter() | Get the parameter value of $parameter on $field header. | Swift_Mime_SimpleMimeEntity |
_getIdField() | Get the name of the header that provides the ID of this entity. | Swift_Mime_SimpleMimeEntity |
_setHeaderFieldModel() | Set the model data for $field. | Swift_Mime_SimpleMimeEntity |
_setHeaderParameter() | Set the parameter value of $parameter on $field header. | Swift_Mime_SimpleMimeEntity |
_setNestingLevel() | Set the nesting level of this entity | Swift_Mime_MimePart |
getRandomId() | Returns a random Content-ID or Message-ID. | Swift_Mime_SimpleMimeEntity |
Property Details
Method Details
Create a new MimePart with $headers, $encoder and $cache.
public void __construct ( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, $charset = null ) | ||
$headers | Swift_Mime_HeaderSet | |
$encoder | Swift_Mime_ContentEncoder | |
$cache | Swift_KeyCache | |
$grammar | Swift_Mime_Grammar | |
$charset | string |
Encode charset when charset is not utf-8
protected void _convertString ( $string ) | ||
$string |
Fix the content-type and encoding of this entity
protected void _fixHeaders ( ) |
Set the nesting level of this entity
protected void _setNestingLevel ( $level ) | ||
$level |
Receive notification that the charset has changed on this document, or a parent document.
public void charsetChanged ( $charset ) | ||
$charset | string |
Get the character set of this entity.
public string getCharset ( ) |
Test if delsp is being used for this entity.
public bool getDelSp ( ) |
Get the format of this entity (i.e. flowed or fixed).
public string getFormat ( ) |
Get the nesting level of this entity.
See also [[LEVEL_TOP,]] LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED.
public int getNestingLevel ( ) |
Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.
public Swift_Mime_MimePart setBody ( $body, $contentType = null, $charset = null ) | ||
$body | mixed | |
$contentType | string | Optional |
$charset | string | Optional |
Set the character set of this entity.
public Swift_Mime_MimePart setCharset ( $charset ) | ||
$charset | string |
Turn delsp on or off for this entity.
public Swift_Mime_MimePart setDelSp ( $delsp = true ) | ||
$delsp | bool |
Set the format of this entity (flowed or fixed).
public Swift_Mime_MimePart setFormat ( $format ) | ||
$format | string |