Docs For Class Mail

Description

Mime Part class

Author: Richard Heyes <richard@phpguru.org> Modified by: Keyvan Minoukadeh (to make multipart/form-data POSTs easier)

Located in Program_Root/Mail_MimePart.php (line 49)

Variable Summary

string $_body

string $_boundary

string $_encoded

string $_encoding

array $_headers

array $_subParts

Method Summary

void Mail_MimePart ()

void addHeader (string $name, string $value)

A &addSubPart (object &$subPart)

string boundary ()

string encode ()

array headers ()

void removeHeader (string $name)

void setBody (string $body)

Variables

string $_body (line 61)

The body of this part

string $_boundary (line 85)

Boundary

string $_encoded (line 79)

The encoded version of this mimepart

string $_encoding (line 73)

The encoding to use

array $_headers (line 55)

Any headers for this part

array $_subParts (line 67)

Subparts to this part

Methods

Constructor Mail_MimePart (line 92)

Constructor

access: public

void Mail_MimePart ()

addHeader (line 113)

Sets a header

access: public

void addHeader (string $name, string $value)

string $name:
The header to set
string $value:
The headers' value

addSubPart (line 160)

&addSubPart()

Adds a subpart to current mime part and returns a reference to it

return:
reference to the part you just added. It is crucial if using multipart/* in your subparts that you use =& in your script when calling this function, otherwise you will not be able to add further subparts.
access: public

A &addSubPart (object &$subPart)

object $subPart:
The Mail_MimePart subpart to add

boundary (line 221)

Boundary

access: public

string boundary ()

encode (line 173)

Encodes and returns the body. Also stores it in the encoded member variable

return:
body
access: public

string encode ()

headers (line 210)

Headers

return:
associative array of headers
access: public

array headers ()

removeHeader (line 129)

Removes a previously set header

access: public

void removeHeader (string $name)

string $name:
The header to unset

setBody (line 142)

Sets the body for this part

access: public

void setBody (string $body)

string $body:
The body string

Class Mail_MimePart