PHP Class IMP_Contacts, horde

Author: Michael Slusarz ([email protected])
Inheritance: implements IteratorAggregate, implements Serializable
Mostra file Open project: horde/horde

Public Methods

Method Description
__get ( $name )
addAddress ( Horde_Mail_Rfc822_Object $addr ) : string Adds e-mail address to the user defined address book.
clearCache ( ) Clear cached contacts data.
getIterator ( ) : Horde_Mail_Rfc822_List Returns the list of all contacts.
searchEmail ( string $str, array $opts = [] ) : Horde_Mail_Rfc822_List Search the addressbook for email addresses.
serialize ( )
unserialize ( $data )

Private Methods

Method Description
_init ( ) Initializes parameters needed to do an address search.

Method Details

__get() public method

public __get ( $name )

addAddress() public method

Adds e-mail address to the user defined address book.
public addAddress ( Horde_Mail_Rfc822_Object $addr ) : string
$addr Horde_Mail_Rfc822_Object Address or group to add.
return string A link or message to show in the notification area (already HTML encoded).

clearCache() public method

Clear cached contacts data.
public clearCache ( )

getIterator() public method

Returns the list of all contacts.
public getIterator ( ) : Horde_Mail_Rfc822_List
return Horde_Mail_Rfc822_List Listing of all contacts.

searchEmail() public method

Search the addressbook for email addresses.
public searchEmail ( string $str, array $opts = [] ) : Horde_Mail_Rfc822_List
$str string The search string.
$opts array Additional options: - email_exact: (boolean) Require exact match in e-mail? - levenshtein: (boolean) Do levenshtein sorting of results? - sources: (array) Use this list of sources instead of default.
return Horde_Mail_Rfc822_List Results.

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $data )