Path

ez components / documentation / api reference / 1.1 / mail

eZ Components 1.1

Mail: ezcMailText

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMailText

Mail part used for sending all forms of plain text. [source]
Example: ezcMailText in a plain text message 
1.  $textPart = new ezcMailText( "This is a text message" );
Example: ezcMailText in a HTML message 
1.  $textPart = new ezcMailText( "<html>This is an <b>HTML</b> message"</html> );
2.  $textPart->subType = 'html';
property charset The characterset used for this text part. Defaults to 'us-ascii' while creating mail, and is always 'utf-8' while parsing mail. property originalCharset The characterset in which a text part originally was before the conversion to UTF-8. (readonly) property subType The subtype of this text part. Defaults to 'plain' for plain text. Use 'html' for HTML messages. property encoding The encoding of the text. Defaults to eight bit. property text The main data of this text part.

Parents

ezcMailPart
   |
   --ezcMailText

Method Summary

public ezcMailText __construct( $text, [$charset = "us-ascii"], [$encoding = ezcMail::EIGHT_BIT], [$originalCharset = 'us-ascii'] )
Constructs a new TextPart with the given $text, $charset and $encoding.
public string generateBody( )
Returns the generated text body of this part as a string.
public string generateHeaders( )
Returns the headers set for this part as a RFC822 compliant string.
public void __get( $name, $value )
Sets the property $name to $value.
public void __set( $name, $value )
Sets the property $name to $value.

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.
public mixed ezcMailPart::__get()
Returns the property $name.
public void ezcMailPart::__set()
Sets the property $name to $value.

Methods

__construct

ezcMailText __construct( string $text, [string $charset = "us-ascii"], [int $encoding = ezcMail::EIGHT_BIT], [ $originalCharset = 'us-ascii'] )
Constructs a new TextPart with the given $text, $charset and $encoding.

Parameters

Name Type Description
$text string  
$charset string  
$encoding int  
$originalCharset  

Redefinition of

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

generateBody

string generateBody( )
Returns the generated text body of this part as a string.

Redefinition of

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

generateHeaders

string generateHeaders( )
Returns the headers set for this part as a RFC822 compliant string.
This method does not add the required two lines of space to separate the headers from the body of the part.

See also:

ezcMailPart::setHeader().

Redefinition of

Method Description
ezcMailPart::generateHeaders() Returns the headers set for this part as a RFC 822 string.

__get

void __get( string $name, mixed $value )
Sets the property $name to $value.

Parameters

Name Type Description
$name string  
$value mixed  

Throws

ClassDescription
ezcBasePropertyNotFoundException if the property does not exist.

Redefinition of

Method Description
ezcMailPart::__get() Returns the property $name.

__set

void __set( string $name, mixed $value )
Sets the property $name to $value.

Parameters

Name Type Description
$name string  
$value mixed  

Throws

ClassDescription
ezcBasePropertyNotFoundException if the property does not exist.

Redefinition of

Method Description
ezcMailPart::__set() Sets the property $name to $value.

Last updated: Wed, 28 Nov 2007