Path

ez components / documentation / api reference / 1.1.1 / mail

eZ Components 1.1.1

Mail: ezcMailFile

[ Tutorial ] [ Display-example ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMailFile

Mail part for all forms of binary data. [source]

Parents

ezcMailPart
   |
   --ezcMailFile

Constants

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

Properties

int read/write  $contentId
The ID of this part. Used for internal links within an email. Setting this also sets the header Content-ID.
string read/write  $contentType
The content type of the file. ezcMailFile tries to extract this from the file, but you can override it with this property. Possible values are: CONTENT_TYPE_IMAGE, CONTENT_TYPE_VIDEO and CONTENT_TYPE_APPLICATION.
string read/write  $dispositionType
If the file should be shown inline in the mail or as an attachment. Possible values are: DISPLAY_ATTACHMENT and DISPLAY_INLINE.
string read/write  $fileName
The file on disk. The file with this name will only be available in the script that parses the mail. It will automatically be removed when the script ends.
string read/write  $mimeType
The mimetype of the file. ezcMailFile tries to extract this from the file, but you can override it with this property.

Method Summary

public void __construct( $fileName )
Constructs a new attachment with $fileName.
public string generateBody( )
Returns the contents of the file with the correct encoding.

Inherited Methods

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 string ezcMailPart::getHeader()
Returns the RAW value of the header $name.
public void ezcMailPart::setHeader()
Sets the header $name to the value $value.
public void ezcMailPart::setHeaders()
Adds the headers $headers.

Methods

__construct

void __construct( string $fileName )
Constructs a new attachment with $fileName.

Parameters

Name Type Description
$fileName string  

Redefinition of

Method Description
ezcMailPart::__construct() Constructs a new mail part.

generateBody

string generateBody( )
Returns the contents of the file with the correct encoding.

Redefinition of

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

Last updated: Thu, 01 Nov 2007