Path

ez components / documentation / api reference / 2009.2 / mail

eZ Components 2009.2

Mail: ezcMailStreamFile

[ Tutorial ] [ Display example ] [ Mail listing example ] [ Rfcs ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMailStreamFile

Mail part for data in a stream. [source]

Parents

ezcMailPart
   |
   --ezcMailFilePart
      |
      --ezcMailStreamFile

Inherited Constants

From ezcMailFilePart:
ezcMailFilePart::CONTENT_TYPE_APPLICATION    Application content type. Use this if the file non of the other content types match.
ezcMailFilePart::CONTENT_TYPE_AUDIO    Audio content type. Use this if the contents of the file is an audio.
ezcMailFilePart::CONTENT_TYPE_IMAGE    Image content type. Use this if the contents of the file is an image.
ezcMailFilePart::CONTENT_TYPE_VIDEO    Video content type. Use this if the contents of the file is a video.
ezcMailFilePart::DISPLAY_ATTACHMENT    Use DISPLAY_ATTACHMENT if you want the file to be displayed as an attachment to the recipients of the mail.
ezcMailFilePart::DISPLAY_INLINE    Use DISPLAY_INLINE if you want the file to be displayed inline in the mail to the recipients.

Properties

string read/write  $stream
The stream object to be read and added as an attachment. The mimeType and contentType are set in the constructor or if not specified they are extracted with the fileinfo extension if it is available, otherwise they are set to application/octet-stream.

Inherited Member Variables

From ezcMailPart:
protected  ezcMailPart::$properties

Method Summary

public ezcMailStreamFile __construct( $fileName, $stream, [$contentType = null], [$mimeType = null] )
Constructs a new attachment with $fileName and $stream.
public string generateBody( )
Returns the contents of the file with the correct encoding.

Inherited Methods

From ezcMailFilePart :
public ezcMailFilePart ezcMailFilePart::__construct()
Constructs a new attachment with $fileName.
public string ezcMailFilePart::generate()
Override of the generate() method from ezcMailPart. Used to set headers before generating the part.
From ezcMailPart :
public ezcMailPart ezcMailPart::__construct()
Constructs a new mail part.
public void ezcMailPart::appendExcludeHeaders()
The array $headers will be excluded when the headers are generated.
public string ezcMailPart::generate()
Returns the complete mail part including both the header and the body as a string.
public abstract string ezcMailPart::generateBody()
Returns the body of this part as a string.
public string ezcMailPart::generateHeaders()
Returns the headers set for this part as a RFC 822 string.
public mixed ezcMailPart::getHeader()
Returns the RAW value of the header $name.
protected string ezcMailPart::getHeaderCharset()
Returns the charset registered for the header $name.
public void ezcMailPart::setHeader()
Sets the header $name to the value $value and its charset to $charset.
protected void ezcMailPart::setHeaderCharset()
Sets the charset of the header $name to $value.
public void ezcMailPart::setHeaders()
Adds the headers $headers.

Methods

__construct

ezcMailStreamFile __construct( string $fileName, resource $stream, [string $contentType = null], [string $mimeType = null] )
Constructs a new attachment with $fileName and $stream.
If the $mimeType and $contentType are not specified they are set to application/octet-stream.

Parameters

Name Type Description
$fileName string  
$stream resource  
$contentType string  
$mimeType string  

Redefinition of

Method Description
ezcMailFilePart::__construct() Constructs a new attachment with $fileName.

generateBody

string generateBody( )
Returns the contents of the file with the correct encoding.
The stream might become unusable after this if it doesn't support seek.

Redefinition of

Method Description
ezcMailPart::generateBody() Returns the body of this part as a string.

Last updated: Mon, 21 Dec 2009