Docs For Class AddressBook

Description

This is the main address book class that connect all the backends and provide services to the functions above.

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

Variable Summary

boolean $add_extra_field

array $backends

string $error

integer $localbackend

string $localbackendname

integer $numbackends

Method Summary

AddressBook AddressBook ()

boolean|integer add (array $userdata, integer $bnum)

boolean|integer add_backend (string $backend, [mixed $param = ''])

string full_address (array $row)

array get_backend_list ([string $type = ''])

array|boolean list_addr ([integer $bnum = -1])

array|boolean lookup (string $alias, [integer $bnum = -1])

boolean|integer modify (string $alias, array $userdata, integer $bnum)

boolean|integer remove (array|string $alias, integer $bnum)

array|boolean search (string $expression, [integer $bnum = -1])

array|boolean s_search (string $expression, [integer $bnum = -1])

Variables

boolean $add_extra_field = false (line 814)

array $backends = array() (line 794)

var: indexed array of available backends

string $error = '' (line 802)

integer $localbackend = 0 (line 806)

string $localbackendname = '' (line 810)

integer $numbackends = 0 (line 798)

Methods

Constructor AddressBook (line 819)

Constructor function.

AddressBook AddressBook ()

add (line 1036)

Create a new address from $userdata, in backend $bnum.

Return the backend number that the/ address was added to, or false if it failed.

return: boolean false or backend number

boolean|integer add (array $userdata, integer $bnum)

array $userdata: array with firstname, lastname, email, nickname and label keys
integer $bnum: backend number

add_backend (line 850)

Add a new backend.

return: false on error, number of available backends on success

boolean|integer add_backend (string $backend, [mixed $param = ''])

string $backend: is the name of a backend (without the abook_ prefix)
mixed $param: is an optional variable that is passed to the backend constructor. See each of the backend classes for valid parameters.

full_address (line 880)

This function takes a $row array as returned by the addressbook search and returns an e-mail address with the full name or nickname optionally prepended.

return: email address prefixed according to user preferences

string full_address (array $row)

array $row: address book entry

get_backend_list (line 829)

Return an array of backends of a given type, or all backends if no type is specified.

array get_backend_list ([string $type = ''])

string $type

list_addr (line 1003)

Return all addresses

return: array with sorted results or boolean false

array|boolean list_addr ([integer $bnum = -1])

integer $bnum: backend number. -1 for search in all backends

lookup (line 966)

Lookup an address by alias. Only possible in local backends.

return: array with address book entry or boolean false

array|boolean lookup (string $alias, [integer $bnum = -1])

string $alias: nickname
integer $bnum: backend number. -1 for search in all backends

modify (line 1118)

Modifies address book entry identified by $alias from backend $bnum

return: boolean false on error, backend number on success

boolean|integer modify (string $alias, array $userdata, integer $bnum)

string $alias: modified address book entry
array $userdata: array with address book entry
integer $bnum: backend number

remove (line 1083)

Remove the user identified by $alias from backend $bnum If $alias is an array, all users in the array are removed.

return: boolean false or backend number

boolean|integer remove (array|string $alias, integer $bnum)

array|string $alias: nickname or array with nicknames
integer $bnum

search (line 903)

Return a list of addresses matching expression in all backends of a given type.

return: array with results or boolean false

array|boolean search (string $expression, [integer $bnum = -1])

string $expression: search expression
integer $bnum: backend number. -1 for search in all backends

s_search (line 949)

Return a sorted search

return: array with sorted results or boolean false

array|boolean s_search (string $expression, [integer $bnum = -1])

string $expression: search expression
integer $bnum: backend number. -1 for search in all backends