Docs For Class abook_hmailserver

Description

hMailserver address book backend written in PHP COM functions.

Available configuration keys: 'listing' 'add_dlists' 'add_aliases' 'login_name' 'login_pass' 'server_name' 'domain_name'

Located in /plugins/abook_hmailserver/class_dcom.php (line 39)

addressbook_backend
   |
   --abook_hmailserver_dcom

Variable Summary

boolean $add_aliases

boolean $add_dlists

string $bname

string $btype

object COM $conn

string $domain_name

boolean $listing

string $login_name

string $login_pass

string $server_name

boolean $writeable

Method Summary

abook_hmailserver_dcom abook_hmailserver_dcom (array $params)

boolean add ()

string firstname (object hMailServer $account, [boolean $is_alias = false])

string lastname (object hMailServer $account, [boolean $is_alias = false])

string listname (object hMailServer $dlist)

array list_addr ()

array|boolean list_addr_by_domain (string $domain_name)

void lookup (string $nickname)

boolean modify ()

boolean open ()

boolean remove ()

void search (expr $expr)

Variables

boolean $add_aliases = false (line 54)

var: controls inclusion of aliases in address book listing

boolean $add_dlists = false (line 52)

var: controls inclusion of distribution lists in address book listing

string $bname = 'hmailserver_dcom' (line 43)

var: backend tag

Redefinition of:

addressbook_backend::$bname

string $btype = 'local' (line 41)

var: local address book backend

Redefinition of:

addressbook_backend::$btype

object COM $conn = false (line 64)

var: connection resource

string $domain_name = '' (line 50)

var: domain. all domains are used, if it set to empty string

boolean $listing = true (line 48)

var: flag controls address book listing and wide search

string $login_name = '' (line 57)

var: login name used in hMailServer 4.3+ authentication

string $login_pass = '' (line 59)

var: password used in hMailServer 4.3+ authentication

string $server_name = '' (line 61)

var: server's name used in COM connection

boolean $writeable = false (line 45)

var: flag indicates read-only address book

Redefinition of:

addressbook_backend::$writeable

Inherited Variables

Inherited from addressbook_backend

addressbook_backend::$bnum
addressbook_backend::$error
addressbook_backend::$sname

Methods

Constructor abook_hmailserver_dcom (line 70)

Constructor function

abook_hmailserver_dcom abook_hmailserver_dcom (array $params)

array $params: Check class description for available configuration params.

add (line 461)

Dummy function. Breaks with error, when new address book entry is added.

boolean add ()

Redefinition of:

addressbook_backend::add(): Adds address book entry Dummy function. Always returns false. Real backends should replace it.

firstname (line 145)

Guesses firstname from account's data

string firstname (object hMailServer $account, [boolean $is_alias = false])

object hMailServer $account: COM Account or Alias object
boolean $is_alias: true for Alias object, false for Account

lastname (line 171)

Guesses lastname from account's data

string lastname (object hMailServer $account, [boolean $is_alias = false])

object hMailServer $account: COM Account or Alias object
boolean $is_alias: true for Alias object, false for Account

listname (line 190)

Creates name for DistributionList address

string listname (object hMailServer $dlist)

object hMailServer $dlist: COM DistributionList object

list_addr (line 425)

List all addresses

array list_addr ()

Redefinition of:

addressbook_backend::list_addr(): Lists all address book entries stored in backend Dummy function. Always returns false. Real backends should replace it.

list_addr_by_domain (line 205)

Extracts address book entries for speficied domain

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

array|boolean list_addr_by_domain (string $domain_name)

string $domain_name: active domain name

lookup (line 337)

Lookup one address book entry by nickname

void lookup (string $nickname)

string $nickname: Nickname

Redefinition of:

addressbook_backend::lookup(): Look for exact address book entry match Dummy function. Always returns false. Real backends should replace it.

modify (line 477)

Dummy function. Breaks with error on address book entry modification.

boolean modify ()

Redefinition of:

addressbook_backend::modify(): Modifies address book entry Dummy function. Always returns false. Real backends should replace it.

open (line 101)

Open's connection to hmailserver

return: true on success, false on failure

boolean open ()

remove (line 469)

Dummy function. Breaks with error on address book entry deletion.

boolean remove ()

Redefinition of:

addressbook_backend::remove(): Deletes address book entries Dummy function. Always returns false. Real backends should replace it.

search (line 281)

Searches address book

? and * wildcards are supported

void search (expr $expr)

expr $expr: string search expression

Redefinition of:

addressbook_backend::search(): Search address book backend for expression Dummy function. Always returns false. Real backends should replace it.

Inherited Methods

Inherited From addressbook_backend

addressbook_backend::add()
addressbook_backend::fullname()
addressbook_backend::list_addr()
addressbook_backend::lookup()
addressbook_backend::modify()
addressbook_backend::remove()
addressbook_backend::search()
addressbook_backend::set_error()