File/plugins/mini/functions.php

Description
Description | Functions

functions.php

Some functions for the mini plugin

  • version: $Id: functions.php 1099 2007-12-20 09:57:57Z tokul $
  • copyright: (c) 2002-2004 Jason Munro
  • copyright: (c) 2005 The SquirrelMail Project Team
  • license: GNU Public License
Functions
Description | Functions
get_mini_headers (line 228)

gets the subject and from for a list of messges

  • return: message data
array get_mini_headers (stream $imapConn, string $mailbox, array $ids)
  • stream $imapConn: imap connection resource
  • string $mailbox: imap folder
  • array $ids: message ids
get_mini_list (line 182)

returns a list of folders with the message numbers of mail that is new

  • return: new messages
array get_mini_list (stream $imapConn)
  • stream $imapConn: imap connection resource
mini_array_to_int (line 287)

callback function used in get_mini_headers

converts array values to integers

  • since: 0.3
void mini_array_to_int ( &$value, mixed $key, mixed $value)
  • mixed $value: array value (will be converted to integer)
  • mixed $key: array key
  • &$value
mini_formatBody (line 303)

Stripped version of squirrelmail formatBody() from functions/mime.php.

removed hooks, view_unsafe_image and download as file code. replaced translateText function with own stripped version

  • since: 0.3
string mini_formatBody (stream $imap_stream, object $message, integer $wrap_at, string $ent_num, integer $id)
  • stream $imap_stream: imap connection resource
  • object $message: message object
  • integer $wrap_at: text wrapping
  • string $ent_num: message entity
  • integer $id: message id
mini_link_function (line 19)

link on the left frame for mini window (internal function)

  • since: 0.3
void mini_link_function ()
mini_message (line 131)

returns the text entity of the message or an explination about why it could not

  • return: formated message text
string mini_message (stream $imapConn, string $mailbox, string $id)
  • stream $imapConn: imap connection resource
  • string $mailbox: mailbox name
  • string $id: message id
mini_register_block_function (line 48)

Add display option block (internal function)

  • since: 0.3
void mini_register_block_function ()
mini_settings_function (line 109)

Load settings (internal function)

  • since: 0.3
void mini_settings_function ()
mini_translateText (line 332)

Stripped version of translateText() from functions/mime.php Url parsing and quote coloring removed.

  • since: 0.3
void mini_translateText ( &$body, integer $wrap_at, charset $charset, string $body)
  • string $body: message body
  • integer $wrap_at: line length
  • charset $charset: text encoding
  • &$body

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