dotProject 2.1 RC1 : Vue détaillée de libmail.class.php

This class encapsulates the PHP mail() function.

implements CC, Bcc, Priority headers

Mail constructor

activate or desactivate the email addresses validator

ex: autoCheck( true ) turn the validator on
by default autoCheck feature is on
param: boolean $bool set to true to turn on the auto validation

Subject( $subject, $charset='' ) X-Ref

Define the subject line of the email

param: string $subject any monoline string
param: string $charset encoding to be used for Quoted-Printable encoding of the subject

From( $from ) X-Ref

set the sender of the mail

param: string $from should be an email address

ReplyTo( $address ) X-Ref

set the Reply-to header

param: string $email should be an email address

Receipt() X-Ref

add a receipt to the mail ie. a confirmation is returned to the "From" address (or "ReplyTo" if defined)
when the receiver opens the message.

To( $to, $reset=false ) X-Ref

set the mail recipient

The optional reset parameter is useful when looping through records to send individual mails.
This prevents the 'to' array being continually stacked with additional addresses.

param: string $to email address, accept both a single address or an array of addresses
param: boolean $reset resets the current array

Cc( $cc ) X-Ref

Cc()
set the CC headers ( carbon copy )
$cc : email address(es), accept both array and string

Bcc( $bcc ) X-Ref

set the Bcc headers ( blank carbon copy ).
$bcc : email address(es), accept both array and string

Body( $body, $charset="" ) X-Ref

set the body (message) of the mail
define the charset if the message contains extended characters (accents)
default to us-ascii
$mail->Body( "m?l en fran?ais avec des accents", "iso-8859-1" );

Organization( $org ) X-Ref

set the Organization header

Priority( $priority ) X-Ref

set the mail priority
$priority : integer taken between 1 (highest) and 5 ( lowest )
ex: $mail->Priority(1) ; => Highest

Attach( $filename, $filetype = "", $disposition = "inline" ) X-Ref

Attach a file to the mail

param: string $filename : path of the file to attach
param: string $filetype : MIME-type of the file. default to 'application/x-unknown-content-type'
param: string $disposition : instruct the Mailclient to display the file if possible ("inline") or always as a link ("attachment") possible values are "inline", "attachment"

BuildMail() X-Ref

Build the email message

Send() X-Ref

format and send the mail

SMTPSend($to, $subject, $body, &$headers) X-Ref

Send email via an SMTP connection.

Work based loosly on that of Bugs Genie, which appears to be in turn based on something from 'Ninebirds'

socketRead() X-Ref

Pas de description

socketSend($msg, $rcv = true) X-Ref

Pas de description

getHostName() X-Ref

Pas de description

QueueMail() X-Ref

Queue mail to allow the queue manager to trigger
the email transfer.

SendQueuedMail($mod, $type, $originator, $owner, &$args) X-Ref

Dequeue the email and transfer it. Called from the queue manager.

Get() X-Ref

Returns the whole e-mail , headers + message

can be used for displaying the message in plain text or logging it

return: string

ValidEmail($address) X-Ref

check an email address validity

param: string $address : email address to check
return: true if email adress is ok

CheckAdresses( $aad ) X-Ref

check validity of email addresses

param: array $aad -
return: if unvalid, output an error message and exit, this may -should- be customized

CheckAddresses($aad) X-Ref

alias for the mispelled CheckAdresses

_build_attachement() X-Ref

check and encode attach file(s) . internal use only

Poids:	613 lignes (16 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de dotProject 2.1 RC1

/classes/ -> libmail.class.php (summary)

Définit 1 class