develop:functionm

An Index of PHPlist Functions and Class Methods

The location of the definition of each function or method is listed by file name and line number. Each file is located relative to the admin directory in the phplist distribution, that is, relative to the subdirectory public_html/lists/admin.

For each function or method, the arguments are listed and explained, as well as the return value if any. Some explanation of the function is planned to be given among the Comments. These pages are under construction. Most entries are incomplete. But every entry has the location for the definition of the function or method, so that you can look up the definition in file containing the source code.

The line numbers shown for each function listed correspond to version 3.05 of Phplist. In most cases the locations of these functions have changed in later releases, Usually these functions involve only a small change in the line number, so that you can locate the function in the vicinity of the line number specified.

Back

Up to Index

mailBoxName($mailbox,$delimiter,$level)

import3.php, line 42

Arguments:
1. $mailbox
2. $delimiter
3. $level
Return value:
Comments:

mailBoxParent($mailbox,$delimiter,$level)

import3.php, line 51

Arguments:
1. $mailbox
2. $delimiter
3. $level
Return value:
Comments:

MailSend($header, $body)

class.phplistmailer.php, line 587

Arguments:
1. $header
2. $body
Return value:
Comments:

mailto2href($text)

sendemaillib.php, line 1028

Arguments:
1. $text
Return value:
Comments:

mailURL( $sTo, $sFrom, $sSubject, $sUrl )

commonlib/lib/maillib.php, line 169

Arguments:
1. $sTo
2. $sFrom
3. $sSubject
4. $sUrl
Return value:
Comments:

main()

readtestmail.php, line 270

Arguments:
Return value:
Comments:

matchBounceRules($text,$rules = array())

lib.php, line 1323

Arguments:
1. $text
2. $rules
Return value:
Comments:

matchedBounceRule($text,$activeonly = 0)

lib.php, line 1302

Arguments:
1. $text
2. $activeonly
Return value:
Comments:

mergeUser($userid)

reconcileusers.php, line 75

Arguments:
1. $userid
Return value:
Comments:

mergeUsers($original,$duplicate)

mergeduplicates.php, line 8

Arguments:
1. $original
2. $duplicate
Return value:
Comments:

messageHeaders($mail)

defaultplugin.php, line 487

Explanation: A method of the default plugin that you can override with a plugin. It is the last plugin method called before a message is sent. Using this method a plugin can add headers to a message.
Arguments:
1. $mail: The mail object containing both the message to be sent and the method to mail the message to the current subscriber.
Return value: an associative array of headers to be added to the message in the form (headeritem ⇒ headervalue).
Comments: Since objects in PHP are always passed by reference rather than by value, a plugin can use this method to alter any property of the outgoing message that it needs to. It is not necessary to return anything but an empty array. The plugin can do its work as a side effect.

messageQueued($id)

defaultplugin.php, line 633

Explanation: A method of the default plugin that you can override with a plugin. It is called when a message is queued for sending.
Arguments:
1. $id: The numerical id of the message in the database.
Return value: None
Comments:

messageQueueFinished()

defaultplugin.php, line 648

Arguments:
Return value:
Comments:

messageReQueued($id)

defaultplugin.php, line 642

Explanation: A method of the default plugin that you can override with a plugin. It is called when a message is returned to the queue.
Arguments:
1. $id: The numerical id of the message in the database.
Return value: None
Comments:

messageStatus($id,$status)

defaultplugin.php, line 409

Arguments:
1. $id
2. $status
Return value:
Comments:

messageStatusLimitReached($recentlySent)

defaultplugin.php, line 399

Arguments:
1. $recentlySent
Return value:
Comments:

mimeWrap($messageid, $body, $header, $contenttype, $destination)

defaultplugin.php, line 449

Arguments:
1. $messageid
2. $body
3. $header
4. $contenttype
5. $destination
Return value:
Comments:

missingText($text)

languages.php, line 381

Arguments:
1. $text
Return value:
Comments:

monthName($month,$short=0)

systemstats.php, line 9

Arguments:
1. $month
2. $short
Return value:
Comments:

moveUser($userid)

reconcileusers.php, line 118

Arguments:
1. $userid
Return value:
Comments:

my_shutdown ()

actions/processqueue.php, line 192

Arguments:
Return value:
Comments:

my_shutdown()

importlib.php, line 3

Arguments:
Return value:
Comments:

mysql_session_close()

sessionlib.php, line 38

Arguments:
Return value:
Comments:

mysql_session_destroy ($SessionID)

sessionlib.php, line 77

Arguments:
1. $SessionID
Return value:
Comments:

mysql_session_gc ($maxlifetime = 300)

sessionlib.php, line 84

Arguments:
1. $maxlifetime
Return value:
Comments:

mysql_session_open ($save_path, $session_name)

sessionlib.php, line 34

Arguments:
1. $savepath
  -$sessionname
Return value:
Comments:

mysql_session_read ($SessionID)

sessionlib.php, line 42

Arguments:
1. $SessionID
Return value:
Comments:

mysql_session_write ($SessionID, $val)

sessionlib.php, line 56

Arguments:
1. $SessionID
2. $val
Return value:
Comments:

name()

defaultplugin.php, line 73

Arguments:
Return value:
Comments:

next()

commonlib/lib/interfacelib.php, line 881

Arguments:
Return value:
Comments:

noHeader()

commonlib/lib/interfacelib.php, line 87

Arguments:
Return value:
Comments:

normalize($var)

connect.php, line 353

Arguments:
1. $var
Return value:
Comments:

noShader()

commonlib/lib/interfacelib.php, line 83

Arguments:
Return value:
Comments:

obscureCreditCard($cardno)

commonlib/lib/userlib.php, line 796

Arguments:
1. $cardno
Return value:
Comments:

ok()

fckphplist.php, line 181

Arguments:
Return value:
Comments:

openMbox($file)

readtestmail.php, line 202

Arguments:
1. $file
Return value:
Comments:

openPop($server, $user, $password)

readtestmail.php, line 182

Arguments:
1. $server
2. $user
3. $password
Return value:
Comments:

output ($message)

upgrade.php, line 14

Arguments:
1. $message
Return value:
Comments:

output ($message,$logit = 1,$target = 'summary')

actions/processqueue.php, line 312

Arguments:
1. $message
2. $logit
3. $target
Return value:
Comments:

output ($message,$reset = 0)

processbounces.php, line 53

Arguments:
1. $message
2. $reset
Return value:
Comments:

output($message)

generatebouncerules.php, line 14

Arguments:
1. $message
Return value:
Comments:

output($message, $reset= 0)

readtestmail.php, line 78

Arguments:
1. $message
2. $reset
Return value:
Comments:

output($msg)

importlib.php, line 8

Arguments:
1. $msg
Return value:
Comments:

output($text)

sendemaillib.php, line 8

Arguments:
1. $text
Return value:
Comments: