web2Project PHPXRef 0.7 : V1.00 : Detail view of libmail.class.php

(no description)

File Size:	388 lines (10 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Mail:: (19 methods):
  Mail()
  autoCheck()
  Subject()
  From()
  ReplyTo()
  Receipt()
  To()
  Cc()
  Bcc()
  Body()
  Priority()
  Send()
  getHostName()
  QueueMail()
  SendQueuedMail()
  Get()
  ValidEmail()
  CheckAdresses()
  CheckAddresses()

Class: Mail - X-Ref

Mail() X-Ref

Mail constructor

autoCheck($bool) X-Ref

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

From($from, $fromname = '') 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" );

Priority($priority) X-Ref

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

Send() X-Ref

Overload the Send method from PHPMailer to provide defered mails

getHostName() X-Ref

No 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

Source Code Reference for V1.00

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

Defines 1 class