AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CApiMailStorage
  • CApiUsersCommandCreator
  • CApiUsersCommandCreatorMySQL
  • CApiUsersCommandCreatorPostgreSQL
  • CApiUsersDbStorage
  • CApiUsersNodbStorage
  • CApiUsersStorage

Class CApiUsersNodbStorage

AApiManagerStorage
Extended by CApiUsersStorage
Extended by CApiUsersNodbStorage
Package: Users\Storages
Internal
Located at users/storages/nodb/storage.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager
$oManager

Overrides

CApiUsersStorage::__construct
public CAccount
# getAccountById( integer $iAccountId )

Retrieves information on WebMail Pro account. Account ID is used for look up.

Retrieves information on WebMail Pro account. Account ID is used for look up.

Parameters

$iAccountId
Account identifier.

Returns

CAccount

Overrides

CApiUsersStorage::getAccountById
public boolean
# createAccount( CAccount & $oAccount )

Creates WebMail account.

Creates WebMail account.

Parameters

$oAccount
$oAccount Object instance with prepopulated account properties.

Returns

boolean

Overrides

CApiUsersStorage::createAccount
public array
# getAccountIdList( integer $iUserId )

Retrieves list of accounts for given WebMail Pro user.

Retrieves list of accounts for given WebMail Pro user.

Parameters

$iUserId
User identifier.

Returns

array
| false

Overrides

CApiUsersStorage::getAccountIdList
public boolean
# accountExists( CAccount $oAccount )

Checks if particular account exists.

Checks if particular account exists.

Parameters

$oAccount
Object instance with prepopulated account properties.

Returns

boolean

Overrides

CApiUsersStorage::accountExists
public boolean
# updateAccount( CAccount $oAccount )

Saves changes made to the account.

Saves changes made to the account.

Parameters

$oAccount
$oAccount Account object containing data to be saved.

Returns

boolean

Overrides

CApiUsersStorage::updateAccount
public boolean
# createCalUser( CCalUser & $oCalUser )

Creates calendar user in storage.

Creates calendar user in storage.

Parameters

$oCalUser
$oCalUser CCalUser object.

Returns

boolean

Overrides

CApiUsersStorage::createCalUser
public CCalUser
# getCalUser( integer $iUserId )

Obtains CCalUser object that contains calendar settings for specified user. User identifier is used for look up.

Obtains CCalUser object that contains calendar settings for specified user. User identifier is used for look up.

Parameters

$iUserId
User identifier.

Returns

CCalUser

Overrides

CApiUsersStorage::getCalUser
public boolean
# updateCalUser( CCalUser $oCalUser )

Updates calendar user settings.

Updates calendar user settings.

Parameters

$oCalUser
CCalUser object.

Returns

boolean

Overrides

CApiUsersStorage::updateCalUser

Methods inherited from CApiUsersStorage

createIdentity(), deleteAccount(), deleteCalUser(), deleteIdentity(), enableAccounts(), getAccountByEmail(), getAccountIdentities(), getAccountUsedSpace(), getDefaultAccountDomainId(), getDefaultAccountId(), getDefaultAccountIdList(), getDefaultAccountList(), getIdentity(), getTotalUsersCount(), getUserAccounts(), getUserById(), getUserList(), getUsersCountForDomain(), getUsersCountForTenant(), updateAccountLastLoginAndCount(), updateIdentity()

Constants summary

string SESS_ACCOUNT_STORAGE
# 'sess-acct-storage'
string SESS_CAL_USERS_STORAGE
# 'sess-cal-user-storage'
AfterLogic API Documentation API documentation generated by ApiGen