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
|
public
|
|
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_Prefs_Exception
|
public
Horde_Mail_Rfc822_Address
|
#
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
Horde_Mail_Rfc822_Address
The address to use for From header.
Throws
Horde_Exception
|
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( mixed $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(es) to search for in the identities.
Returns
boolean
True if the address was found.
|
public
Horde_Mail_Rfc822_Address
|
#
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
Horde_Mail_Rfc822_Address
A valid from address.
|
public
Horde_Mail_Rfc822_List
|
#
getAliasAddress( integer $ident = null )
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
Horde_Mail_Rfc822_List
Aliases for the identity.
|
public
Horde_Mail_Rfc822_List
|
#
getFromAddresses( integer $ident = null )
Returns all From addresses for one identity.
Returns all From addresses for one identity.
Parameters
- $ident
- <p>The identity to retrieve the from addresses
from.</p>
Returns
Horde_Mail_Rfc822_List
Address list.
|
public
Horde_Mail_Rfc822_List
|
#
getAllFromAddresses( )
Returns all identities' From addresses.
Returns all identities' From addresses.
Returns
Horde_Mail_Rfc822_List
Address list.
|
public
Horde_Mail_Rfc822_List
|
#
getTieAddresses( integer $ident = null )
Get tie-to addresses.
Parameters
- $ident
- <p>The identity to retrieve the tie-to addresses
from.</p>
Returns
Horde_Mail_Rfc822_List
A list of tie-to e-mail addresses.
|
public
Horde_Mail_Rfc822_List
|
#
getAllTieAddresses( )
Get all 'tie to' address/identity pairs.
Get all 'tie to' address/identity pairs.
Returns
Horde_Mail_Rfc822_List
A list of e-mail addresses.
|
public
Horde_Mail_Rfc822_List
|
#
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
Horde_Mail_Rfc822_List
A list of e-mail addresses.
|
public
Horde_Mail_Rfc822_List
|
#
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
Horde_Mail_Rfc822_List
BCC 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
integerThe 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
boolean
|
#
hasSignature( boolean $compose_page = false )
Does the user have any signatures (either text or HTML)?
Does the user have any signatures (either text or HTML)?
Parameters
- $compose_page
- <p>If true, checks for signatures as used on
the compose pages.</p>
Returns
boolean
True if the user has at least one signature.
|
public
|
#
getValue( mixed $key, mixed $identity = null )
Returns a property from one of the identities.
Returns a property from one of the identities.
See
|
public
|
#
setValue( mixed $key, mixed $val, mixed $identity = null )
Sets a property with a specified value.
Sets a property with a specified value.
See
|
public
array
|
#
getAllSentmail( boolean $unique = true )
Returns an array with the sent-mail mailboxes from all identities.
Returns an array with the sent-mail mailboxes from all identities.
Parameters
- $unique
- <p>If true, return the unique list of sent-mail
mailboxes. If false, returns list of
sent-mail mailboxes, with the key corresponding
to the identity.</p>
Returns
array
The array with the sent-mail IMP_Mailbox 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.
|
IMP_Prefs_Identity