6 * Template for viewing a messages list
8 * The following variables are available in this template:
9 //FIXME: need to clean (and document) this list, it is just a dump of the array keys of $t
26 * $hide_sm_attributions
60 * $fancy_index_highlite
67 * $show_personal_names boolean When turned on, all email
68 * address fields should display
69 * the personal name and use the
70 * email address as a tool tip;
71 * When turned off, this logic
73 * $accesskey_mailbox_toggle_selected The access key to use for the toggle all checkbox
74 * $accesskey_mailbox_thread The access key to use for the Thread/Unthread links
76 * @copyright 1999-2021 The SquirrelMail Project Team
77 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
79 * @package squirrelmail
80 * @subpackage templates
84 /** add required includes */
85 include_once(SM_PATH . 'functions/template/message_list_util.php');
88 /* retrieve the template vars */
92 if (!empty($plugin_output['mailbox_index_before'])) echo $plugin_output['mailbox_index_before'];
96 * Calculate string "Viewing message x to y (z total)"
99 if ($pageOffset < $end_msg) {
100 $msg_cnt_str = sprintf(_("Viewing Messages: %s to %s (%s total)"),
101 '<em>' . $pageOffset . '</em>',
102 '<em>' . $end_msg . '</em>',
104 } else if ($pageOffset == $end_msg) {
105 $msg_cnt_str = sprintf(_("Viewing Message: %s (%s total)"),
106 '<em>' . $pageOffset . '</em>',
112 * All icon functionality is now handled through $icon_theme_path.
113 * $icon_theme_path will contain the path to the user-selected theme. If it is
114 * NULL, the user and/or admin have turned off icons.
119 <div id="message_list">
120 <form id="<?php echo $form_name;?>" name="<?php echo $form_name;?>" method="post" action="<?php echo $php_self;?>">
121 <input type="hidden" name="smtoken" value="<?php echo sm_generate_security_token(); ?>" />
122 <table class="table_empty" cellspacing="0">
125 <table class="table_standard" cellspacing="0">
128 <table class="table_empty" cellspacing="0">
130 <td class="links_paginator">
131 <!-- paginator and thread link string -->
134 * The following line gets the output from a separate
135 * template altogether (called "paginator.tpl").
136 * $this is the Template class object.
138 $paginator_str = $this->fetch('paginator.tpl');
139 echo $paginator_str . '<small>[<a href="' . $thread_link_uri
140 . ($accesskey_mailbox_thread != 'NONE'
141 ? '" accesskey="' . $accesskey_mailbox_thread . '">'
143 . $thread_name . '</a>]</small> ';
144 if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
146 <!-- end paginator and thread link string -->
148 <!-- message count string -->
149 <td class="message_count"><?php echo $msg_cnt_str; ?></td>
150 <!-- end message count string -->
156 if (count($aFormElements)) {
158 <!-- start message list form control -->
159 <tr class="message_list_controls">
163 * The following line gets the output from a separate
164 * template altogether (called "message_list_controls.tpl").
165 * $this is the Template class object.
167 $message_list_controls = $this->fetch('message_list_controls.tpl');
168 echo $message_list_controls ."\n"; ?>
171 <!-- end message list form control -->
173 } // if (count($aFormElements))
176 <?php if (!empty($plugin_output['mailbox_form_before'])) echo $plugin_output['mailbox_form_before']; ?>
179 <tr><td class="spacer"></td></tr>
182 <table class="table_messageListWrapper" cellspacing="0">
185 <table class="table_messageList" cellspacing="0">
186 <!-- table header start -->
189 * As an FYI, Firefox on Windows seems to have an issue w/ putting wierd breaks while
190 * rendering this table if we use THEAD and TH tags. No other browser or platform has
191 * this issue. We will use TR/TD w/ another CSS class to work around this.
195 <tr class="headerRow">
198 $aWidth = calcMessageListColumnWidth($aOrder);
199 foreach($aOrder as $iCol) {
202 <td style="width:<?php echo $aWidth[$iCol]; ?>%">
207 if ($javascript_on) {
208 $checked = ($checkall ? ' checked="checked" ' : '');
209 $accesskey = ($accesskey_mailbox_toggle_selected == 'NONE' ? ''
210 : ' accesskey="' . $accesskey_mailbox_toggle_selected . '" ');
211 echo '<input type="checkbox" name="toggleAll" id="toggleAll" title="'
212 . _("Toggle All") . '" onclick="toggle_all(\''
213 . $form_name . '\', \'msg\', ' . $fancy_index_highlite
214 . '); return false;" ' . $checked . $accesskey . '/>' . "\n";
217 . "&startMessage=$pageOffset&checkall="
218 . ($checkall ? '0' : '1');
219 echo "<a href=\"$link\">" . _("All") . '</a>';
223 echo '<label for="toggleAll">' . _("From") . "</label>\n";
225 case SQM_COL_DATE: echo _("Date") . "\n"; break;
226 case SQM_COL_SUBJ: echo _("Subject") . "\n"; break;
228 echo getIcon($icon_theme_path, 'msg_new.png', ' ', _("Message Flags")) . "\n";
230 case SQM_COL_SIZE: echo _("Size") . "\n"; break;
232 echo getIcon($icon_theme_path, 'prio_high.png', '!', _("Priority")) . "\n";
234 case SQM_COL_ATTACHMENT:
235 echo getIcon($icon_theme_path, 'attach.png', '+', _("Attachment")) . "\n";
237 case SQM_COL_INT_DATE: echo _("Received") . "\n"; break;
239 echo '<label for="toggleAll">' . _("To") . "</label>\n";
241 case SQM_COL_CC: echo _("Cc") . "\n"; break;
242 case SQM_COL_BCC: echo _("Bcc") . "\n"; break;
245 // add the sort buttons
246 if (isset($aSortSupported[$iCol])) {
247 if ($sort == $aSortSupported[$iCol][0]) {
248 $newsort = $aSortSupported[$iCol][1];
249 $img = 'up_pointer.png';
250 $text_icon = '⇧'; // U+21E7 UPWARDS WHITE ARROW
251 } else if ($sort == $aSortSupported[$iCol][1]) {
253 $img = 'down_pointer.png';
254 $text_icon = '⇩'; // U+21E9 DOWNWARDS WHITE ARROW
256 $newsort = $aSortSupported[$iCol][0];
257 $img = 'sort_none.png';
258 $text_icon = '◻'; // U+25FB WHITE MEDIUM SQUARE
260 /* Now that we have everything figured out, show the actual button. */
261 echo " <a href=\"$baseurl&startMessage=1&srt=$newsort\" style=\"text-decoration:none\">" .
262 getIcon($icon_theme_path, $img, $text_icon, _("Click here to change the sorting of the message list")) . "\n" .
271 <!-- end table header -->
273 <!-- Message headers start -->
277 $iColCnt = count($aOrder);
281 // this stuff does the auto row highlighting on mouseover
283 if (!empty($plugin_output['checkbox_javascript_onclick'])) $checkbox_javascript_onclick = $plugin_output['checkbox_javascript_onclick'];
284 else $checkbox_javascript_onclick = '';
286 if ($javascript_on && $fancy_index_highlite) {
287 $checkbox_javascript = ' onclick="this.checked = !this.checked; ' . $checkbox_javascript_onclick . '"';
288 } else if (!empty($checkbox_javascript_onclick)) {
289 $checkbox_javascript = ' onclick="' . $checkbox_javascript_onclick . '"';
291 $checkbox_javascript = '';
296 * main message iteration loop
298 foreach ($aMessages as $iUid => $aMsg) {
304 * Display message header row in messages list
308 $aColumns = $aMsg['columns'];
312 * Check the flags and set a class var.
314 if (isset($aColumns[SQM_COL_FLAGS])) {
315 $aFlags = $aColumns[SQM_COL_FLAGS]['value'];
316 $sFlags = getFlagIcon($aFlags, $icon_theme_path);
318 /* add the flag string to the value index */
319 $aColumns[SQM_COL_FLAGS]['value'] = $sFlags;
322 * Check the priority column
324 if (isset($aColumns[SQM_COL_PRIO])) {
325 $sValue = getPriorityIcon($aColumns[SQM_COL_PRIO]['value'], $icon_theme_path);
326 $aColumns[SQM_COL_PRIO]['value'] = $sValue;
330 * Check the attachment column
332 if (isset($aColumns[SQM_COL_ATTACHMENT])) {
333 $sValue = getAttachmentIcon($aColumns[SQM_COL_ATTACHMENT]['value'], $icon_theme_path);
334 $aColumns[SQM_COL_ATTACHMENT]['value'] = $sValue;
337 $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_even' : 'even');
338 $non_clicked_class = 'even';
341 * If alternating row colors is set, adapt the CSS class
343 if (isset($alt_index_colors) && $alt_index_colors) {
345 $class = (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite ? 'clicked_odd' : 'odd');
346 $non_clicked_class = 'odd';
352 * Message Highlighting Functionality
354 if (isset($aMsg['row']['color']))
356 if (($checkall || in_array($iUid, $preselected)) && $javascript_on && $fancy_index_highlite) {
357 //FIXME: would be best not to use $color directly here; want to move this to be a CSS style-defined value only, but the problem is that this CSS class is being defined on the fly right here
358 $bgcolor = $color[16];
359 $class = 'clicked_misc'.$i;
361 $bgcolor = $aMsg['row']['color'];
364 $non_clicked_class = 'misc'.$i;
365 $non_clicked_bgcolor = $aMsg['row']['color'];
370 $non_clicked_bgcolor = '';
375 // this stuff does the auto row highlighting on mouseover
377 if ($javascript_on && $fancy_index_highlite) {
378 $row_extra = ' onmouseover="rowOver(\''.$form_id . '_msg' . $i.'\');" onmouseout="setPointer(this, ' . $i . ', \'out\', \'' . $non_clicked_class . '\', \'mouse_over\', \'clicked\');" onmousedown="setPointer(this, ' . $i . ', \'click\', \'' . $non_clicked_class . '\', \'mouse_over\', \'clicked\');"';
380 // this does the auto-checking of the checkbox no matter
381 // where on the row you click
383 $javascript_auto_click = '';
384 $row_click_extra = '';
385 if (!empty($plugin_output['row_click_extra'])) $row_click_extra = $plugin_output['row_click_extra'];
386 if ($javascript_on && $fancy_index_highlite) {
387 // include the form_id in order to show multiple messages lists. Otherwise id isn't unique
388 $javascript_auto_click = " onmousedown=\"row_click('$form_id"."_msg$i', event, '$form_name', 'msg[' + $i + ']', '$row_click_extra')\"";
393 * Message Highlighting requires a unique CSS class declaration for proper
394 * mouseover functionality. There is no harm in doing this when the mouseover
395 * functionality is disabled
397 if ($class != 'even' && $class != 'odd'
398 && $class != 'clicked_even' && $class != 'clicked_odd')
401 <style type="text/css">
403 .table_messageList tr.<?php echo $class; ?> { background:<?php echo $bgcolor; ?> }
408 if ($non_clicked_class != 'even' && $non_clicked_class != 'odd'
409 && $non_clicked_class != 'clicked_even' && $non_clicked_class != 'clicked_odd')
412 <style type="text/css">
414 .table_messageList tr.<?php echo $non_clicked_class; ?> { background:<?php echo $non_clicked_bgcolor; ?> }
422 <tr <?php echo (empty($class) ? '' : 'class="'.$class.'" '); echo $row_extra;?>>
424 // flag style mumbo jumbo
426 if (isset($aColumns[SQM_COL_FLAGS])) {
427 if (!in_array('seen',$aFlags) || !$aFlags['seen']) {
428 $sPre = '<span class="unread">'; $sEnd = '</span>';
430 if (in_array('deleted',$aFlags) && $aFlags['deleted']) {
431 $sPre = '<span class="deleted">' . $sPre;
434 if (in_array('flagged',$aFlags) && $aFlags['flagged']) {
435 $sPre = '<span class="flagged">' . $sPre;
441 * Because the order of the columns and which columns to show is a user preference
442 * we have to do some php coding to display the columns in the right order
444 foreach ($aOrder as $iCol) {
445 if (in_array($iCol, $show_label_columns)) {
446 $sLabelStart = '<label for="'.$form_id."_msg$i\">";
447 $sLabelEnd = '</label>';
452 $aCol = (isset($aColumns[$iCol])) ? $aColumns[$iCol] : array();
453 $title = (isset($aCol['title'])) ? $aCol['title'] : '';
454 $link = (isset($aCol['link'])) ? $aCol['link'] : '';
455 $link_extra = (isset($aCol['link_extra'])) ? $aCol['link_extra'] : '';
456 $onclick = (isset($aCol['onclick'])) ? $aCol['onclick'] : '';
457 $value = (isset($aCol['value'])) ? $aCol['value'] : '';
458 $target = (isset($aCol['target'])) ? $aCol['target'] : '';
459 if (!$show_personal_names
461 && ($iCol == SQM_COL_FROM
462 || $iCol == SQM_COL_TO
463 || $iCol == SQM_COL_CC
464 || $iCol == SQM_COL_BCC)) {
465 // swap title and value
470 if ($iCol !== SQM_COL_CHECK) {
471 $value = $sLabelStart.$sPre.$value.$sEnd.$sLabelEnd;
477 $checked = (($checkall || in_array($iUid, $preselected)) ? ' checked="checked" ' : '');
478 if ($javascript_on) {
479 echo '<td class="col_check"'. $javascript_auto_click. '>' ?>
480 <input type="checkbox" name="<?php echo "msg[$i]";?>" id="<?php echo $form_id."_msg$i";?>" value="<?php echo $iUid;?>" <?php echo $checkbox_javascript . $checked;?> /></td>
483 echo '<td class="col_check">';
484 echo "<input type=\"checkbox\" name=\"msg[".$i."]\" id=\"".$form_id."_msg$i\" value=\"$iUid\" $checked/></td>";
488 $indent = $aCol['indent'];
489 $sText = " <td class=\"col_subject\" $javascript_auto_click>";
490 if ($align['left'] == 'left') {
491 $sText .= str_repeat(' ',$indent);
493 $sText .= "<a href=\"$link\"";
494 if ($target) { $sText .= " target=\"$target\""; }
495 if ($title) { $sText .= " title=\"$title\""; }
496 if ($onclick) { $sText .= " onclick=\"$onclick\""; }
497 if ($link_extra) { $sText .= " $link_extra"; }
498 if ($javascript_on && $fancy_index_highlite) {
499 $sText .= " onmousedown=\"row_click('$form_id"."_msg$i', event, '$form_name', 'msg[' + $i + ']', '$row_click_extra'); setPointer(this." . (empty($bold) ? '' : 'parentNode.') .
500 'parentNode.parentNode, ' . $i . ', \'click\', \''. $non_clicked_class. '\', \'mouse_over\', \'clicked\');"';
504 if ($align['left'] == 'right') {
505 $sText .= str_repeat(' ',$indent);
507 echo $sText."</td>\n";
511 $sText = " <td class=\"col_flags\" $javascript_auto_click>"
515 case SQM_COL_INT_DATE:
517 $sText = " <td class=\"col_date\" $javascript_auto_click";
518 if ($title) {$sText .= " title=\"$title\"";}
519 $sText .= ">" . $value. "</td>\n";
523 $sText = " <td class=\"col_text\" $javascript_auto_click";
525 $sText .= "><a href=\"$link\"";
526 if ($target) { $sText .= " target=\"$target\"";}
527 if ($title) { $sText .= " title=\"$title\"" ;}
530 if ($title) {$sText .= " title=\"$title\"";}
534 if ($link) { $sText .= '</a>';}
535 echo $sText."</td>\n";
541 $sLine = "<tr><td colspan=\"$iColCnt\" class=\"spacer\"></td></tr>\n";
545 * End displaying row part
550 <!-- Message headers end -->
557 <tr><td class="spacer"></td></tr>
560 <table class="table_standard" cellspacing="0">
563 <table class="table_empty" cellspacing="0">
565 <td class="links_paginator"><?php
567 * The following line gets the output from a separate
568 * template altogether (called "paginator.tpl").
569 * $this is the Template class object.
571 $paginator_str = $this->fetch('paginator.tpl');
573 if (!empty($plugin_output['mailbox_paginator_after'])) echo $plugin_output['mailbox_paginator_after'];
575 <td class="message_count"><?php echo $msg_cnt_str; ?></td>
585 <?php if (!empty($plugin_output['mailbox_index_after'])) echo $plugin_output['mailbox_index_after']; ?>
592 <?php if (!$hide_sm_attributions): ?>
593 <p class="sqm_squirrelcopyright">© <?php echo SM_COPYRIGHT ?> The SquirrelMail Project Team - <a href="about.php">About SquirrelMail</a></p>