Class CApiUsersCommandCreator

api_CommandCreator

CApiUsersCommandCreator

Direct known subclasses

CApiUsersCommandCreatorMySQL

Indirect known subclasses

CApiUsersCommandCreatorPostgreSQL

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

Methods summary

`public string`	# `createAUserQuery( )` Returns query-string for creating user in a_users table. Returns query-string for creating user in a_users table. Returns string
`public string`	# `createIdentityQuery( CIdentity $oIdentity )` Returns query-string for creating identity in account. Returns query-string for creating identity in account. Parameters `$oIdentity` $oIdentity Identity to create. Returns string
`public string`	# `createCalUserQuery( CCalUser $oCalUser )` Returns query-string for Creating calendar user in storage. Returns query-string for Creating calendar user in storage. Parameters `$oCalUser` $oCalUser CCalUser object. Returns string
`public string`	# `createAccountQuery( CAccount $oAccount )` Returns query-string for creating WebMail account. Returns query-string for creating WebMail account. Parameters `$oAccount` $oAccount Object instance with prepopulated account properties. Returns string
`public string`	# `createUserQuery( CUser $oUser )` Returns query-string for creating user settings and data in awm_settings table. Returns query-string for creating user settings and data in awm_settings table. Parameters `$oUser` CUser object. Returns string
`public string`	# `enableAccountsQuery( array $aAccountsIds, boolean $bIsEnabled )` Returns query-string for enabling/disabling one or several WebMail Pro accounts. Returns query-string for enabling/disabling one or several WebMail Pro accounts. Parameters `$aAccountsIds` List of accounts to be enabled/disabled. `$bIsEnabled` true for enabling accounts, false for disabling them. Returns string
`public string`	# `updateIdentityQuery( CIdentity $oIdentity )` Returns query-string for saving changes made to the identity. Returns query-string for saving changes made to the identity. Parameters `$oIdentity` $oIdentity Identity object containing data to be saved. Returns string
`public boolean`	# `updateIdentitiesDefaultsQuery( CIdentity $iIdentityId, integer $iIdAccount )` Returns query-string for updatinf value of default identity for account. Returns query-string for updatinf value of default identity for account. Parameters `$iIdentityId` $oIdentity New default identity. `$iIdAccount` Account identifier. Returns boolean
`public string`	# `updateAccountQuery( CAccount $oAccount )` Returns query-string for saving changes made to the account. Returns query-string for saving changes made to the account. Parameters `$oAccount` $oAccount Account object containing data to be saved. Returns string
`public string`	# `updateAccountLastLoginAndCountQuery( integer $iUserId )` Returns query-string for updating login-related information including time of last login. Returns query-string for updating login-related information including time of last login. Parameters `$iUserId` User identifier. Returns string
`public string`	# `updateUserQuery( CUser $oUser )` Returns query-string for updating user settings and data in awm_settings table. Returns query-string for updating user settings and data in awm_settings table. Parameters `$oUser` CUser object. Returns string
`public string`	# `updateCalUserQuery( CCalUser $oCalUser )` Returns query-string for updating calendar user settings. Returns query-string for updating calendar user settings. Parameters `$oCalUser` CCalUser object. Returns string
`protected string`	# `_deleteIdentitiesByWhereQuery( string $sWhere )` Returns query-string for removing identities by specified condition. Returns query-string for removing identities by specified condition. Parameters `$sWhere` Specified condition. Returns string
`public string`	# `deleteIdentityQuery( integer $iIdentityId )` Returns query-string for deleting identity. Returns query-string for deleting identity. Parameters `$iIdentityId` Identity identifier. Returns string
`public string`	# `deleteIdentitiesByUserIdQuery( integer $iUserId )` Returns query-string for deleting identities by specified user identifier. Returns query-string for deleting identities by specified user identifier. Parameters `$iUserId` Identifier of user wich contains identities to delete. Returns string
`public string`	# `deleteIdentitiesByAccountIdQuery( integer $iAccountId )` Returns query-string for deleting identities by specified account identifier. Returns query-string for deleting identities by specified account identifier. Parameters `$iAccountId` Identifier of account wich contains identities to delete. Returns string
`public string`	# `deleteAccountQuery( integer $iAccountId )` Returns query-string for deleting account from WebMail Pro database. Returns query-string for deleting account from WebMail Pro database. Parameters `$iAccountId` Identifier of account to remove. Returns string
`public string`	# `deleteAccountMessagesQuery( integer $iAccountId )` Returns query-string for deleting account messages from WebMail Pro database. Returns query-string for deleting account messages from WebMail Pro database. Parameters `$iAccountId` Identifier of account to remove. Returns string
`public string`	# `deleteAccountMessageBodiesQuery( integer $iAccountId )` Returns query-string for deleting account messages bodies from WebMail Pro database. Returns query-string for deleting account messages bodies from WebMail Pro database. Parameters `$iAccountId` Identifier of account to remove. Returns string
`public string`	# `deleteAccountFiltersQuery( integer $iAccountId )` Returns query-string for deleting account filters from WebMail Pro database. Returns query-string for deleting account filters from WebMail Pro database. Parameters `$iAccountId` Identifier of account to remove. Returns string
`public string`	# `deleteAccountReadsQuery( integer $iAccountId )` Returns query-string for deleting account reads from WebMail Pro database. Returns query-string for deleting account reads from WebMail Pro database. Parameters `$iAccountId` Identifier of account to remove. Returns string
`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
`public string`	# `deleteAccountFoldersQuery( integer $iAccountId )` Returns query-string for deleting account folders from WebMail Pro database. Returns query-string for deleting account folders from WebMail Pro database. Parameters `$iAccountId` Identifier of account to remove. Returns string
`public string`	# `deleteCalUserQuery( integer $iUserId )` Returns query-string for deleting calendar user settings from the storage. User identifier is used for look up. Returns query-string for deleting calendar user settings from the storage. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteUserQuery( integer $iUserId )` Returns query-string for deleting user settings and data from database. User identifier is used for look up. Returns query-string for deleting user settings and data from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteAUserQuery( integer $iUserId )` Returns query-string for deleting user from database. User identifier is used for look up. Returns query-string for deleting user from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteSendersQuery( integer $iUserId )` Returns query-string for deleting user senders from database. User identifier is used for look up. Returns query-string for deleting user senders from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteCalendarEventsQuery( integer $iUserId )` Returns query-string for deleting user calendar events from database. User identifier is used for look up. Returns query-string for deleting user calendar events from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteCalendarsQuery( integer $iUserId )` Returns query-string for deleting user calendars from database. User identifier is used for look up. Returns query-string for deleting user calendars from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteCalendarsDataQuery( integer $iUserId )` Returns query-string for deleting user calendars' data from database. User identifier is used for look up. Returns query-string for deleting user calendars' data from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteCalendarsPublicationsQuery( integer $iUserId )` Returns query-string for deleting user calendars' publications from database. User identifier is used for look up. Returns query-string for deleting user calendars' publications from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `deleteCalendarsSharingsQuery( integer $iUserId )` Returns query-string for deleting user calendars' sharings from database. User identifier is used for look up. Returns query-string for deleting user calendars' sharings from database. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `getTwilioNumbersQuery( $iTenantId )` Returns query-string for obtaining twilio numbers for default accounts with allowed twilio. Tenant identifier is used for look up. Returns query-string for obtaining twilio numbers for default accounts with allowed twilio. Tenant identifier is used for look up. Parameters `$iTenantId` identifier. Returns string
`public string`	# `getUsersCountForDomainQuery( integer $iDomainId, string $sSearchDesc = '' )` Returns query-string for determining how many users are in particular domain, with optional filtering. Domain identifier is used for look up. Returns query-string for determining how many users are in particular domain, with optional filtering. Domain identifier is used for look up. Parameters `$iDomainId` Domain identifier. `$sSearchDesc` = '' If not empty, only users matching this pattern are counted. Returns string
`public string`	# `getUsersCountForTenantQuery( integer $iTenantId )` Returns query-string for determining how many users are in particular tenant. Tenant identifier is used for look up. Returns query-string for determining how many users are in particular tenant. Tenant identifier is used for look up. Parameters `$iTenantId` Tenant identifier. Returns string Api
`public string`	# `getAccountByEmailQuery( string $sEmail )` Returns query-string for retrieving information about account wich is specified as default. Email address is used for look up. The method is especially useful in case if your product configuration allows for adding multiple accounts per user. Returns query-string for retrieving information about account wich is specified as default. Email address is used for look up. The method is especially useful in case if your product configuration allows for adding multiple accounts per user. Parameters `$sEmail` Email address associated with the account. Returns string
`public string`	# `getAccountByIdQuery( integer $mAccountId, boolean $bIdIsMd5 = false )` Returns query-string for retrieving information on WebMail Pro account. Account ID is used for look up. Returns query-string for retrieving information on WebMail Pro account. Account ID is used for look up. Parameters `$mAccountId` Account identifier. `$bIdIsMd5` Default value is false. Returns string
`public string`	# `getCalUserQuery( integer $iUserId )` Returns query-string for obtaining CCalUser object that contains calendar settings for specified user. User identifier is used for look up. Returns query-string for obtaining CCalUser object that contains calendar settings for specified user. User identifier is used for look up. Parameters `$iUserId` User identifier. Returns string
`public string`	# `getIdentityQuery( integer $iIdentityId )` Returns query-string for obtaining identity. Returns query-string for obtaining identity. Parameters `$iIdentityId` Indentity identifier. Returns string
`public string`	# `getAccountIdentitiesQuery( integer $IdAccount )` Returns query-string for obtaining list of identities belonging to account. Returns query-string for obtaining list of identities belonging to account. Parameters `$IdAccount` Identifier of account that contains identities to get. Returns string
`public string`	# `getUserIdentitiesQuery( integer $IdUser )` Returns query-string for obtaining list of identities belonging to user. Returns query-string for obtaining list of identities belonging to user. Parameters `$IdUser` Identifier of user that contains identities to get. Returns string
`public string`	# `getUserByIdQuery( integer $iUserId )` Returns query-string for retrieving information on particular WebMail Pro user. Returns query-string for retrieving information on particular WebMail Pro user. Parameters `$iUserId` User identifier. 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
`public string`	# `getDefaultAccountDomainIdQuery( integer $iUserId )` Returns query-string for obtaining domain identifier for primary user account. Returns query-string for obtaining domain identifier for primary user account. Parameters `$iUserId` WebMail Pro user identifier (not to be confused with account ID). Returns string
`public string`	# `getDefaultAccountIdQuery( integer $iUserId )` Returns query-string for obtaining identifier of primary user account. Returns query-string for obtaining identifier of primary user account. Parameters `$iUserId` WebMail Pro user identifier. Returns string
`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
`public string`	# `clearMailingListMembersQuery( integer $iMailingListId )` Returns query-string for clearing mailing list members. Returns query-string for clearing mailing list members. Parameters `$iMailingListId` Mailing list identifier. Returns string
`protected string`	# `_getAccountByWhereQuery( string $sWhere )` Returns query-string for obtaining account by specified condition. Returns query-string for obtaining account by specified condition. Parameters `$sWhere` Specified condition. Returns string
`protected string`	# `_getCalUserByWhereQuery( string $sWhere )` Returns query-string for obtaining calendar user by specified condition. Returns query-string for obtaining calendar user by specified condition. Parameters `$sWhere` Specified condition. Returns string
`protected string`	# `_getUserByWhereQuery( string $sWhere )` Returns query-string for obtaining user by specified condition. Returns query-string for obtaining user by specified condition. Parameters `$sWhere` Specified condition. Returns string
`public string`	# `getAccountIdListQuery( integer $iUserId )` Returns query-string for retrieving list of accounts' identifier for given WebMail Pro user. Returns query-string for retrieving list of accounts' identifier for given WebMail Pro user. Parameters `$iUserId` User identifier. Returns string
`public string`	# `getTotalUsersCountQuery( )` Returns query-string for calculating total number of users registered in WebMail Pro. Returns query-string for calculating total number of users registered in WebMail Pro. Returns string
`public string`	# `getUserAccountsQuery( integer $iUserId )` Returns query-string for retrieving list of information about email accounts for specific user. Returns query-string for retrieving list of information about email accounts for specific user. Parameters `$iUserId` User identifier. Returns string
`public integer`	# `getUserAccountIdQuery( integer $iUserId, string $sEmail )` Returns query-string for obtaining account identifier for specific user and account email. Returns query-string for obtaining account identifier for specific user and account email. Parameters `$iUserId` Identifier of user that contains account. `$sEmail` Email of account that is looked up. Returns integer
`public string`	# `getSafetySenderQuery( string $iUserId, string $sEmail )` Returns query-string for checkinf whether specific address is in safelist for particular user. Returns query-string for checkinf whether specific address is in safelist for particular user. Parameters `$iUserId` User identifier. `$sEmail` Email of sender. Returns string
`public string`	# `insertSafetySenderQuery( integer $iUserId, string $sEmail )` Returns query-string for inserting safety sender. Returns query-string for inserting safety sender. Parameters `$iUserId` User identifier. `$sEmail` Email of safety sender. Returns string
`public string`	# `clearSafetySendersQuery( string $iUserId )` Returns query-string for purging all entries in safelist of particular user. Returns query-string for purging all entries in safelist of particular user. Parameters `$iUserId` User identifier. Returns string
`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

Packages

Classes

Class CApiUsersCommandCreator

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Api

Parameters

Returns

Parameters

Returns