apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
File_Archive


Classes:
File_Archive
   File_Archive
   File_Archive_Predicate_TARCompatible
   File_Archive_Reader
   File_Archive_Reader_Directory
   File_Archive_Reader_File
   File_Archive_Reader_Gzip
   File_Archive_Reader_Memory
   File_Archive_Reader_Multi
   File_Archive_Reader_Tar
   File_Archive_Reader_Uncompress
   File_Archive_Reader_Zip
   File_Archive_Writer
   File_Archive_Writer_Files
   File_Archive_Writer_Gzip
   File_Archive_Writer_Mail
   File_Archive_Writer_Memory
   File_Archive_Writer_Multi
   File_Archive_Writer_Output
   File_Archive_Writer_Tar
   File_Archive_Writer_Zip

Class: File_Archive_Writer_Mail

Source Location: /File_Archive-0.1.0/File/Archive/Writer/Mail.php

Class Overview

File_Archive_Writer
   |
   --File_Archive_Writer_Mail

Send the files attached to a mail.

Methods

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.


[ Top ]

Method Detail

File_Archive_Writer_Mail (Constructor)   [line 89]

File_Archive_Writer_Mail File_Archive_Writer_Mail( $to, Array $headers, String $message, [ &$mail = null], Mail $mail)


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
   $to   — 
   &$mail   — 

[ Top ]

addCurrentData   [line 135]

void addCurrentData( )

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

[ Top ]

addHTMLImage   [line 116]

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

  • See: Mail_Mime::addHTMLImage

Parameters:

   $file   — 
   $c_type   — 
   $name   — 
   $isfile   — 

[ Top ]

close   [line 158]

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 147]

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

  • See: File_Archive_Writer::newFile

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

Parameters:

   $filename   — 
   $stat   — 
   $mime   — 

[ Top ]

setHTMLBody   [line 109]

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

  • See: Mail_Mime::setHTMLBody

Parameters:

   $data   — 
   $isfile   — 

[ Top ]

writeData   [line 128]

void writeData( $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)

Parameters:

   $data   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:24:01 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.