/functions/page_header.php

Description

page_header.php

Prints the page header (duh)

Includes
include_once (SM_PATH.'functions/imap_mailbox.php') (line 15)

Include required files from SM

Functions
compose_Header (line 348)

Blatantly copied/truncated/modified from displayPageHeader.

Outputs a page header specifically for the compose_in_new popup window

void compose_Header (array $color, string $mailbox, [string $sHeaderJs = ''], [string $sOnload = ''])
  • array $color: color the array of theme colors
  • string $mailbox: mailbox the current mailbox name to display
  • string $sHeaderJs: sHeaderJs javascipt code to be inserted in a script block in the header
  • string $sOnload: sOnload JavaScript code to be added inside the body's onload handler as of 1.5.2, this replaces $sBodyTagJs argument
displayHtmlHeader (line 32)

Output a SquirrelMail page header, from <!doctype> to </head> Always set up the language before calling these functions.

Since 1.5.1 function sends http headers. Function should be called before any output is started.

void displayHtmlHeader ([string $title = 'SquirrelMail'], [string $xtra = ''], [bool $do_hook = TRUE], [bool $frames = FALSE], [bool $browser_cache_ok = FALSE])
  • bool $browser_cache_ok: When TRUE, it's OK to leave out the no-cache browser headers (OPTIONAL; default = FALSE, send no-cache headers)
  • string $title: title the page title, default SquirrelMail.
  • string $xtra: xtra extra HTML to insert into the header
  • bool $do_hook: do_hook whether to execute hooks, default true
  • bool $frames: frames generate html frameset doctype (since 1.5.1)
displayPageHeader (line 236)

Outputs a complete SquirrelMail page header, starting with <!doctype> and including the default menu bar. Uses displayHtmlHeader and takes JavaScript and locale settings into account.

void displayPageHeader (array $color, [string $mailbox = ''], [string $sHeaderJs = ''], [string $sOnload = ''])
  • array $color: color the array of theme colors
  • string $mailbox: mailbox the current mailbox name to display
  • string $sHeaderJs: sHeaderJs javascipt code to be inserted in a script block in the header
  • string $sOnload: sOnload JavaScript code to be added inside the body's onload handler as of 1.5.2, this replaces $sBodyTagJs argument
makeInternalLink (line 204)

Given a path to a SquirrelMail file, return a HTML link to it

void makeInternalLink (string $path, string $text, [string $target = ''], [string $accesskey = 'NONE'])
  • string $path: The SquirrelMail file to link to (should start with something like "src/..." or "functions/..." or "plugins/..." etc.)
  • string $text: The link text
  • string $target: The target frame for this link
  • string $accesskey: The access key to be used, if any

Documentation generated on Thu, 21 Aug 2014 04:19:04 +0200 by phpDocumentor 1.4.3