Source for file setup.php

Documentation is available at setup.php

  1. <?php
  2.  
  3. /**
  4.  * SquirrelMail Preview Pane Plugin
  5.  *
  6.  * @copyright 1999-2018 The SquirrelMail Project Team
  7.  * @author Paul Lesniewski <paul@squirrelmail.org>
  8.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  9.  * @version $Id: setup.php 14750 2018-01-16 23:44:07Z pdontthink $
  10.  * @package plugins
  11.  * @subpackage preview_pane
  12.  */
  13.  
  14.  
  15. /**
  16.  * Register this plugin with SquirrelMail
  17.  */
  18. {
  19.  
  20.    global $squirrelmail_plugin_hooks;
  21.  
  22.  
  23.    $squirrelmail_plugin_hooks['subject_link']['preview_pane'
  24.       = 'preview_pane_change_message_target';
  25.    $squirrelmail_plugin_hooks['optpage_loadhook_display']['preview_pane'
  26.       = 'preview_pane_show_options';
  27.    $squirrelmail_plugin_hooks['template_construct_message_list.tpl']['preview_pane']
  28.       = 'preview_pane_message_list';
  29.    $squirrelmail_plugin_hooks['template_construct_page_header.tpl']['preview_pane']
  30.       = 'preview_pane_open_close_buttons';
  31.  
  32. }
  33.  
  34.  
  35. if (!defined('SM_PATH'))
  36.    define('SM_PATH''../');
  37.  
  38.  
  39. /**
  40.  * Returns info about this plugin
  41.  */
  42. function preview_pane_info()
  43. {
  44.  
  45.    return array(
  46.                  'english_name' => 'Preview Pane',
  47.                  'version' => '2.0',
  48.                  'required_sm_version' => '1.5.2',
  49.                  'requires_configuration' => 0,
  50.                  'requires_source_patch' => 0,
  51.                  'required_plugins' => array(
  52.                                             ),
  53.                  'summary' => 'Provides a third frame below the message list for viewing message bodies.',
  54.                  'details' => 'This plugin allows the user to turn on an extra frame below the mailbox message list where the messages themselves are displayed, very similar to many other popular (typically non-web-based) email clients.',
  55.                );
  56.  
  57. }
  58.  
  59.  
  60.  
  61. /**
  62.  * Returns version info about this plugin
  63.  */
  64. {
  65.  
  66.    $info preview_pane_info();
  67.    return $info['version'];
  68.  
  69. }
  70.  
  71.  
  72.  
  73. /**
  74.  * Build user options for display on "Display Preferences" page
  75.  */
  76. {
  77.  
  78.   include_once(SM_PATH 'plugins/preview_pane/functions.php');
  79.  
  80. }
  81.  
  82.  
  83.  
  84. /**
  85.  * Construct button that clears out any preview pane
  86.  * contents and inserts JavaScript function used by
  87.  * message subject link onclick handler.  Also disallows
  88.  * the message list to be loaded into the bottom frame.
  89.  */
  90. {
  91.  
  92.   include_once(SM_PATH 'plugins/preview_pane/functions.php');
  93.  
  94. }
  95.  
  96.  
  97.  
  98. /**
  99.  * Points message targets to open in the preview pane
  100.  * (and possibly refresh message list as well)
  101.  */
  102. {
  103.  
  104.   include_once(SM_PATH 'plugins/preview_pane/functions.php');
  105.  
  106. }
  107.  
  108.  
  109.  
  110. /**
  111.  * Adds preview pane open/close (and clear) buttons next to
  112.  * "provider link"
  113.  */
  114. {
  115.  
  116.   include_once(SM_PATH 'plugins/preview_pane/functions.php');
  117.  
  118. }

Documentation generated on Tue, 17 Apr 2018 04:24:21 +0200 by phpDocumentor 1.4.3