Class Imp_Prefs_Identity

This class provides an IMP-specific interface to all identities a user might have. Its methods take care of any site-specific restrictions configured in prefs.php and conf.php.

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

Horde_Core_Prefs_Identity

Imp_Prefs_Identity

Package: IMP
Category: Horde
License: GPL
Author: Jan Schneider jan@horde.org
Author: Chuck Hagenbuch chuck@horde.org
Located at Prefs/Identity.php

Methods summary
`public`	# `__construct( mixed $params )` Reads all the user's identities from the prefs object or builds a new identity from the standard values given in prefs.php. Reads all the user's identities from the prefs object or builds a new identity from the standard values given in prefs.php. See `Imp_Prefs_Identity::__construct()`
`public`	# `verify( integer $identity = null )` Verifies and sanitizes all identity properties. Verifies and sanitizes all identity properties. Parameters `$identity` The identity to verify. Throws Horde_Exception
`public string`	# `getFromLine( integer $ident = null, string $from_address = '' )` Returns a complete From: header based on all relevant factors (fullname, from address, input fields, locks etc.) Returns a complete From: header based on all relevant factors (fullname, from address, input fields, locks etc.) Parameters `$ident` The identity to retrieve the values from. `$from_address` <p>A default from address to use if no identity is selected and the from_addr preference is locked.</p> Returns `string` A full From: header in the format 'Fullname user@example.com'. Throws Horde_Exception
`public array`	# `getAllFromLines( )` Returns an array with From: headers from all identities Returns an array with From: headers from all identities Returns `array` The From: headers from all identities
`public array`	# `getSelectList( )` Returns an array with the necessary values for the identity select box in the IMP compose window. Returns an array with the necessary values for the identity select box in the IMP compose window. Returns `array` The array with the necessary strings
`public boolean`	# `hasAddress( string $address )` Returns true if the given address belongs to one of the identities. This function will search aliases for an identity automatically. Returns true if the given address belongs to one of the identities. This function will search aliases for an identity automatically. Parameters `$address` The address to search for in the identities. Returns `boolean` True if the address was found.
`public string`	# `getFromAddress( integer $ident = null )` Returns the from address based on the chosen identity. If no address can be found it is built from the current user name and the specified maildomain. Returns the from address based on the chosen identity. If no address can be found it is built from the current user name and the specified maildomain. Parameters `$ident` The identity to retrieve the address from. Returns `string` A valid from address.
`public array`	# `getAliasAddress( integer $ident )` Returns all aliases based on the chosen identity. Returns all aliases based on the chosen identity. Parameters `$ident` The identity to retrieve the aliases from. Returns `array` Aliases for the identity.
`public array`	# `getAllFromAddresses( boolean $alias = false )` Returns an array with all identities' from addresses. Returns an array with all identities' from addresses. Parameters `$alias` Include aliases? Returns `array` The array with KEY - address VAL - identity number
`public array`	# `getAllTieAddresses( )` Get all 'tie to' address/identity pairs. Get all 'tie to' address/identity pairs. Returns `array` The array with KEY - address VAL - identity number
`public array`	# `getAllIdentityAddresses( )` Returns a list of all e-mail addresses from all identities, including both from addresses and tie addreses. Returns a list of all e-mail addresses from all identities, including both from addresses and tie addreses. Returns `array` A list of e-mail addresses.
`public array`	# `getBccAddresses( integer $ident = null )` Returns the BCC addresses for a given identity. Returns the BCC addresses for a given identity. Parameters `$ident` The identity to retrieve the Bcc addresses from. Returns `array` The array of objects (IMAP addresses).
`public integer`	# `getMatchingIdentity( mixed $addresses, boolean $search_own = true )` Returns the identity's id that matches the passed addresses. Returns the identity's id that matches the passed addresses. Parameters `$addresses` <p>Either an array or a single string or a comma-separated list of email addresses.</p> `$search_own` <p>Search for a matching identity in own addresses also?</p> Returns `integer` The id of the first identity that from or alias addresses match (one of) the passed addresses or null if none matches.
`public string`	# `getFullname( integer $ident = null )` Returns the user's full name. Returns the user's full name. Parameters `$ident` The identity to retrieve the name from. Returns `string` The user's full name.
`public string`	# `getSignature( string $type = 'text', integer $ident = null )` Returns the full signature based on the current settings for the signature itself, the dashes and the position. Returns the full signature based on the current settings for the signature itself, the dashes and the position. Parameters `$type` Either 'text' or 'html'. `$ident` The identity to retrieve the signature from. Returns `string` The full signature. Throws Horde_Exception
`public array`	# `getAllSignatures( string $type = 'text' )` Returns an array with the signatures from all identities Returns an array with the signatures from all identities Parameters `$type` Either 'text' or 'html'. Returns `array` The array with all the signatures.
`public`	# `getValue( mixed $key, mixed $identity = null )` Returns a property from one of the identities. Returns a property from one of the identities. See `Imp_Prefs_Identity::getValue()`
`public`	# `setValue( mixed $key, mixed $val, mixed $identity = null )` Sets a property with a specified value. Sets a property with a specified value. See `Imp_Prefs_Identity::setValue()`
`public array`	# `getAllSentmailFolders( )` Returns an array with the sent-mail folder names from all the identities. Returns an array with the sent-mail folder names from all the identities. Returns `array` The array with the sent-mail objects.
`public boolean`	# `saveSentmail( integer $ident = null )` Returns true if the mail should be saved and the user is allowed to. Returns true if the mail should be saved and the user is allowed to. Parameters `$ident` The identity to retrieve the setting from. Returns `boolean` True if the sent mail should be saved.

Packages

Classes

Class Imp_Prefs_Identity

See

Parameters

Throws

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

See

See

Returns

Parameters

Returns