Docs For Class File_Archive_Writer

Class: File_Archive_Writer_Mail

Inherited Variables

Inherited Methods

Class: File_Archive_Writer

File_Archive_Writer::close(): Close the writer, eventually flush the data, write the footer...
File_Archive_Writer::newFile(): Create a new file in the writer
File_Archive_Writer::writeData(): Append the specified data to the writer
File_Archive_Writer::writeFile(): Append the content of the physical file $filename to the writer writeFile($filename) must be equivalent to writeData(file_get_contents($filename)) but can be more efficient

Class Details

[line 39]
Send the files attached to a mail.

Method Detail

File_Archive_Writer_Mail (Constructor) [line 91]

File_Archive_Writer_Mail File_Archive_Writer_Mail(
mixed
$to, array
$headers, string
$message, [Mail
&$mail = null])

Parameters:

Mail	`$mail`	—	Object used to send mail (see Mail::factory)
array	`$headers`	—	or string $to An array or a string with comma separated recipients
string	`$message`	—	Text body of the mail

[ Top ]

addCurrentData [line 138]

void addCurrentData(
)

Called when a file is finished and must be added as attachment to the mail

[ Top ]

addHTMLImage [line 118]

void addHTMLImage(
mixed
$file, [mixed
$c_type = 'application/octet-stream'], [mixed
$name = ''], [mixed
$isfile = true])

See: Mail_Mime::addHTMLImage()

[ Top ]

close [line 169]

void close(
)

See: File_Archive_Writer::close()

Overrides File_Archive_Writer::close() (Close the writer, eventually flush the data, write the footer...)

[ Top ]

newFile [line 155]

void newFile(
mixed
$filename, mixed
$stat, [mixed
$mime = "application/octet-stream"])

See: File_Archive_Writer::newFile()

Overrides File_Archive_Writer::newFile() (Create a new file in the writer)

[ Top ]

setHTMLBody [line 111]

void setHTMLBody(
mixed
$data, [mixed
$isfile = false])

See: Mail_Mime::setHTMLBody()

[ Top ]

writeData [line 131]

void writeData(
mixed
$data)

See: File_Archive_Writer::writeData() This function just put the data in $currentData until the end of file At that time, addCurrentData is called to attach $currentData to the mail and to clear $currentData for a new file

Overrides File_Archive_Writer::writeData() (Append the specified data to the writer)

[ Top ]

Class: File_Archive_Writer_Mail

Class Overview

Methods

Inherited Variables

Inherited Methods

Class: File_Archive_Writer

Class Details

Method Detail

File_Archive_Writer_Mail (Constructor) [line 91]

Parameters:

addCurrentData [line 138]

addHTMLImage [line 118]

close [line 169]

newFile [line 155]

setHTMLBody [line 111]

writeData [line 131]