## Class Swift_EmbeddedFile

(line 21)

## Description

    Swift_Mime_SimpleMimeEntity
       |
       --Swift_Mime_Attachment
          |
          --Swift_Mime_EmbeddedFile
             |
             --Swift_EmbeddedFile

Located in File: /vendors/swiftMailer/classes/Swift/EmbeddedFile.php

##### An embedded file, in a multipart message.

- author: - Chris Corbyn

Classes extended from Swift_EmbeddedFile:

Swift_Image
  An image, embedded in a multipart message.

## Class Variables

Summary:

## Class Constants

Summary:

## Method Detail

Summary:
static Swift_Mime_EmbeddedFile fromPath (string $path)
static Swift_Mime_EmbeddedFile newInstance ([string|Swift_OutputByteStream $data = null], [string $filename = null], [string $contentType = null])
Swift_EmbeddedFile __construct ([string|Swift_OutputByteStream $data = null], [string $filename = null], [string $contentType = null])

#### Static Method fromPath (line 66)

#### Swift_Mime_EmbeddedFile fromPath( string $path)

Overridden in child classes as:

Swift_Image::fromPath()
  Create a new Image from a filesystem path.

##### Create a new EmbeddedFile from a filesystem path.

#### Parameters

- string $path:

#### Info

- access - public

#### Static Method newInstance (line 55)

#### Swift_Mime_EmbeddedFile newInstance( [string|Swift_OutputByteStream $data = null], [string $filename = null], [string $contentType = null])

Overridden in child classes as:

Swift_Image::newInstance()
  Create a new Image.

##### Create a new EmbeddedFile.

#### Parameters

- string|Swift_OutputByteStream $data:
- string $filename:
- string $contentType:

#### Info

- access - public

#### Constructor __construct (line 31)

#### Swift_EmbeddedFile __construct( [string|Swift_OutputByteStream $data = null], [string $filename = null], [string $contentType = null])

Overridden in child classes as:

Swift_Image::__construct()
  Create a new EmbeddedFile.

Overrides : Swift_Mime_EmbeddedFile::__construct() Creates a new Attachment with $headers and $encoder.

##### Create a new EmbeddedFile.

Details may be optionally provided to the constructor.

#### Parameters

- string|Swift_OutputByteStream $data:
- string $filename:
- string $contentType:

#### Info

- access - public

## Inherited Variables

### Inherited Class Variable Summary

#### Inherited From Class Swift_Mime_SimpleMimeEntity

#### Swift_Mime_SimpleMimeEntity::$_userContentType -

## Inherited Methods

### Inherited Method Summary

#### Inherited From Class Swift_Mime_EmbeddedFile

#### Swift_Mime_EmbeddedFile::__construct() - Creates a new Attachment with $headers and $encoder.

#### Swift_Mime_EmbeddedFile::getNestingLevel() - Get the nesting level of this EmbeddedFile.

#### Inherited From Class Swift_Mime_Attachment

#### Swift_Mime_Attachment::__construct() - Create a new Attachment with $headers, $encoder and $cache.

#### Swift_Mime_Attachment::getDisposition() - Get the Content-Disposition of this attachment.

#### Swift_Mime_Attachment::getFilename() - Get the filename of this attachment when downloaded.

#### Swift_Mime_Attachment::getNestingLevel() - Get the nesting level used for this attachment.

#### Swift_Mime_Attachment::getSize() - Get the file size of this attachment.

#### Swift_Mime_Attachment::setDisposition() - Set the Content-Disposition of this attachment.

#### Swift_Mime_Attachment::setFile() - Set the file that this attachment is for.

#### Swift_Mime_Attachment::setFilename() - Set the filename of this attachment.

#### Swift_Mime_Attachment::setSize() - Set the file size of this attachment.

#### Inherited From Class Swift_Mime_SimpleMimeEntity

#### Swift_Mime_SimpleMimeEntity::__construct() - Create a new SimpleMimeEntity with $headers, $encoder and $cache.

#### 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 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 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 Swift_InputByteStream.

#### Swift_Mime_SimpleMimeEntity::toString() - 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::_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::__destruct() - Empties it's own contents from the cache.

#### Swift_Mime_SimpleMimeEntity::__toString() - Returns a string representation of this object.

Documentation generated on Fri, 12 Nov 2010 20:45:19 +0000 by phpDocumentor 1.4.3