Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcMailMultipartMixed

Mail::ezcMailMultipartMixed

Class ezcMailMultipartMixed

The mixed multipart type is used to bundle an ordered list of mail parts.

Each part will be shown in the mail in the order provided.

The following example shows how to build a mail with a text part and an attachment using ezcMailMultipartMixed.

$mixed = new ezcMailMultipartMixed( new ezcMailTextPart( "Picture of me flying!" ),
new ezcMailFile( "fly.jpg" ) );
$mail = new ezcMail();
$mail->body = $mixed;

Source for this file: /Mail/src/parts/multiparts/multipart_mixed.php

ezcMailPart
   |
   --ezcMailMultipart
      |
      --ezcMailMultipartMixed

Version:

//autogen//

Inherited Constants

From ezcMailMultipart:
`ezcMailMultipart::DEFAULT_NO_MIME_MESSAGE`	Default message displayed to non-MIME capable email clients.

Inherited Member Variables

From ezcMailMultipart
protected	`ezcMailMultipart::$parts`
From ezcMailPart
protected	`ezcMailPart::$properties`

Method Summary

public ezcMailMultipartMixed	`__construct( $... )` Constructs a new ezcMailMultipartMixed
public void	`appendPart( $part )` Appends a part to the list of parts.
public array(ezcMailPart)	`getParts( )` Returns the mail parts associated with this multipart.
public string	`multipartType( )` Returns "mixed".

Inherited Methods

From ezcMailMultipart
public ezcMailMultipart	`ezcMailMultipart::__construct()` Constructs a new ezcMailMultipart with the parts $parts.
public string	`ezcMailMultipart::generateBody()` Returns the generated body for all multipart types.
protected static string	`ezcMailMultipart::generateBoundary()` Returns a unique boundary string.
public abstract string	`ezcMailMultipart::multipartType()` Returns the type of multipart.
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

ezcMailMultipartMixed __construct( ezcMailPart|array(ezcMailPart) $... )

Constructs a new ezcMailMultipartMixed

The constructor accepts an arbitrary number of ezcMailParts or arrays with ezcMailparts. Parts are added in the order provided. Parameters of the wrong type are ignored.

Parameters:

Name	Type	Description
`$...`	ezcMailPart\|array(ezcMailPart)

Redefinition of:

Method	Description
`ezcMailMultipart::__construct()`	Constructs a new ezcMailMultipart with the parts $parts.

appendPart

void appendPart( ezcMailPart $part )

Appends a part to the list of parts.

Parameters:

Name	Type	Description
`$part`	ezcMailPart

getParts

array(ezcMailPart) getParts( )

Returns the mail parts associated with this multipart.

multipartType

string multipartType( )

Returns "mixed".

Redefinition of:

Method	Description
`ezcMailMultipart::multipartType()`	Returns the type of multipart.

Documentation generated by phpDocumentor 1.4.3