[ Index ]
 

Code source de IMP H3 (4.1.5)

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/lib/ -> IMP.php (sommaire)

Send Message w/no encryption.

Poids: 1362 lignes (48 kb)
Inclus ou requis: 2 fois
Référencé: 0 fois
Nécessite: 1 fichier
 lib/Folder.php

Définit 1 class

IMP:: (31 méthodes):
  getAutoLoginServer()
  canAutoLogin()
  checkAuthentication()
  isPreferredServer()
  serverString()
  getLabel()
  bareAddress()
  expandAddresses()
  addAddress()
  parseAddressList()
  flistSelect()
  getComposeArgs()
  openComposeWin()
  composeLink()
  logoutUrl()
  displayFolder()
  filterText()
  hasPermission()
  getMenu()
  status()
  getNewMessagePopup()
  prefsURL()
  printMode()
  parseIndicesList()
  loginTasksFlag()
  getNamespace()
  defaultNamespace()
  folderPref()
  appendNamespace()
  generateSearchUrl()
  getSearchParameters()


Classe: IMP  - X-Ref

IMP Base Class.

$Horde: imp/lib/IMP.php,v 1.449.4.71 2007/05/04 16:36:38 jan Exp $

Copyright 1999-2007 Chuck Hagenbuch <chuck@horde.org>
Copyright 1999-2007 Jon Parise <jon@horde.org>
Copyright 2002-2007 Michael Slusarz <slusarz@bigworm.colorado.edu>

See the enclosed file COPYING for license information (GPL). If you did not
receive this file, see http://www.fsf.org/copyleft/gpl.html.

getAutoLoginServer($first = false)   X-Ref
Returns the AutoLogin server key.

param: boolean $first  Return the first value?
return: string  The server key.

canAutoLogin($server_key = null, $force = false)   X-Ref
Returns whether we can log in without a login screen for $server_key.

param: string $server_key  The server to check. Defaults to
param: boolean $force      If true, check $server_key even if there is
return: boolean  True or false.

checkAuthentication($flags = 0, $return = false)   X-Ref
Makes sure the user has been authenticated to view the page.

param: mixed $flags     Any flags to pass to imap_open(). See
param: boolean $return  If this is true, return false instead of
return: boolean  True on success, false on error.

isPreferredServer($server, $key = null)   X-Ref
Determines if the given mail server is the "preferred" mail server for
this web server.  This decision is based on the global 'SERVER_NAME'
and 'HTTP_HOST' server variables and the contents of the 'preferred'
either field in the server's definition.  The 'preferred' field may
take a single value or an array of multiple values.

param: string $server  A complete server entry from the $servers hash.
param: TODO $key       TODO
return: boolean  True if this entry is "preferred".

serverString($mbox = null, $protocol = null)   X-Ref
Generates a full c-client server specification string.

param: string $mbox      The mailbox to append to end of the server
param: string $protocol  Override the protocol currently being used.
return: string  The full spec string.

getLabel()   X-Ref
Returns the plain text label that is displayed for the current mailbox,
replacing IMP_SEARCH_MBOX with an appropriate string and removing
namespace and folder prefix information from what is shown to the user.

return: string  The plain text label.

bareAddress($address, $multiple = false)   X-Ref
Returns the bare address.

param: string $address    The address string.
param: boolean $multiple  Should we return multiple results?
return: mixed  See {@link MIME::bareAddress}.

expandAddresses($addrString, $full = false)   X-Ref
Uses the Registry to expand names and returning error information for
any address that is either not valid or fails to expand.

param: string $addrString  The name(s) or address(es) to expand.
param: boolean $full       If true generate a full, rfc822-valid address
return: mixed   Either a string containing all expanded addresses or an

addAddress($newAddress, $newName)   X-Ref
Adds a contact to the user defined address book.

param: string $newAddress  The contact's email address.
param: string $newName     The contact's name.
return: string  A link or message to show in the notification area.

parseAddressList($address)   X-Ref
Parses an address or address list into the address components,
automatically choosing the best suited parsing method.

param: string $address  An address or address list.
return: array  A list of address objects.

flistSelect($heading = '', $abbrev = true, $filter = array()   X-Ref
Wrapper around IMP_Folder::flist() which generates the body of a
&lt;select&gt; form input from the generated folder list. The
&lt;select&gt; and &lt;/select&gt; tags are NOT included in the output
of this function.

param: string $heading         The label for an empty-value option at
param: boolean $abbrev         If true, abbreviate long mailbox names
param: array $filter           An array of mailboxes to ignore.
param: string $selected        The mailbox to have selected by default.
param: boolean $new_folder     If true, display an option to create a
param: boolean $inc_tasklists  Should the user's editable tasklists be
param: boolean $inc_vfolder    Should the user's virtual folders be
param: boolean $inc_tasklists  Should the user's editable notepads be
return: string  A string containing <option> elements for each mailbox

getComposeArgs()   X-Ref
Checks for To:, Subject:, Cc:, and other compose window arguments and
pass back either a URI fragment or an associative array with any of
them which are present.

param: string $format  Either 'uri' or 'array'.
return: string  A URI fragment or an associative array with any compose

openComposeWin($options = array()   X-Ref
Open a compose window.


composeLink($args = array()   X-Ref
Returns the appropriate link to call the message composition screen.

param: mixed $args   List of arguments to pass to compose.php. If this
param: array $extra  Hash of extra, non-standard arguments to pass to
return: string  The link to the message composition screen.

logoutUrl()   X-Ref
Generates an URL to the logout screen that includes any known
information, such as username, server, etc., that can be filled in on
the login form.

return: string  Logout URL with logout parameters added.

displayFolder($folder)   X-Ref
If there is information available to tell us about a prefix in front of
mailbox names that shouldn't be displayed to the user, then use it to
strip that prefix out.

param: string $folder  The folder name to display.
return: string  The folder, with any prefix gone.

filterText($text)   X-Ref
Filters a string, if requested.

param: string $text  The text to filter.
return: string  The filtered text (if requested).

hasPermission($permission, $value = false)   X-Ref
Returns the specified permission for the current user.

param: string $permission  A permission, either 'create_folders' or
param: boolean $value      If true, the method returns the value of a
return: mixed  The value of the specified permission.

getMenu($returnType = 'object')   X-Ref
Build IMP's list of menu items.


status()   X-Ref
Outputs IMP's status/notification bar.


getNewMessagePopup($newmsgs)   X-Ref
Returns the javascript for a new message notification popup.

param: array $newmsgs  Associative array with mailbox names as the keys
return: string  The javascript for the popup message

prefsURL($full = false)   X-Ref
Generates the URL to the prefs page.

param: boolean $full  Generate full URL?
return: string  The URL to the IMP prefs page.

printMode($mode = null)   X-Ref
Are we currently in "print" mode?

param: boolean $mode  True if in print mode, false if not.
return: boolean  Returns true if in "print" mode.

parseIndicesList($indices)   X-Ref
Get message indices list.

param: mixed $indices  The following inputs are allowed:
return: mixed  Returns an array with the folder as key and an array

loginTasksFlag($set = null)   X-Ref
Either sets or checks the value of the logintasks flag.

param: integer $set  The value of the flag.
return: integer  The value of the flag.

getNamespace($mailbox = null, $empty = true)   X-Ref
Get namespace info for a full folder path.

param: string $mailbox  The folder path. If empty, will return info
param: boolean $empty   If true and no matching namespace is found,
return: mixed  The namespace info for the folder path or null if the

defaultNamespace()   X-Ref
Get the default personal namespace.

return: mixed  The default personal namespace info.

folderPref($folder, $append)   X-Ref
Convert a preference value to/from the value stored in the preferences.

Preferences that need to call this function before storing/retrieving:
trash_folder, spam_folder, drafts_folder, sent_mail_folder
To allow folders from the personal namespace to be stored without this
prefix for portability, we strip the personal namespace. To tell apart
folders from the personal and any empty namespace, we prefix folders
from the empty namespace with the delimiter.

param: string $mailbox  The folder path.
param: boolean $append  True - convert from preference value.
return: string  The folder name.

appendNamespace($mbox)   X-Ref
Make sure a user-entered mailbox contains namespace information.

param: string $mbox  The user-entered mailbox string.
return: string  The mailbox string with any necessary namespace info

generateSearchUrl($page, $mailbox, $index = null)   X-Ref
Generates a URL with any necessary information required for handling a
search mailbox added to the parameters.

param: string $page     Page name to link to.
param: string $mailbox  The mailbox to use on the linked page.
param: string $index    The index to use on the linked page.
return: string  URL to $page with any necessary search information

getSearchParameters($mailbox, $index = null)   X-Ref
Returns a list of parameters necessary for handling a search mailbox.

param: string $mailbox  The mailbox to use on the linked page.
param: string $index    The index to use on the linked page.
return: array  The list of parameters needed for handling a search



Généré le : Thu Nov 29 12:30:07 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics