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 CApiUsersCommandCreatorMySQL

api_CommandCreator
Extended by CApiUsersCommandCreator
Extended by CApiUsersCommandCreatorMySQL

Direct known subclasses

CApiUsersCommandCreatorPostgreSQL

Package: Users\Storages
Located at users/storages/db/command_creator.php

Methods summary

public string
# getDefaultAccountListQuery( )

Returns query-string for obtaining list of accounts which are specified as default.

Returns query-string for obtaining list of accounts which are specified as default.

Returns

string
public string
# getDefaultAccountIdListQuery( integer $iDomainId, integer $iPage, integer $iUsersPerPage )

Returns query-string for obtaining list of identifiers of accounts which are specified as default. Domain identifier is used for look up.

Returns query-string for obtaining list of identifiers of accounts which are specified as default. Domain identifier is used for look up.

Parameters

$iDomainId
Domain identifier.
$iPage
List page.
$iUsersPerPage
Number of identifiers on a single page.

Returns

string
public string
# getSelectUserListQuery( integer $iDomainId, integer $iPage, integer $iUsersPerPage, string $sOrderBy = 'email', boolean $bAscOrderType = true, string $sSearchDesc = '' )

Returns query-string for obtaining list of information about users for specific domain. Domain identifier is used for look up.

Returns query-string for obtaining list of information about users for specific domain. Domain identifier is used for look up.

Parameters

$iDomainId
Domain identifier.
$iPage
List page.
$iUsersPerPage
Number of users on a single page.
$sOrderBy
= 'email'. Field by which to sort.
$bAscOrderType
= true. If true the sort order type is ascending.
$sSearchDesc
= ''. If specified, the search goes on by substring in the name and email of default account.

Returns

string
public string
# getAccountInfoQuery( integer $iAccountId )

Returns query-string for obtaining account information.

Returns query-string for obtaining account information.

Parameters

$iAccountId
Account identifier.

Returns

string

Overrides

CApiUsersCommandCreator::getAccountInfoQuery
public string
# accountExistsQuery( string $sEmail, string $sLogin, integer $niExceptAccountId = null )

Returns query-string for checking if particular account exists.

Returns query-string for checking if particular account exists.

Parameters

$sEmail
Account email.
$sLogin
Account login.
$niExceptAccountId
= null Identifier of account wich should be excluded from the search.

Returns

string

Overrides

CApiUsersCommandCreator::accountExistsQuery
public string
# deleteAccountFoldersTreeQuery( integer $iAccountId )

Returns query-string for deleting account folders tree from WebMail Pro database.

Returns query-string for deleting account folders tree from WebMail Pro database.

Parameters

$iAccountId
Identifier of account to remove.

Returns

string

Overrides

CApiUsersCommandCreator::deleteAccountFoldersTreeQuery
public string
# getAccountUsedSpaceQuery( string $sEmail )

Returns query-string for obtaining account used space in Kb.

Returns query-string for obtaining account used space in Kb.

Parameters

$sEmail
Email address associated with the account.

Returns

string

Overrides

CApiUsersCommandCreator::getAccountUsedSpaceQuery

Methods inherited from CApiUsersCommandCreator

_deleteIdentitiesByWhereQuery(), _getAccountByWhereQuery(), _getCalUserByWhereQuery(), _getUserByWhereQuery(), clearMailingListMembersQuery(), clearSafetySendersQuery(), createAUserQuery(), createAccountQuery(), createCalUserQuery(), createIdentityQuery(), createUserQuery(), deleteAUserQuery(), deleteAccountFiltersQuery(), deleteAccountFoldersQuery(), deleteAccountMessageBodiesQuery(), deleteAccountMessagesQuery(), deleteAccountQuery(), deleteAccountReadsQuery(), deleteCalUserQuery(), deleteCalendarEventsQuery(), deleteCalendarsDataQuery(), deleteCalendarsPublicationsQuery(), deleteCalendarsQuery(), deleteCalendarsSharingsQuery(), deleteIdentitiesByAccountIdQuery(), deleteIdentitiesByUserIdQuery(), deleteIdentityQuery(), deleteSendersQuery(), deleteUserQuery(), enableAccountsQuery(), getAccountByEmailQuery(), getAccountByIdQuery(), getAccountIdListQuery(), getAccountIdentitiesQuery(), getCalUserQuery(), getDefaultAccountDomainIdQuery(), getDefaultAccountIdQuery(), getIdentityQuery(), getSafetySenderQuery(), getTotalUsersCountQuery(), getTwilioNumbersQuery(), getUserAccountIdQuery(), getUserAccountsQuery(), getUserByIdQuery(), getUserIdentitiesQuery(), getUsersCountForDomainQuery(), getUsersCountForTenantQuery(), insertSafetySenderQuery(), updateAccountLastLoginAndCountQuery(), updateAccountQuery(), updateCalUserQuery(), updateIdentitiesDefaultsQuery(), updateIdentityQuery(), updateUserQuery()

AfterLogic API Documentation API documentation generated by ApiGen