## Class BounceMailHandler

Description

Located in /class.phpmailer-bmh.php (line 54)

Variable Summary
string $action_function
mixed $bmh_newline
mixed $boxname
boolean $debug_body_rule
boolean $debug_dsn_rule
mixed $deleteMsgDate
boolean $disable_delete
string $error_msg
mixed $hardMailbox
string $mailbox_password
string $mailbox_username
string $mailhost
int $max_messages
mixed $moveHard
mixed $moveSoft
mixed $port
boolean $purge_unprocessed
mixed $service
mixed $service_option
mixed $softMailbox
boolean $testmode
boolean $use_fetchstructure
int $verbose
string $Version
object $_mailbox_link
Method Summary
boolean globalDelete (string $mailbox)
boolean isParameter (array $currParameters, string $varKey, string $varValue)
boolean mailbox_exist (string $mailbox, [boolean $create = true])
boolean openLocal (string $file_path)
boolean openMailbox ()
void output ([mixed $msg = false], [mixed $verbose_level = VERBOSE_SIMPLE], string $msg,, string $verbose_level,)
boolean processBounce (int $pos, string $type, string $totalFetched)
boolean processMailbox ([string $max = false])
Variables
string $action_function = 'callbackAction' (line 110)

Callback Action function name

the function that handles the bounce mail. Parameters: int $msgnum the message number returned by Bounce Mail Handler string $bounce_type the bounce type: 'antispam','autoreply','concurrent','content_reject','command_reject','internal_error','defer','delayed' => array('remove'=>0,'bounce_type'=>'temporary'),'dns_loop','dns_unknown','full','inactive','latin_only','other','oversize','outofoffice','unknown','unrecognized','user_reject','warning' string $email the target email address string $subject the subject, ignore now string $xheader the XBounceHeader from the mail

1. or 0 $remove delete status, 0 is not deleted, 1 is deleted

string $rule_no bounce mail detect rule no. string $rule_cat bounce mail detect rule category int $totalFetched total number of messages in the mailbox

- access: public

mixed $bmh_newline = "<br />\n" (line 168)

- access: public

mixed $boxname = INBOX (line 192)

- access: public

boolean $debug_body_rule = false (line 147)

control the failed BODY rules output

- access: public

boolean $debug_dsn_rule = false (line 141)

control the failed DSN rules output

- access: public

mixed $deleteMsgDate = '' (line 226)

- access: public

boolean $disable_delete = false (line 163)

If disable_delete is equal to true, it will disable the delete function

- access: public

string $error_msg (line 88)

The last error msg

- access: public

mixed $hardMailbox = 'INBOX.hard' (line 217)

- access: public

string $mailbox_password (line 82)

The password needed to access mailbox

- access: public

string $mailbox_username (line 77)

The username of mailbox

- access: public

string $mailhost = 'localhost' (line 70)

Mail server

- access: public

int $max_messages = 3000 (line 94)

Maximum limit messages processed in one batch

- access: public

mixed $moveHard = false (line 211)

- access: public

mixed $moveSoft = false (line 198)

- access: public

mixed $port = 143 (line 174)

- access: public

boolean $purge_unprocessed = false (line 129)

Purge the unknown messages (or not)

- access: public

mixed $service = 'imap' (line 180)

- access: public

mixed $service_option = 'notls' (line 186)

- access: public

mixed $softMailbox = 'INBOX.soft' (line 204)

- access: public

boolean $testmode = false (line 123)

Test mode, if true will not delete messages

- access: public

boolean $use_fetchstructure = true (line 157)

Control the method to process the mail header if set true, uses the imap_fetchstructure function otherwise, detect message type directly from headers, a bit faster than imap_fetchstructure function and take less resources.

however - the difference is negligible

- access: public

int $verbose = VERBOSE_SIMPLE (line 135)

Control the debug output, default is VERBOSE_SIMPLE

- access: public

string $Version = "5.0.0rc1" (line 64)

Holds Bounce Mail Handler version.

- access: public

object $_mailbox_link = false (line 117)

Internal variable

The resource handler for the opened mailbox (POP3/IMAP/NNTP/etc.)

- access: public

Methods
globalDelete (line 592)

Function to delete messages in a mailbox, based on date

NOTE: this is global ... will affect all mailboxes except any that have 'sent' in the mailbox name

boolean globalDelete (string $mailbox)

- string $mailbox: (the mailbox name)

isParameter (line 442)

Function to determine if a particular value is found in a imap_fetchstructure key

boolean isParameter (array $currParameters, string $varKey, string $varValue)

- array $currParameters: (imap_fetstructure parameters)
- string $varKey: (imap_fetstructure key)
- string $varValue: (value to check for)

mailbox_exist (line 551)

Function to check if a mailbox exists

- if not found, it will create it

boolean mailbox_exist (string $mailbox, [boolean $create = true])

- string $mailbox: (the mailbox name, must be in 'INBOX.checkmailbox' format)
- boolean $create: (whether or not to create the checkmailbox if not found, defaults to true)

openLocal (line 284)

Open a mail box in local file system

boolean openLocal (string $file_path)

- string $file_path: (The local mailbox file path)

openMailbox (line 251)

Open a mail box

boolean openMailbox ()
output (line 237)

Output additional msg for debug

void output ([mixed $msg = false], [mixed $verbose_level = VERBOSE_SIMPLE], string $msg,, string $verbose_level,)

- string $msg,: if not given, output the last error msg
- string $verbose_level,: the output level of this message

processBounce (line 460)

Function to process each individual message

boolean processBounce (int $pos, string $type, string $totalFetched)

- int $pos: (message number)
- string $type: (DNS or BODY type)
- string $totalFetched: (total number of messages in mailbox)

processMailbox (line 306)

Process the messages in a mailbox

boolean processMailbox ([string $max = false])

- string $max: (maximum limit messages processed in one batch, if not given uses the property $max_messages

Documentation generated on Wed, 21 Jan 2009 13:56:59 -0500 by phpDocumentor 1.3.0RC3