squirrelmail-webmail  1.4.22
About: SquirrelMail is a standards-based webmail package with strong MIME support, address books, and folder manipulation (written in PHP4).
  Fossies Dox: squirrelmail-webmail-1.4.22.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

folder.php File Reference

Go to the source code of this file.

Namespaces

 squirrelmail
 

Functions

 load_optpage_data_folder ()
 
 save_option_trash_folder ($option)
 
 save_option_sent_folder ($option)
 
 save_option_draft_folder ($option)
 

Variables

const SMOPT_GRP_SPCFOLDER 0
 
const SMOPT_GRP_FOLDERLIST 1
 
const SMOPT_GRP_FOLDERSELECT 2
 

Function Documentation

◆ load_optpage_data_folder()

load_optpage_data_folder ( )

This function builds an array with all the information about the options available to the user, and returns it. The options are grouped by the groups in which they are displayed. For each option, the following information is stored:

  • name: the internal (variable) name
  • caption: the description of the option in the UI
  • type: one of SMOPT_TYPE_*
  • refresh: one of SMOPT_REFRESH_*
  • size: one of SMOPT_SIZE_*
  • save: the name of a function to call when saving this option
    Returns
    array all option information

Definition at line 36 of file folder.php.

References $boxes, $default_folder_prefix, $folder_prefix, $imapConnection, $imapPort, $imapServerAddress, $left_size_values, $show_prefix_option, $username, _(), SMOPT_GRP_FOLDERLIST, SMOPT_GRP_FOLDERSELECT, SMOPT_GRP_SPCFOLDER, SMOPT_REFRESH_ALL, SMOPT_REFRESH_FOLDERLIST, SMOPT_REFRESH_NONE, SMOPT_SIZE_LARGE, SMOPT_TYPE_BOOLEAN, SMOPT_TYPE_FLDRLIST, SMOPT_TYPE_STRING, SMOPT_TYPE_STRLIST, SMPREF_LOC_LEFT, SMPREF_LOC_RIGHT, SMPREF_NONE, SMPREF_TIME_12HR, SMPREF_TIME_24HR, SMPREF_UNSEEN_ALL, SMPREF_UNSEEN_INBOX, SMPREF_UNSEEN_NONE, SMPREF_UNSEEN_ONLY, SMPREF_UNSEEN_TOTAL, sqimap_get_delimiter(), sqimap_login(), sqimap_logout(), and sqimap_mailbox_list().

◆ save_option_draft_folder()

save_option_draft_folder (   $option)

Saves the draft folder option.

Parameters
object$optionSquirrelOption object
Since
1.3.2

Definition at line 296 of file folder.php.

References $data_dir, $username, _(), error_option_save(), save_option(), setPref(), SMPREF_NONE, SMPREF_OFF, and SMPREF_ON.

◆ save_option_sent_folder()

save_option_sent_folder (   $option)

Saves the sent folder option.

Parameters
object$optionSquirrelOption object
Since
1.3.2

Definition at line 275 of file folder.php.

References $data_dir, $username, _(), error_option_save(), save_option(), setPref(), SMPREF_NONE, SMPREF_OFF, and SMPREF_ON.

◆ save_option_trash_folder()

save_option_trash_folder (   $option)

Define any specialized save functions for this option page. Saves the trash folder option.

Parameters
object$optionSquirrelOption object
Since
1.3.2

Definition at line 254 of file folder.php.

References $data_dir, $username, _(), error_option_save(), save_option(), setPref(), SMPREF_NONE, SMPREF_OFF, and SMPREF_ON.

Variable Documentation

◆ SMOPT_GRP_FOLDERLIST

const SMOPT_GRP_FOLDERLIST 1

Definition at line 20 of file folder.php.

Referenced by load_optpage_data_folder().

◆ SMOPT_GRP_FOLDERSELECT

const SMOPT_GRP_FOLDERSELECT 2

Definition at line 21 of file folder.php.

Referenced by load_optpage_data_folder().

◆ SMOPT_GRP_SPCFOLDER

const SMOPT_GRP_SPCFOLDER 0

SquirrelMail required files.

Definition at line 19 of file folder.php.

Referenced by load_optpage_data_folder().