=====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.
|[[http://resources.phplist.com/develop/functionh|Back]]|   [[http://resources.phplist.com/develop/functionndx|Up to Index]]  |    [[http://resources.phplist.com/develop/functionp|Next]]|
====M, N, O====
===mailBoxName($mailbox,$delimiter,$level)===
<code>import3.php, line 42</code>
  * Arguments:
    -$mailbox
    -$delimiter
    -$level
  * Return value:
  * Comments:
===mailBoxParent($mailbox,$delimiter,$level)===
<code>import3.php, line 51</code>
  * Arguments:
    -$mailbox
    -$delimiter
    -$level
  * Return value:
  * Comments:
===MailSend($header, $body)===
<code>class.phplistmailer.php, line 587</code>
  * Arguments:
    -$header
    -$body
  * Return value:
  * Comments:
===mailto2href($text)===
<code>sendemaillib.php, line 1028</code>
  * Arguments:
    -$text
  * Return value:
  * Comments:
===mailURL( $sTo, $sFrom, $sSubject, $sUrl )===
<code>commonlib/lib/maillib.php, line 169</code>
  * Arguments:
    -$sTo
    -$sFrom
    -$sSubject
    -$sUrl
  * Return value:
  * Comments:
===main()===
<code>readtestmail.php, line 270</code>
  * Arguments:
  * Return value:
  * Comments:
===matchBounceRules($text,$rules = array())===
<code>lib.php, line 1323</code>
  * Arguments:
    -$text
    -$rules
  * Return value:
  * Comments:
===matchedBounceRule($text,$activeonly = 0)===
<code>lib.php, line 1302</code>
  * Arguments:
    -$text
    -$activeonly
  * Return value:
  * Comments:
===mergeUser($userid)===
<code>reconcileusers.php, line 75</code>
  * Arguments:
    -$userid
  * Return value:
  * Comments:
===mergeUsers($original,$duplicate)===
<code>mergeduplicates.php, line 8</code>
  * Arguments:
    -$original
    -$duplicate
  * Return value:
  * Comments:
===messageHeaders($mail)===
<code>defaultplugin.php, line 487</code>
  * **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:**
    -$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)===
<code>defaultplugin.php, line 633</code>
  * **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:**
    -$id: The numerical id of the message in the database.
  * **Return value:** None
  * **Comments:**
===messageQueueFinished()===
<code>defaultplugin.php, line 648</code>
  * Arguments:
  * Return value:
  * Comments:
===messageReQueued($id)===
<code>defaultplugin.php, line 642</code>
  * **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:**
    -$id: The numerical id of the message in the database.
  * **Return value:** None
  * **Comments:**
===messageStatus($id,$status)===
<code>defaultplugin.php, line 409</code>
  * Arguments:
    -$id
    -$status
  * Return value:
  * Comments:
===messageStatusLimitReached($recentlySent)===
<code>defaultplugin.php, line 399</code>
  * Arguments:
    -$recentlySent
  * Return value:
  * Comments:
===mimeWrap($messageid, $body, $header, $contenttype, $destination)===
<code>defaultplugin.php, line 449</code>
  * Arguments:
    -$messageid
    -$body
    -$header
    -$contenttype
    -$destination
  * Return value:
  * Comments:
===missingText($text)===
<code>languages.php, line 381</code>
  * Arguments:
    -$text
  * Return value:
  * Comments:
===monthName($month,$short=0)===
<code>systemstats.php, line 9</code>
  * Arguments:
    -$month
    -$short
  * Return value:
  * Comments:
===moveUser($userid)===
<code>reconcileusers.php, line 118</code>
  * Arguments:
    -$userid
  * Return value:
  * Comments:
===my_shutdown ()===
<code>actions/processqueue.php, line 192</code>
  * Arguments:
  * Return value:
  * Comments:
===my_shutdown()===
<code>importlib.php, line 3</code>
  * Arguments:
  * Return value:
  * Comments:
===mysql_session_close()===
<code>sessionlib.php, line 38</code>
  * Arguments:
  * Return value:
  * Comments:
===mysql_session_destroy ($SessionID)===
<code>sessionlib.php, line 77</code>
  * Arguments:
    -$SessionID
  * Return value:
  * Comments:
===mysql_session_gc ($maxlifetime = 300)===
<code>sessionlib.php, line 84</code>
  * Arguments:
    -$maxlifetime
  * Return value:
  * Comments:
===mysql_session_open ($save_path, $session_name)===
<code>sessionlib.php, line 34</code>
  * Arguments:
    -$save_path
    -$session_name
  * Return value:
  * Comments:
===mysql_session_read ($SessionID)===
<code>sessionlib.php, line 42</code>
  * Arguments:
    -$SessionID
  * Return value:
  * Comments:
===mysql_session_write ($SessionID, $val)===
<code>sessionlib.php, line 56</code>
  * Arguments:
    -$SessionID
    -$val
  * Return value:
  * Comments:
===name()===
<code>defaultplugin.php, line 73</code>
  * Arguments:
  * Return value:
  * Comments:
===next()===
<code>commonlib/lib/interfacelib.php, line 881</code>
  * Arguments:
  * Return value:
  * Comments:
===noHeader()===
<code>commonlib/lib/interfacelib.php, line 87</code>
  * Arguments:
  * Return value:
  * Comments:
===normalize($var)===
<code>connect.php, line 353</code>
  * Arguments:
    -$var
  * Return value:
  * Comments:
===noShader()===
<code>commonlib/lib/interfacelib.php, line 83</code>
  * Arguments:
  * Return value:
  * Comments:
===obscureCreditCard($cardno)===
<code>commonlib/lib/userlib.php, line 796</code>
  * Arguments:
    -$cardno
  * Return value:
  * Comments:
===ok()===
<code>fckphplist.php, line 181</code>
  * Arguments:
  * Return value:
  * Comments:
===openMbox($file)===
<code>readtestmail.php, line 202</code>
  * Arguments:
    -$file
  * Return value:
  * Comments:
===openPop($server, $user, $password)===
<code>readtestmail.php, line 182</code>
  * Arguments:
    -$server
    -$user
    -$password
  * Return value:
  * Comments:
===output ($message)===
<code>upgrade.php, line 14</code>
  * Arguments:
    -$message
  * Return value:
  * Comments:
===output ($message,$logit = 1,$target = 'summary')===
<code>actions/processqueue.php, line 312</code>
  * Arguments:
    -$message
    -$logit
    -$target
  * Return value:
  * Comments:
===output ($message,$reset = 0)===
<code>processbounces.php, line 53</code>
  * Arguments:
    -$message
    -$reset
  * Return value:
  * Comments:
===output($message)===
<code>generatebouncerules.php, line 14</code>
  * Arguments:
    -$message
  * Return value:
  * Comments:
===output($message, $reset= 0)===
<code>readtestmail.php, line 78</code>
  * Arguments:
    -$message
    -$reset
  * Return value:
  * Comments:
===output($msg)===
<code>importlib.php, line 8</code>
  * Arguments:
    -$msg
  * Return value:
  * Comments:
===output($text)===
<code>sendemaillib.php, line 8</code>
  * Arguments:
    -$text
  * Return value:
  * Comments:
~
|[[http://resources.phplist.com/develop/functionh|Back]]|   [[http://resources.phplist.com/develop/functionndx|Up to Index]]  |    [[http://resources.phplist.com/develop/functionp|Next]]|