Docs For Class rcube

Description

Class representing a system user

author: Thomas Bruederli <roundcube@gmail.com>

Located in /rcube_user.php (line 30)

Class Constant Summary

SEARCH_ADDRESSBOOK = 1

SEARCH_MAIL = 2

Variable Summary

mixed $data

mixed $ID

mixed $language

Method Summary

static rcube_user create (string $user, string $host)

static string email2user (string $email)

static rcube_user query (string $user, string $host)

static mixed user2email (string $user, [boolean $first = true], [boolean $extended = false])

rcube_user __construct ([int $id = null], [array $sql_arr = null])

boolean delete_identity (int $iid)

boolean delete_search (int $sid)

array get_identity ([int $id = null])

array get_prefs ()

array get_search (int $id)

string get_username ([string $part = null])

int insert_identity (array $data)

int insert_search (array $data)

array list_identities ([string $sql_add = ''])

array list_searches (int $type)

void reset ()

boolean save_prefs (array $a_user_prefs)

void set_default (int $iid)

void touch ()

boolean update_identity (int $iid, array $data)

Variables

mixed $data (line 33)

access: public

mixed $ID (line 32)

access: public

mixed $language (line 34)

access: public

Methods

static create (line 427)

Create a new user record and return a rcube_user instance

return: New user instance

rcube_user create (string $user, string $host)

string $user: IMAP user name
string $host: IMAP host

static email2user (line 525)

Resolve username using a virtuser plugins

return: Resolved IMAP username

string email2user (string $email)

string $email: E-mail address to resolve

static query (line 398)

Find a user record matching the given name and host

return: New user instance

rcube_user query (string $user, string $host)

string $user: IMAP user name
string $host: IMAP host name

static user2email (line 543)

Resolve e-mail address from virtuser plugins

return: Resolved e-mail address string or array of strings

mixed user2email (string $user, [boolean $first = true], [boolean $extended = false])

string $user: User name
boolean $first: If true returns first found entry
boolean $extended: If true returns email as array (email and name for identity)

Constructor __construct (line 59)

Object constructor

rcube_user __construct ([int $id = null], [array $sql_arr = null])

int $id: User id
array $sql_arr: SQL result set

delete_identity (line 318)

Mark the given identity as deleted

return: True if deleted successfully, false if nothing changed

boolean delete_identity (int $iid)

int $iid: Identity ID

delete_search (line 632)

Deletes given saved search record

return: True if deleted successfully, false if nothing changed

boolean delete_search (int $sid)

int $sid: Search ID

get_identity (line 214)

Get default identity of this user

return: Hash array with all cols of the identity record

array get_identity ([int $id = null])

int $id: Identity ID. If empty, the default identity is returned

get_prefs (line 117)

Get the preferences saved for this user

return: Hash array with prefs

array get_prefs ()

get_search (line 595)

Return saved search data.

return: Data

array get_search (int $id)

int $id: Row identifier

get_username (line 84)

Build a user name string (as e-mail address)

return: Full user name or its part

string get_username ([string $part = null])

string $part: Username part (empty or 'local' or 'domain')

insert_identity (line 286)

Create a new identity record linked with this user

return: The inserted identity ID or false on error

int insert_identity (array $data)

array $data: Hash array with col->value pairs to save

insert_search (line 654)

Create a new saved search record linked with this user

return: The inserted search ID or false on error

int insert_search (array $data)

array $data: Hash array with col->value pairs to save

list_identities (line 227)

Return a list of all identities linked with this user

return: List of identities

array list_identities ([string $sql_add = ''])

string $sql_add: Optional WHERE clauses

list_searches (line 561)

Return a list of saved searches linked with this user

return: List of saved searches indexed by search ID

array list_searches (int $type)

int $type: Search type

reset (line 384)

Clear the saved object state

void reset ()

save_prefs (line 152)

Write the given user prefs to the user's record

return: True on success, False on failure

boolean save_prefs (array $a_user_prefs)

array $a_user_prefs: User prefs to save

set_default (line 351)

Make this identity the default one for this user

void set_default (int $iid)

int $iid: The identity ID

touch (line 369)

Update user's last_login timestamp

void touch ()

update_identity (line 253)

Update a specific identity record

return: True if saved successfully, false if nothing changed

boolean update_identity (int $iid, array $data)

int $iid: Identity ID
array $data: Hash array with col->value pairs to save

Class Constants

SEARCH_ADDRESSBOOK = 1 (line 50)

SEARCH_MAIL = 2 (line 51)