File/nasmail/functions/mailbox_display.php

Description
Description | Includes | Functions

This contains functions that display mailbox information, such as the table row that has sender, date, subject, etc...

This script contains modifications ported from SquirrelMail 1.4.9+. See commits tagged with SM-PATCH keyword. Modifications are copyrighted by the SquirrelMail Project Team. Copyright (c) 2007 The SquirrelMail Project Team

This script contains size sorting patches by Christopher E. Brown.

  • version: $Id: mailbox_display.php 1454 2009-10-28 11:46:14Z tokul $
  • copyright: (c) 1999-2006 The SquirrelMail Project Team
  • copyright: (c) 2006-2009 The NaSMail Project
  • license: GNU Public License
Includes
Description | Includes | Functions
include_once (SM_PATH.'functions/imap_mailbox.php') (line 24)
include_once (SM_PATH.'functions/strings.php') (line 21)

The standard includes..

include_once (SM_PATH.'functions/forms.php') (line 23)
include_once (SM_PATH.'functions/html.php') (line 22)
Functions
Description | Includes | Functions
calc_msort (line 740)

Sorts messages

  • return: sorted messages
array calc_msort (array $msgs, int $sort)
  • array $msgs: array with message information
  • int $sort
create_flag_string (line 410)

Function creates icon string according to use_icons user setting

  • return: html formated image tag or alternative text
string create_flag_string (string $link, string $name, string $alt, [string $attribs = ''])
  • string $link: Image link relative to base url
  • string $name: Image title. Text displayed when cursor hoovers over image.
  • string $alt: Alternative text. Text should be short for visual elements. Use of single US-ASCII human readable symbol (or translation of one character) is recommended.
  • string $attribs: image attributes
displayMessageArray (line 816)

Generic function to convert the msgs array into an HTML table.

void displayMessageArray (stream $imapConnection, int $num_msgs, int $start_msg, array $msort, string $mailbox, int $sort, array $color, int $show_num, [string $where = 0], [string $what = 0])
  • stream $imapConnection: imapConnection IMAP connection resource
  • int $num_msgs: num_msgs total number of messages in mailbox
  • int $start_msg: start_msg first message
  • array $msort: msort sorted messages
  • string $mailbox: mailbox mailbox
  • int $sort: sort sorting order
  • array $color: color color theme
  • int $show_num: show_num number of displayed messages
  • string $where: where search location
  • string $what: what search criteria
elapsed (line 33)

calculates difference between given microtime() value and current microtime() value

FIXME: profiling function

  • return: time difference in seconds
  • deprecated: 1.2 - 2007.06.16 - function will be removed in NaSMail 2.0. Don't use it in released plugins.
float elapsed (string $start)
  • string $start: tested microtime() value
fillMessageArray (line 798)

Gets information about selected messages

  • return: result
unknown fillMessageArray (stream $imapConnection, array|string $id, mixed $count, [int $show_num = false])
  • stream $imapConnection: imapConnection IMAP connection resource
  • array|string $id: id array or string with message ids. string must follow IMAP message sequence set format
  • mixed $count: count Unused argument
  • int $show_num: show_num number of displayed messages
getEndMessage (line 1658)

Calculates last message

  • return: first and last message
array getEndMessage (int $start_msg, int $show_num, int $num_msgs)
  • int $start_msg: start_msg first message
  • int $show_num: show_num number of messages
  • int $num_msgs: num_msgs total number of messages in mailbox
getMbxList (line 1628)

Creates targetMailbox selection box

void getMbxList (stream $imapConnection, [string $suffix = ''])
  • stream $imapConnection: IMAP connection resource
  • string $suffix: (since 1.4) Mailbox dropdown suffix
getSelfSortMessages (line 491)

Gets information about messages sorted by PHP based sorting functions

array getSelfSortMessages (stream $imapConnection, int $start_msg, int $show_num, int $num_msgs, int $sort, unknown_type $mbxresponse)
  • stream $imapConnection
  • int $start_msg
  • int $show_num
  • int $num_msgs
  • int $sort
  • unknown_type $mbxresponse
getServerMessages (line 432)

Gets information about messages.

Function works with results of get_thread_sort() and sqimap_get_sort_order().

  • return: array
array getServerMessages (stream $imapConnection, int $start_msg, int $show_num, int $num_msgs, string $id)
  • stream $imapConnection: imapConnection
  • int $start_msg: start_msg first message
  • int $show_num: show_num number of displayed messages
  • int $num_msgs: num_msgs total number of messages in mailbox
  • string $id: id message ids from response to THREAD or SORT command
getServerSortMessages (line 474)

Gets information about messages sorted by server based sorting functions

unknown getServerSortMessages (stream $imapConnection, int $start_msg, int $show_num, int $num_msgs, array $server_sort_order, array $mbxresponse)
  • stream $imapConnection
  • int $start_msg
  • int $show_num
  • int $num_msgs
  • array $server_sort_order
  • array $mbxresponse
getSmallStringCell (line 1642)

Creates small aligned cell

  • return: html formated table cell
string getSmallStringCell (string $string, string $align)
  • string $string: string cell contents. Function adds ': ' trailing text
  • string $align: align alignment
getThreadMessages (line 458)

Gets information about messages sorted by server based threading functions

  • return: array
array getThreadMessages (stream $imapConnection, int $start_msg, int $show_num, int $num_msgs)
  • stream $imapConnection: imapConnection IMAP connection resource
  • int $start_msg: start_msg first message
  • int $show_num: show_num number of displayed messages
  • int $num_msgs: num_msgs total number of message in mailbox
get_msgcnt_str (line 1323)

Computes the "Viewing Messages..." string

string get_msgcnt_str (int $start_msg, int $end_msg, int $num_msgs)
  • int $start_msg: start_msg first message
  • int $end_msg: end_msg last message
  • int $num_msgs: num_msgs total number of messages in mailbox
get_paginator_link (line 1347)

Generates a paginator link.

  • return: paginator link
string get_paginator_link (string $box, int $start_msg, int $use, string $text)
  • string $box: box mailbox name
  • int $start_msg: start_msg first message
  • int $use: use controls use_mailbox_cache flag
  • string $text: text link text
get_paginator_str (line 1364)

Computes the paginator string

string get_paginator_str (string $box, int $start_msg, int $end_msg, int $num_msgs, int $show_num, int $sort)
  • string $box: box Mailbox current mailbox name
  • int $start_msg: start_msg first message
  • int $end_msg: end_msg last message
  • int $num_msgs: num_msgs number of messages in mailbox
  • int $show_num: show_num displayed number of messages
  • int $sort: sort current sorting order
get_selectall_link (line 1260)

Creates "Select All" link

string get_selectall_link (int $start_msg, int $sort)
  • int $start_msg
  • int $sort
handleAsSent (line 1681)

Checks if mailbox should be handled as Sent folder

Function executes 'check_handleAsSent_result' hook

boolean handleAsSent (string $mailbox)
  • string $mailbox: mailbox checked mailbox name
mail_message_listing_beginning (line 908)

Prints mailbox top listing row with control buttons

Sixth argument (start_msg=1) was removed in 1.3

void mail_message_listing_beginning (stream $imapConnection, [string $mailbox = ''], [int $sort = -1], [string $msg_cnt_str = ''], [string $paginator = ' '])
  • stream $imapConnection: imapConnection IMAP connection resource (Unused argument)
  • string $mailbox: mailbox Current mailbox
  • int $sort: sort Current sorting order (-1 = no sorting)
  • string $msg_cnt_str: msg_cnt_str Viewing messages string
  • string $paginator: paginator Paginator string
mail_message_listing_end (line 951)

Prints footer of mailbox listing

void mail_message_listing_end (int $num_msgs, string $paginator_str, string $msg_cnt_str, array $color, [string $mailbox = ''])
  • int $num_msgs: Number of displayed messages. Before 1.3 setting was set to total number of messages in mailbox.
  • string $paginator_str: Paginator string
  • string $msg_cnt_str: Viewing messages string
  • array $color: Color theme
  • string $mailbox: Current mailbox (since 1.3)
nsm_print_mailbox_controls (line 1001)

Prints mailbox controls

Function is used internally by mail_message_listing_beginning() and mail_message_listing_end().

  • since: 1.3
void nsm_print_mailbox_controls (string $mailbox, int $sort, [boolean $second_ctrl = false])
  • string $mailbox: Current mailbox name
  • int $sort: Sorting order
  • boolean $second_ctrl: (since 1.4) Is used to detect bottom mailbox controls
printHeader (line 1150)

Prints mailbox display header

void printHeader (string $mailbox, int $sort, array $color, [boolean $showsort = true])
  • array $color: color theme
  • boolean $showsort
  • string $mailbox: mailbox Current mailbox
  • int $sort: sort Current sorting order
printMessageInfo (line 59)

Prints html row with message info

  • todo: add order7 for $msg['TO']
void printMessageInfo (stream $imapConnection, int $t, [boolean $not_last = true], int $key, string $mailbox, int $start_msg, string $where, string $what)
  • boolean $not_last: Last row indicator
  • int $key: message id
  • string $mailbox: Mailbox
  • int $start_msg: starting message number. Used for pagination
  • string $where: Search location.
  • string $what: Search criteria.
  • stream $imapConnection: imapConnection IMAP connection resource
  • int $t: t Row number
processSubject (line 1568)

Truncates subject

  • return: truncated string
  • deprecated: Use truncateWithEntities()
string processSubject (string $subject, [int $threadlevel = 0])
  • string $subject: subject Subject string
  • int $threadlevel: threadlevel threading level
showMessagesForMailbox (line 545)

Prints information about messages based on interface configuration

This function loops through a group of messages in the mailbox and shows them to the user.

void showMessagesForMailbox (stream_type $imapConnection, string $mailbox, int $num_msgs, int $start_msg, int $sort, array $color, int $show_num, boolean $use_cache, [string $mode = ''])
  • stream_type $imapConnection
  • string $mailbox
  • int $num_msgs
  • int $start_msg
  • int $sort
  • array $color
  • int $show_num
  • boolean $use_cache
  • string $mode: unused
ShowSortButton (line 1223)

Creates sorting button

void ShowSortButton (int $sort, string $mailbox, int $Up, int $Down)
  • int $sort: current sorting order
  • string $mailbox: mailbox name
  • int $Up: ascending sorting order
  • int $Down: descending sorting order

Documentation generated on Sun, 22 Nov 2009 17:36:41 +0200 by phpDocumentor 1.4.3