Docs For Class addressbook

Description

Generic backend that all other backends extend

Located in /nasmail/functions/addressbook.php (line 1169)

Direct descendents

Class	Description
abook_database	Address book in a database backend
abook_ldap_server	Address book backend for LDAP server
abook_local_file	Backend for address book as a pipe separated file
abook_extended
abook_hmailserver_dcom	hMailserver address book backend written in PHP COM functions.
abook_hmailserver_mdb2	hMailserver address book backend written in PHP Pear DB functions.
abook_hmailserver_db	hMailserver address book backend written in PHP Pear DB functions.

Variable Summary

string $bname

integer $bnum

string $btype

string $error

string $sname

mixed $writeable

Method Summary

boolean add (array $userdata)

string fullname (string $firstname, string $lastname)

boolean|array list_addr ()

array|boolean lookup (string $alias)

boolean modify (string $alias, array $newuserdata)

boolean remove (array $alias)

array|boolean search (string $expression)

boolean set_error (string $string)

Variables

string $bname = 'dummy' (line 1178)

var: Backend class name without abook_ prefix

Redefined in descendants as:

integer $bnum = -1 (line 1192)

var: Backend number

string $btype = 'dummy' (line 1174)

var: Backend type ('local' or 'remote')

Redefined in descendants as:

string $error = '' (line 1196)

var: Backend error buffer

string $sname = 'Dummy backend' (line 1182)

var: Human readable backend name

Redefined in descendants as:

mixed $writeable = false (line 1200)

Redefined in descendants as:

abook_database::$writeable : Enable/disable writing into address book
abook_ldap_server::$writeable
abook_local_file::$writeable : Control write access to address book
abook_extended::$writeable
abook_extended_mdb2::$writeable
abook_extended_peardb::$writeable
abook_extended_adodb::$writeable
abook_hmailserver_dcom::$writeable
abook_hmailserver_mdb2::$writeable
abook_hmailserver_db::$writeable

Methods

add (line 1257)

Adds address book entry Dummy function. Always returns false. Real backends should replace it.

return: true on success, false on error. Error message is stored in error buffer.

boolean add (array $userdata)

array $userdata

Redefined in descendants as:

abook_database::add() : Add address
abook_ldap_server::add() : Add address
abook_local_file::add() : Add address
abook_extended_mdb2::add() : Adds address book entry
abook_extended_peardb::add() : Adds address book entry
abook_extended_adodb::add() : Adds address book entry
abook_hmailserver_dcom::add() : Dummy function. Breaks with error, when new address book entry is added.
abook_hmailserver_mdb2::add() : Dummy function. Breaks with error, when new address book entry is added.
abook_hmailserver_db::add() : Dummy function. Breaks with error, when new address book entry is added.

fullname (line 1295)

Creates full name from given name and surname

Handles name order differences.

return: full name

string fullname (string $firstname, string $lastname)

string $firstname: given name
string $lastname: surname

Redefined in descendants as:

abook_extended::fullname() : Internal function that creates full name from first and last names

list_addr (line 1245)

Lists all address book entries stored in backend Dummy function. Always returns false. Real backends should replace it.

return: boolean false on error. array with address book entries

boolean|array list_addr ()

Redefined in descendants as:

abook_database::list_addr() : List all addresses
abook_ldap_server::list_addr() : List all entries present in LDAP server
abook_local_file::list_addr() : List all addresses
abook_extended_mdb2::list_addr() : List all addresses
abook_extended_peardb::list_addr() : List all addresses
abook_extended_adodb::list_addr() : List all addresses
abook_hmailserver_dcom::list_addr() : List all addresses
abook_hmailserver_mdb2::list_addr() : List all addresses
abook_hmailserver_db::list_addr() : List all addresses

lookup (line 1234)

Look for exact address book entry match Dummy function. Always returns false. Real backends should replace it.

return: boolean false on error, array with address book entry

array|boolean lookup (string $alias)

string $alias

Redefined in descendants as:

abook_database::lookup() : Lookup alias
abook_ldap_server::lookup() : Lookup an alias
abook_local_file::lookup() : Lookup alias
abook_extended_mdb2::lookup() : Lookup alias
abook_extended_peardb::lookup() : Lookup alias
abook_extended_adodb::lookup() : Lookup alias
abook_hmailserver_dcom::lookup() : Lookup one address book entry by nickname
abook_hmailserver_mdb2::lookup() : Lookup by nickname
abook_hmailserver_db::lookup() : Lookup by nickname

modify (line 1282)

Modifies address book entry Dummy function. Always returns false. Real backends should replace it.

return: true on success, false on error. Error message is stored in error buffer.

boolean modify (string $alias, array $newuserdata)

string $alias: nickname
array $newuserdata: new user data

Redefined in descendants as:

abook_database::modify() : Modify address
abook_ldap_server::modify() : Modify address
abook_local_file::modify() : Modify address
abook_extended_mdb2::modify() : Modify address
abook_extended_peardb::modify() : Modify address
abook_extended_adodb::modify() : Modify address
abook_hmailserver_dcom::modify() : Dummy function. Breaks with error on address book entry modification.
abook_hmailserver_mdb2::modify() : Dummy function. Breaks with error on address book entry modification.
abook_hmailserver_db::modify() : Dummy function. Breaks with error on address book entry modification.

remove (line 1269)

Deletes address book entries Dummy function. Always returns false. Real backends should replace it.

return: true on success, false on error. Error message is stored in error buffer.

boolean remove (array $alias)

array $alias: array with nicknames

Redefined in descendants as:

abook_database::remove() : Delete address
abook_ldap_server::remove() : Delete address
abook_local_file::remove() : Delete address
abook_extended_mdb2::remove() : Deletes address book entries
abook_extended_peardb::remove() : Deletes address book entries
abook_extended_adodb::remove() : Deletes address book entries
abook_hmailserver_dcom::remove() : Dummy function. Breaks with error on address book entry deletion.
abook_hmailserver_mdb2::remove() : Dummy function. Breaks with error on address book entry deletion.
abook_hmailserver_db::remove() : Dummy function. Breaks with error on address book entry deletion.

search (line 1222)

Search address book backend for expression Dummy function. Always returns false. Real backends should replace it.

return: boolean false on error, array with search results on success

array|boolean search (string $expression)

string $expression

Redefined in descendants as:

abook_database::search() : Search the database
abook_ldap_server::search() : Search the LDAP server
abook_local_file::search() : Search the file
abook_extended_mdb2::search() : Searches address book
abook_extended_peardb::search() : Searches address book
abook_extended_adodb::search() : Searches address book
abook_hmailserver_dcom::search() : Searches address book
abook_hmailserver_mdb2::search() : Search address function
abook_hmailserver_db::search() : Search address function

set_error (line 1207)

Sets error message with backend name tag

return: false

boolean set_error (string $string)

string $string: error message

addressbook_backend