Class Swift_Mime_SimpleMimeEntity
A MIME entity, in a multipart message.
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$_userContentType | Swift_Mime_SimpleMimeEntity |
Public Methods
Method | Description | Defined By |
---|---|---|
__clone() | Make a deep copy of object. | Swift_Mime_SimpleMimeEntity |
__construct() | Create a new SimpleMimeEntity with $headers, $encoder and $cache. | Swift_Mime_SimpleMimeEntity |
__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 of this entity, or a parent entity has changed. | Swift_Mime_SimpleMimeEntity |
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 |
getChildren() | Get all children added to this entity. | Swift_Mime_SimpleMimeEntity |
getContentType() | Get the Content-type of this entity. | Swift_Mime_SimpleMimeEntity |
getDescription() | Get the description of this entity. | Swift_Mime_SimpleMimeEntity |
getEncoder() | Get the encoder used for the body of this entity. | Swift_Mime_SimpleMimeEntity |
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_SimpleMimeEntity |
setBody() | Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}. | Swift_Mime_SimpleMimeEntity |
setBoundary() | Set the boundary used to separate children in this entity. | Swift_Mime_SimpleMimeEntity |
setChildren() | Set all children of this entity. | Swift_Mime_SimpleMimeEntity |
setContentType() | Set the Content-type of this entity. | Swift_Mime_SimpleMimeEntity |
setDescription() | Set the description of this entity. | Swift_Mime_SimpleMimeEntity |
setEncoder() | Set the encoder used for the body of this entity. | Swift_Mime_SimpleMimeEntity |
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 |
_fixHeaders() | Re-evaluate what content type and encoding should be used on this entity. | Swift_Mime_SimpleMimeEntity |
_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 |
getRandomId() | Returns a random Content-ID or Message-ID. | Swift_Mime_SimpleMimeEntity |
Property Details
Method Details
Make a deep copy of object.
public void __clone ( ) |
Create a new SimpleMimeEntity with $headers, $encoder and $cache.
public void __construct ( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar ) | ||
$headers | Swift_Mime_HeaderSet | |
$encoder | Swift_Mime_ContentEncoder | |
$cache | Swift_KeyCache | |
$grammar | Swift_Mime_Grammar |
Empties it's own contents from the cache.
public void __destruct ( ) |
Returns a string representation of this object.
See also toString().
public string __toString ( ) |
Write this entire entity to a {@link Swift_InputByteStream}.
protected void _bodyToByteStream ( Swift_InputByteStream $is ) | ||
$is |
Get this entire entity as a string.
protected string _bodyToString ( ) |
Empty the KeyCache for this entity.
protected void _clearCache ( ) |
Re-evaluate what content type and encoding should be used on this entity.
protected void _fixHeaders ( ) |
Get the KeyCache used in this entity.
protected Swift_KeyCache _getCache ( ) |
Get the grammar used for validation.
protected Swift_Mime_Grammar _getGrammar ( ) |
Get the model data (usually an array or a string) for $field.
protected void _getHeaderFieldModel ( $field ) | ||
$field |
Get the parameter value of $parameter on $field header.
protected void _getHeaderParameter ( $field, $parameter ) | ||
$field | ||
$parameter |
Get the name of the header that provides the ID of this entity.
protected void _getIdField ( ) |
Set the model data for $field.
protected void _setHeaderFieldModel ( $field, $model ) | ||
$field | ||
$model |
Set the parameter value of $parameter on $field header.
protected void _setHeaderParameter ( $field, $parameter, $value ) | ||
$field | ||
$parameter | ||
$value |
Receive notification that the charset of this entity, or a parent entity has changed.
public void charsetChanged ( $charset ) | ||
$charset | string |
Receive notification that the encoder of this entity or a parent entity has changed.
public void encoderChanged ( Swift_Mime_ContentEncoder $encoder ) | ||
$encoder | Swift_Mime_ContentEncoder |
Generate a new Content-ID or Message-ID for this MIME entity.
public string generateId ( ) |
Get the body of this entity as a string.
public string getBody ( ) |
Get the boundary used to separate children in this entity.
public string getBoundary ( ) |
Get all children added to this entity.
public Swift_Mime_MimeEntity[] getChildren ( ) |
Get the Content-type of this entity.
public string getContentType ( ) |
Get the description of this entity.
This value comes from the Content-Description header if set.
public string getDescription ( ) |
Get the encoder used for the body of this entity.
public Swift_Mime_ContentEncoder getEncoder ( ) |
Get the {@link Swift_Mime_HeaderSet} for this entity.
public Swift_Mime_HeaderSet getHeaders ( ) |
Get the CID of this entity.
The CID will only be present in headers if a Content-ID header is present.
public string getId ( ) |
Get the maximum line length of the body of this entity.
public int getMaxLineLength ( ) |
Get the nesting level of this entity.
See also [[LEVEL_TOP,]] LEVEL_MIXED, LEVEL_RELATED, LEVEL_ALTERNATIVE.
public int getNestingLevel ( ) |
Returns a random Content-ID or Message-ID.
protected string getRandomId ( ) |
Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.
public Swift_Mime_SimpleMimeEntity setBody ( $body, $contentType = null ) | ||
$body | mixed | |
$contentType | string | Optional |
Set the boundary used to separate children in this entity.
public Swift_Mime_SimpleMimeEntity setBoundary ( $boundary ) | ||
$boundary | string | |
throws | Swift_RfcComplianceException |
---|
Set all children of this entity.
public Swift_Mime_SimpleMimeEntity setChildren ( array $children, $compoundLevel = null ) | ||
$children | Swift_Mime_MimeEntity[] | |
$compoundLevel | int | For internal use only |
Set the Content-type of this entity.
public Swift_Mime_SimpleMimeEntity setContentType ( $type ) | ||
$type | string |
Set the description of this entity.
This method sets a value in the Content-ID header.
public Swift_Mime_SimpleMimeEntity setDescription ( $description ) | ||
$description | string |
Set the encoder used for the body of this entity.
public Swift_Mime_SimpleMimeEntity setEncoder ( Swift_Mime_ContentEncoder $encoder ) | ||
$encoder | Swift_Mime_ContentEncoder |
Set the CID of this entity.
public Swift_Mime_SimpleMimeEntity setId ( $id ) | ||
$id | string |
Set the maximum line length of lines in this body.
Though not enforced by the library, lines should not exceed 1000 chars.
public Swift_Mime_SimpleMimeEntity setMaxLineLength ( $length ) | ||
$length | int |
Write this entire entity to a {@see Swift_InputByteStream}.
public void toByteStream ( Swift_InputByteStream $is ) | ||
$is |
Get this entire entity as a string.
public string toString ( ) |