Documentation

Swift_Mime_Attachment extends Swift_Mime_SimpleMimeEntity

in package

• Application

An attachment, in a multipart message.

Tags

author

Chris Corbyn

Table of Contents

LEVEL_ALTERNATIVE  = 4096

An entity which nests with the same precedence as a mime part

LEVEL_MIXED  = 256

An entity which nests with the same precedence as an attachment

LEVEL_RELATED  = 65536

An entity which nests with the same precedence as embedded content

LEVEL_TOP  = 16

Main message document; there can only be one of these

$userContentType  : mixed

$alternativePartOrder  : mixed

The order in which alternative mime types should appear

$body  : mixed

The body as a string, or a stream

$boundary  : mixed

A mime boundary, if any is used

$cache  : mixed

A KeyCache instance used during encoding and streaming

$cacheKey  : mixed

The key used for accessing the cache

$children  : mixed

All descendants of this entity

$compositeRanges  : mixed

Mime types to be used based on the nesting level

$compoundLevelFilters  : mixed

A set of filter rules to define what level an entity should be nested at

$encoder  : mixed

The encoder that encodes the body into a streamable format

$headers  : mixed

A collection of Headers for this mime entity

$id  : mixed

The CID of this entity

$idGenerator  : mixed

Message ID generator

$immediateChildren  : mixed

Direct descendants of this entity

$maxLineLength  : mixed

The maximum line length of the body of this entity

$mimeTypes  : mixed

Recognized MIME types

$nestingLevel  : mixed

The nesting level of this entity

__clone()  : mixed

Make a deep copy of object.

__construct()  : mixed

Create a new Attachment with $headers, $encoder and $cache.

__destruct()  : mixed

Empties it's own contents from the cache.

__toString()  : string

Returns a string representation of this object.

charsetChanged()  : mixed

Receive notification that the charset of this entity, or a parent entity has changed.

encoderChanged()  : mixed

Receive notification that the encoder of this entity or a parent entity has changed.

generateId()  : string

Generate a new Content-ID or Message-ID for this MIME entity.

getBody()  : string

Get the body of this entity as a string.

getBodyContentType()  : string

Get the Body Content-type of this entity.

getBoundary()  : string

Get the boundary used to separate children in this entity.

getChildren()  : array<string|int, Swift_Mime_SimpleMimeEntity>

Get all children added to this entity.

getContentType()  : string

Get the Content-type of this entity.

getDescription()  : string

Get the description of this entity.

getDisposition()  : string

Get the Content-Disposition of this attachment.

getEncoder()  : Swift_Mime_ContentEncoder

Get the encoder used for the body of this entity.

getFilename()  : string

Get the filename of this attachment when downloaded.

getHeaders()  : Swift_Mime_SimpleHeaderSet

Get the {@link Swift_Mime_SimpleHeaderSet} for this entity.

getId()  : string

Get the CID of this entity.

getMaxLineLength()  : int

Get the maximum line length of the body of this entity.

getNestingLevel()  : int

Get the nesting level used for this attachment.

getSize()  : int

Get the file size of this attachment.

setBody()  : $this

Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.

setBoundary()  : $this

Set the boundary used to separate children in this entity.

setChildren()  : $this

Set all children of this entity.

setContentType()  : $this

Set the Content-type of this entity.

setDescription()  : $this

Set the description of this entity.

setDisposition()  : $this

Set the Content-Disposition of this attachment.

setEncoder()  : $this

Set the encoder used for the body of this entity.

setFile()  : $this

Set the file that this attachment is for.

setFilename()  : $this

Set the filename of this attachment.

setId()  : $this

Set the CID of this entity.

setMaxLineLength()  : $this

Set the maximum line length of lines in this body.

setSize()  : $this

Set the file size of this attachment.

toByteStream()  : mixed

Write this entire entity to a {@see Swift_InputByteStream}.

toString()  : string

Get this entire entity as a string.

bodyToByteStream()  : mixed

Write this entire entity to a {@link Swift_InputByteStream}.

bodyToString()  : string

Get this entire entity as a string.

clearCache()  : mixed

Empty the KeyCache for this entity.

fixHeaders()  : mixed

Re-evaluate what content type and encoding should be used on this entity.

getCache()  : Swift_KeyCache

Get the KeyCache used in this entity.

getHeaderFieldModel()  : mixed

Get the model data (usually an array or a string) for $field.

getHeaderParameter()  : mixed

Get the parameter value of $parameter on $field header.

getIdField()  : mixed

Get the name of the header that provides the ID of this entity.

getIdGenerator()  : Swift_IdGenerator

Get the ID generator.

setHeaderFieldModel()  : mixed

Set the model data for $field.

setHeaderParameter()  : mixed

Set the parameter value of $parameter on $field header.

assertValidBoundary()  : mixed

createChild()  : mixed

getCompoundLevel()  : mixed

getNeededChildLevel()  : mixed

notifyCharsetChanged()  : mixed

notifyEncoderChanged()  : mixed

readStream()  : mixed

setContentTypeInHeaders()  : mixed

setEncoding()  : mixed

setNestingLevel()  : mixed

sortChildren()  : mixed