Description
Located in File: /vendors/swiftMailer/classes/Swift/Mime/SimpleMimeEntity.php
A MIME entity, in a multipart message.
Classes extended from Swift_Mime_SimpleMimeEntity:
- Swift_Mime_Attachment
- An attachment, in a multipart message.
- Swift_Mime_MimePart
- A MIME part, in a multipart message.
Method Detail
Summary:
void
setBody
(
mixed $body, [
string $contentType =
null])
void
setChildren
(
$children, [
int $compoundLevel =
null])
Destructor __destruct (line 788)
void __destruct(
)
Empties it's own contents from the cache.
Info
Method charsetChanged (line 421)
void charsetChanged(
string
$charset)
Overridden in child classes as:
- Swift_Mime_MimePart::charsetChanged()
- Receive notification that the charset has changed on this document, or a parent document.
Implementation of:
- Swift_Mime_CharsetObserver::charsetChanged()
- Notify this observer that the entity's charset has changed.
Receive notification that the charset of this entity, or a parent entity has changed.
Parameters
Info
Method encoderChanged (line 431)
Receive notification that the encoder of this entity or a parent entity has changed.
Parameters
Info
Method generateId (line 122)
string generateId(
)
Generate a new Content-ID or Message-ID for this MIME entity.
Info
Method getBody (line 337)
string getBody(
)
Implementation of:
- Swift_Mime_MimeEntity::getBody()
- Get the body content of this entity as a string.
Get the body of this entity as a string.
Info
Method getBoundary (line 395)
string getBoundary(
)
Get the boundary used to separate children in this entity.
Info
Method getChildren (line 247)
array getChildren(
)
Implementation of:
- Swift_Mime_MimeEntity::getChildren()
- Get all children nested inside this entity.
Get all children added to this entity.
Info
- return - of Swift_Mime_Entity
- access - public
Method getContentType (line 155)
string getContentType(
)
Implementation of:
- Swift_Mime_MimeEntity::getContentType()
- Get the qualified content-type of this mime entity.
Get the Content-type of this entity.
Info
Method getDescription (line 204)
string getDescription(
)
Get the description of this entity.
This value comes from the Content-Description header if set.
Info
Method getEncoder (line 369)
Get the encoder used for the body of this entity.
Info
Method getId (line 178)
string getId(
)
Implementation of:
- Swift_Mime_MimeEntity::getId()
- Returns a unique ID for this entity.
Get the CID of this entity.
The CID will only be present in headers if a Content-ID header is present.
Info
Method getMaxLineLength (line 227)
int getMaxLineLength(
)
Get the maximum line length of the body of this entity.
Info
Method setBoundary (line 409)
void setBoundary(
string
$boundary)
Set the boundary used to separate children in this entity.
Parameters
Info
- throws - Swift_RfcComplianceException
- access - public
Method setChildren (line 257)
void setChildren(
$children, [int
$compoundLevel = null])
Implementation of:
- Swift_Mime_MimeEntity::setChildren()
- Set all children nested inside this entity.
Set all children of this entity.
Parameters
- array $children: Swiift_Mime_Entity instances
- int $compoundLevel: For internal use only
Info
Method setContentType (line 164)
void setContentType(
string
$type)
Set the Content-type of this entity.
Parameters
Info
Method setDescription (line 214)
void setDescription(
string
$description)
Set the description of this entity.
This method sets a value in the Content-ID header.
Parameters
Info
Method setEncoder (line 378)
Set the encoder used for the body of this entity.
Parameters
Info
Method setId (line 189)
void setId(
string
$id)
Set the CID of this entity.
Parameters
Info
Method setMaxLineLength (line 237)
void setMaxLineLength(
int
$length)
Set the maximum line length of lines in this body.
Though not enforced by the library, lines should not exceed 1000 chars.
Parameters
Info
Method _clearCache (line 640)
void _clearCache(
)
Empty the KeyCache for this entity.
Info
Method _fixHeaders (line 613)
void _fixHeaders(
)
Overridden in child classes as:
- Swift_Mime_MimePart::_fixHeaders()
- Fix the content-type and encoding of this entity
Re-evaluate what content type and encoding should be used on this entity.
Info
Method _getCache (line 632)
void _getCache(
)
Get the KeyCache used in this entity.
Info
Method _getHeaderFieldModel (line 559)
void _getHeaderFieldModel(
$field)
Get the model data (usually an array or a string) for $field.
Parameters
Info
Method _getHeaderParameter (line 586)
void _getHeaderParameter(
$field,
$parameter)
Get the parameter value of $parameter on $field header.
Parameters
Info
Method _setHeaderFieldModel (line 570)
void _setHeaderFieldModel(
$field,
$model)
Set the model data for $field.
Parameters
Info
Method _setHeaderParameter (line 597)
void _setHeaderParameter(
$field,
$parameter,
$value)
Set the parameter value of $parameter on $field header.
Parameters
- $field:
- $parameter:
- $value:
Info
Method __toString (line 481)
string __toString(
)
Overridden in child classes as:
- Swift_Mime_SimpleMessage::__toString()
- Returns a string representation of this object.
Returns a string representation of this object.
Info