Class IMP_Session

Description

Functions required to start an IMP session.

$Horde: imp/lib/Session.php,v 1.74.2.44 2009/05/29 22:36:50 slusarz Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

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

Located in /lib/Session.php (line 16)


	
			
Method Summary
 boolean createSession (string $imapuser, string $password, string $server, [array $args = array()])
 string getInitialUrl ([string $actionID = null], [boolean $encode = true])
 void loginTasks ()
Methods
createSession (line 62)

Take information posted from a login attempt and try setting up

an initial IMP session. Handle Horde authentication, if required, and only do enough work to see if the user can log in. This function should only be called once, when the user first logs in. On success, logs a message to the Horde log.

Creates the $imp session variable with the following entries: '_logintasks' -- Have the login tasks been completed? 'acl' -- See config/servers.php. 'admin' -- See config/servers.php. 'base_protocol' -- Either 'imap' or 'pop3'. 'cache' -- Various IMP libraries can use this variable to cache data. 'default_view' -- The default view (dimp, imp, or mimp). 'file_upload' -- If file uploads are allowed, the max size. 'filteravail' -- Can we apply filters manually? 'imap_server' -- IMAP server capabilities. 'maildomain' -- See config/servers.php. 'mboxcache' -- Used by the IMP_MailboxCache library. 'namespace' -- See config/servers.php. 'notepadavail' -- Is listing of notepads available? 'pass' -- The encrypted password. 'port' -- See config/servers.php. 'protocol' -- See config/servers.php. 'quota' -- See config/servers.php. 'search' -- Settings used by the IMP_Search library. 'server' -- The name of the server entry in config/servers.php. 'smime' -- Settings related to the S/MIME viewer. 'smtphost' -- The SMTP host to use instead of the Horde default. 'smtpport' -- The SMTP port to use instead of the Horde default. 'showunsub' -- Show unsusubscribed mailboxes on the folders screen. 'tasklistavail' -- Is listing of tasklists available? 'uniquser' -- The unique user name. 'user' -- The IMAP username. 'viewmode' -- The imp view mode (currently dimp, imp, or mimp)

  • return: True on success, false on failure.
boolean createSession (string $imapuser, string $password, string $server, [array $args = array()])
  • string $imapuser: The username of the user.
  • string $password: The password of the user.
  • string $server: The server to use (see config/servers.php).
  • array $args: The necessary server information.
getInitialUrl (line 362)

Returns the initial URL.

  • return: The initial URL.
string getInitialUrl ([string $actionID = null], [boolean $encode = true])
  • string $actionID: The action ID to perform on the initial page.
  • boolean $encode: If true the argument separator gets encoded.
loginTasks (line 315)

Perform IMP login tasks.

void loginTasks ()

Documentation generated on Sun, 30 Jan 2011 05:28:17 +0000 by phpDocumentor 1.4.3