API Documentation
\

\Horde_Core_Prefs_Identity

This class provides Horde-specific functions for the Horde_Prefs_Identity class.

Summary

Methods
Properties
Constants
verifyIdentity()
confirmIdentity()
prefsGc()
getName()
getMatchingIdentity()
No public properties found
EXPIRE
EXPIRE_SECS
_confirmEmail()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

EXPIRE

EXPIRE

Identity entry containing the expiration time.

EXPIRE_SECS

EXPIRE_SECS

Expiration (in seconds) of a confirmation request.

Methods

verifyIdentity()

verifyIdentity(integer  $id, string  $old_addr)

Sends a message to an email address supposed to be added to the identity.

A message is send to this address containing a time-sensitive link to confirm that the address really belongs to that user.

Parameters

integer $id

The identity's ID.
string $old_addr

The old From: address.

Throws

\Horde_Mime_Exception

confirmIdentity()

confirmIdentity(string  $hash)

Checks whether an identity confirmation is valid, and adds the validated identity.

Parameters

string $hash

The hash of the identity being validated.

prefsGc()

prefsGc()

Perform garbage collection on preferences used by identities.

getName()

getName(integer  $ident = null) : string

Returns the user's full name.

Parameters

integer $ident

The identity to retrieve the name from.

Returns

string —

The user's full name, or the user name if it doesn't exist.

getMatchingIdentity()

getMatchingIdentity(mixed  $addresses, boolean  $search_own = true) : integer

Returns the identity's id that matches the passed addresses.

Parameters

mixed $addresses

Either an array or a single string or a comma-separated list of email addresses.
boolean $search_own

Search for a matching identity in own addresses also?

Returns

integer —

The id of the first identity that from or alias addresses match (one of) the passed addresses or null if none matches.

_confirmEmail()

_confirmEmail(array  $confirm = null) : array

Manage the storage of the confirm_email preference.

Parameters

array $confirm

If set, save this in the pref backend.

Returns

array —

Confirm email array.