Helper function to find values of a named key in a multidimensional arrays or objects
zimbraSingleFindAll(array<string|int, mixed> $haystack, string $needle) : array<string|int, mixed>
mixed data
key to search for values
server side password check
zimbraSingleCheckPassword(string $pwd) : string
recheck the client side password check in case that the client side check has been disabled
password
Define module related meta data.
zimbraSingle_MetaData() : array<string|int, mixed>
Values returned here are used to determine module related abilities and settings.
Test connection to a Zimbra server with the given server parameters.
zimbraSingle_TestConnection(array<string|int, mixed> $params) : array<string|int, mixed>
Allows an admin user to verify that an API connection can be successfully made with the given configuration parameters for a server.
When defined in a module, a Test Connection button will appear alongside the Server Type dropdown when adding or editing an existing server.
common module parameters
Client area output logic handling.
zimbraSingle_ClientArea(array<string|int, mixed> $params) : array<string|int, mixed>
This function is used to define module specific client area output. It should return an array consisting of a template file and optional additional template variables to make available to that template.
The template file you return can be one of two types:
tabOverviewModuleOutputTemplate - The output of the template provided here will be displayed as part of the default product/service client area product overview page.
tabOverviewReplacementTemplate - Alternatively using this option allows you to entirely take control of the product/service overview page within the client area.
Whichever option you choose, extra template variables are defined in the same way. This demonstrates the use of the full replacement.
Please Note: Using tabOverviewReplacementTemplate means you should display the standard information such as pricing and billing details in your custom template or they will not be visible to the end user.
common module parameters
Usage Update
zimbraSingle_UsageUpdate(array<string|int, mixed> $params) : mixed
Important: Runs daily per server not per product Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats
common module parameters
Change the password for a Zimbra account.
zimbraSingle_ChangePassword(array<string|int, mixed> $params) : string
Called when a password change is requested. This can occur either due to a client requesting it via the client area or an admin requesting it from the admin side.
This option is only available to client end users when the product is in an active status.
common module parameters
Provision a new instance of a Zimbra account.
zimbraSingle_CreateAccount(array<string|int, mixed> $params) : string
Attempt to provision a new Zimbra mail account. This is called any time provisioning is requested inside of WHMCS. Depending upon the configuration, this can be any of:
common module parameters
Set a Zimbra account to status locked.
zimbraSingle_SuspendAccount(array<string|int, mixed> $params) : string
Called when a suspension is requested. This is invoked automatically by WHMCS when a product becomes overdue on payment or can be called manually by admin user.
common module parameters
Set a Zimbra account to status active.
zimbraSingle_UnsuspendAccount(array<string|int, mixed> $params) : string
Called when an un-suspension is requested. This is invoked automatically upon payment of an overdue invoice for a product, or can be called manually by admin user.
common module parameters
Removes a Zimbra account.
zimbraSingle_TerminateAccount(array<string|int, mixed> $params) : string
Called when a termination is requested. This can be invoked automatically for overdue products if enabled, or requested manually by an admin user.
common module parameters
Set a new class of service for a Zimbra account.
zimbraSingle_ChangePackage(array<string|int, mixed> $params) : string
Called to apply a change of the class of service. It is called to provision upgrade or downgrade orders, as well as being able to be invoked manually by an admin user.
This same function is called for upgrades and downgrades of both products and configurable options.
common module parameters
Define Zimbra product configuration options.
zimbraSingle_ConfigOptions(mixed $params) : array<string|int, mixed>
Gather classes of service from the Zinbra server. Calls a function to create all necessary customfields for the order form using the selected values.
Perform single sign-on for a given instance of a product/service.
zimbraSingle_ServiceSingleSignOn(array<string|int, mixed> $params) : array<string|int, mixed>
Called when single sign-on is requested for an instance of a product/service.
When successful, returns an URL to which the user should be redirected.
common module parameters
Perform an update of customfields to prevent downgrades.
zimbraSingleUpdateQuota(array<string|int, mixed> $params) : mixed
Called in changePackage or createAccount functions.
common module parameters