Roundcube Framework
Back to top  

rcube_user

Class representing a system user

package

Framework
subpackage

Core

Methods

Object constructor

__construct(integer $id = null, array $sql_arr = null)

Arguments

$id

integer

User id

$sql_arr

array

SQL result set

Create a new user record and return a rcube_user instance

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

Arguments

$user

string

IMAP user name

$host

string

IMAP host

Response

\rcube_user

New user instance

Mark the given identity as deleted

delete_identity(integer $iid) : boolean

Arguments

$iid

integer

Identity ID

Response

boolean

True if deleted successfully, false if nothing changed

Deletes given saved search record

delete_search(integer $sid) : boolean

Arguments

$sid

integer

Search ID

Response

boolean

True if deleted successfully, false if nothing changed

Resolve username using a virtuser plugins

email2user(string $email) : string
static

Arguments

$email

string

E-mail address to resolve

Response

string

Resolved IMAP username

Generate a unique hash to identify this user whith

get_hash()

Get default identity of this user

get_identity(integer $id = null) : array

Arguments

$id

integer

Identity ID. If empty, the default identity is returned

Response

array

Hash array with all cols of the identity record

Get the preferences saved for this user

get_prefs() : array

Response

array

Hash array with prefs

Return saved search data.

get_search(integer $id) : array

Arguments

$id

integer

Row identifier

Response

array

Data

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

get_username(string $part = null) : string

Arguments

$part

string

Username part (empty or 'local' or 'domain', 'mail')

Response

string

Full user name or its part

Create a new identity record linked with this user

insert_identity(array $data) : integer

Arguments

$data

array

Hash array with col->value pairs to save

Response

integer

The inserted identity ID or false on error

Create a new saved search record linked with this user

insert_search(array $data) : integer

Arguments

$data

array

Hash array with col->value pairs to save

Response

integer

The inserted search ID or false on error

Checks if the account is locked, e.g. as a result of brute-force prevention

is_locked()

Return a list of all user emails (from identities)

list_emails( $default = false) : array

Arguments

$default

Response

array

List of emails (identity_id, name, email)

Return a list of all identities linked with this user

list_identities(string $sql_add = '', boolean $formatted = false) : array

Arguments

$sql_add

string

Optional WHERE clauses

$formatted

boolean

Format identity email and name

Response

array

List of identities

Return a list of saved searches linked with this user

list_searches(integer $type) : array

Arguments

$type

integer

Search type

Response

array

List of saved searches indexed by search ID

Find a user record matching the given name and host

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

Arguments

$user

string

IMAP user name

$host

string

IMAP host name

Response

\rcube_user

New user instance

Clear the saved object state

reset()

Write the given user prefs to the user's record

save_prefs(array $a_user_prefs, boolean $no_session = false) : boolean

Arguments

$a_user_prefs

array

User prefs to save

$no_session

boolean

Simplified language/preferences handling

Response

boolean

True on success, False on failure

Make this identity the default one for this user

set_default(integer $iid)

Arguments

$iid

integer

The identity ID

Update user's last_login timestamp

touch()

Update a specific identity record

update_identity(integer $iid, array $data) : boolean

Arguments

$iid

integer

Identity ID

$data

array

Hash array with col->value pairs to save

Response

boolean

True if saved successfully, false if nothing changed

Resolve e-mail address from virtuser plugins

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

Arguments

$user

string

User name

$first

boolean

If true returns first found entry

$extended

boolean

If true returns email as array (email and name for identity)

Response

mixed

Resolved e-mail address string or array of strings

Constants

SEARCH_ADDRESSBOOK

SEARCH_ADDRESSBOOK

SEARCH_MAIL

SEARCH_MAIL

Properties

ID

ID :

Type(s)

data

data :

Type(s)

language

language :

Type(s)

prefs

prefs :

Type(s)

Holds database connection.

db : \rcube_db
var

Type(s)

\rcube_db

Framework object.

rc : \rcube
var

Type(s)

\rcube

Internal identities cache

identities : array
var

Type(s)

array

Internal emails cache

emails : array
var

Type(s)

array