Class Swift_MimePart

InheritanceSwift_MimePart » Swift_Mime_MimePart » Swift_Mime_SimpleMimeEntity
ImplementsSwift_Mime_MimeEntity

A MIME part, in a multipart message.

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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

Hide inherited methods

MethodDescriptionDefined By
__clone() Make a deep copy of object. Swift_Mime_SimpleMimeEntity
__construct() Create a new MimePart. Swift_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
newInstance() Create a new MimePart. Swift_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

Hide inherited methods

MethodDescriptionDefined 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

Method Details

__construct() public method

Create a new MimePart.

Details may be optionally passed into the constructor.

public void __construct ( $body null, $contentType null, $charset null )
$body string
$contentType string
$charset string
newInstance() public static method

Create a new MimePart.

public static Swift_Mime_MimePart newInstance ( $body null, $contentType null, $charset null )
$body string
$contentType string
$charset string