DiogenesMailer Class Reference

List of all members.

Public Member Functions

 DiogenesMailer ($from, $to, $subject, $multipart=false, $cc="", $bcc="")
 addPart ($type, $encoding, $value)
 addHeader ($text)
 addPartText ($text)
 addPartHtml ($html)
 setBody ($text)
 send ()

Public Attributes

 $header
 $body
 $from
 $to
 $cc
 $bcc
 $subject
 $boundary
 $from_present

Detailed Description

Class for sending inline or multipart-emails.

Definition at line 46 of file diogenes.mailer.inc.php.


Member Function Documentation

DiogenesMailer::DiogenesMailer ( from,
to,
subject,
multipart = false,
cc = "",
bcc = "" 
)

The constructor. Initialises header & body.

Parameters:
from the sender of the email
to the recipient of the email
subject the subject of the email
multipart boolean indicating whether we have a multipart email
cc carbon copy for the email
bcc blind carbon copy for the email

Definition at line 77 of file diogenes.mailer.inc.php.

References $bcc, $cc, $from, $subject, and $to.

DiogenesMailer::addPart ( type,
encoding,
value 
)

Adds a part to the email's body.

Parameters:
type the MIME type of this part (e.g. "text/plain; charset=iso-8859-1")
encoding the content encoding for this part (e.g "8bit")
value the contents of this part

Definition at line 110 of file diogenes.mailer.inc.php.

Referenced by addPartHtml(), and addPartText().

DiogenesMailer::addHeader ( text  ) 

Adds a header to the email.

Parameters:
text the contents of the header (without the final line feed)

Definition at line 128 of file diogenes.mailer.inc.php.

DiogenesMailer::addPartText ( text  ) 

Adds a "text/plain" part to the email.

Parameters:
text 

Definition at line 139 of file diogenes.mailer.inc.php.

References addPart().

Here is the call graph for this function:

DiogenesMailer::addPartHtml ( html  ) 

Adds a "text/html" part to the email.

Parameters:
html 

Definition at line 150 of file diogenes.mailer.inc.php.

References addPart().

Here is the call graph for this function:

DiogenesMailer::setBody ( text  ) 

Sets the body of the email (only for inline messages!).

Parameters:
text 

Definition at line 161 of file diogenes.mailer.inc.php.

DiogenesMailer::send (  ) 

Sends the email using a pipe to sendmail.

Definition at line 173 of file diogenes.mailer.inc.php.


Member Data Documentation

DiogenesMailer::$header

The header of the email.

Definition at line 48 of file diogenes.mailer.inc.php.

DiogenesMailer::$body

The body of the email.

Definition at line 50 of file diogenes.mailer.inc.php.

DiogenesMailer::$from

The sender of the email.

Definition at line 52 of file diogenes.mailer.inc.php.

Referenced by DiogenesMailer().

DiogenesMailer::$to

The recipient of the email.

Definition at line 54 of file diogenes.mailer.inc.php.

Referenced by DiogenesMailer().

DiogenesMailer::$cc

Carbon copy for the email.

Definition at line 56 of file diogenes.mailer.inc.php.

Referenced by DiogenesMailer().

DiogenesMailer::$bcc

Blind carbon copy for the email.

Definition at line 58 of file diogenes.mailer.inc.php.

Referenced by DiogenesMailer().

DiogenesMailer::$subject

Subject of the email.

Definition at line 60 of file diogenes.mailer.inc.php.

Referenced by DiogenesMailer().

DiogenesMailer::$boundary

The boundary used to separate the email's body parts.

Definition at line 62 of file diogenes.mailer.inc.php.

DiogenesMailer::$from_present

Do we have a "From:" header? If none is explicitly set, just before sending it will be constructed from the sender's email address.

Definition at line 65 of file diogenes.mailer.inc.php.


The documentation for this class was generated from the following file:
Generated on Fri Jan 11 01:20:09 2008 for Diogenes by  doxygen 1.5.1