Revision as of 12:03, 28 February 2022

Marketing Emails

This setting controls the opt-in/opt-out functionality for Marketing e-mails, such as those sent by the mass mail tool. When enabled, a Newsletter Opt-In option is shown to new customers during checkout or registration. The default is Enabled.

Require User Opt-In

Enable this to require clients to explicit opt-in before they will receive marketing labelled e-mails. By default, users are required to opt-in to marketing emails. If you wish, you can use this setting to default the opt-in box to a checked status, requiring users instead to opt-out of marketing emails.

Marketing Email Opt-In Messaging

The message that will be displayed to clients on the client area if "Marketing Emails" is enabled and they are being asked to opt-in. Allows you to customise the message displayed to users in the opt-in request. It is important that the opt-in message accurately reflects the type of marketing emails you will be sending for compliance reasons.

Admin Client Display Format

Choose the format that your customer's names appear in throughout the admin. For example it may be desirable to display the company name instead of the contact's name.

Client Dropdown Format

Choose the format that your customer’s names appear in the client dropdown throughout the admin.

Disable Full Client Dropdown

Check this option to remove the aforementioned client dropdown. This is used on large databases where the number of clients slows down the loading of pages.

Default to Client Area

Normally when clients and visitors visit your WHMCS installation they are presented with the homepage listing the various pages; client area, submit ticket, view tickets, place order etc. Ticking this option skips this page and takes visitors directly to the client area prompting them to login.

Disable Client Area User Management

Check this option to prevent account owners from adding and managing other users. Admins can still invite and manage users at Clients > Manage Users and under Users in the client's profile.

This setting does not prevent existing users from logging in to their associated accounts.

Allow Client Registration

When enabled customers can sign up at /registration.php without ordering a product or service.

Client Email Preferences

Enabled by default. Clients will see an array of checkboxes in the client area profile page to customise which emails they receive. Disabling this option will prevent clients from changing the status. Toggling this option will not change the opt-in/out email notification preferences of clients. Further information is documented at Client_Email_Notification_Preferences.

Optional Client Profile Fields

The checkboxes ticked here will be optional on the registration and order forms. For example ticking the Phone Number field will mean clients can complete the order process without providing a phone number. Certain modules, particularly domain registrars, may require all the client profile information to function.

Locked Client/User Profile Fields

If you check this, clients and users will not be able to update this part of their contact information via the Client Area. They will need to contact you to update it.

They will be able to view the information, but it will appear as text and not as an input field.

Client Details Change Notify

Enabling this option will send an email notification to all admins when a customer changes their contact details.

Marketing Opt-out

When this option is enabled, clients will see an option to opt-out of marketing emails on the Account Details page of the client area.

When using Mass Mail or creating an email marketer rule you will see a Marketing Email? checkbox. Check this checkbox so users who have opted out do not receive this message.

Show Cancellation Link

Enabling will activate the cancellation system. Customers can request cancellation from the product details page, they then appear in Clients > Cancellation Requests along with an email notification and will be processed automatically when the cron runs. For more information refer to this page.

Monthly Affiliate Reports

Sends a monthly report email containing the status of the customer’s affiliate account when active.

Banned Subdomain Prefixes

This setting is used to prevent orders being placed using any of the subdomains listed within the field for products with the free subdomain option enabled. Add new subdomains to block in a comma separated list.

For example the default values will block users from placing orders using a subdomain such as ftp.example.com.

Encoded File Loading

When loading custom PHP assets such as hooks or widgets WHMCS will perform static analysis on ionCube encoded files. If the encoded file is evaluated as either unknown or incompatible with the environment then the file will not be loaded as normal. You may disable this feature if you have custom files that you are certain are compatible with your environment but are negatively evaluated by the static analyzer.

When this feature is enabled, any files not loaded are noted in either the activity log or the hook log.

This option can be overridden from within the configuration.php file by defining it along with a value of either true (for enabled) or false (for disabled) to the variable $enable_safe_include.

Event Handling

Events are actions that the system executes in order to complete a provisioning-related request. For example, provisioning a hosting product with WordPress® results in an event that installs WordPress on the server.

Many events can relate to the fulfillment of a single order or automation routine. The Event Handling setting controls and optimizes how and when WHMCS prepares and executes these events.

You can choose from the following options:

• Concurrent (Launch an asynchronous request.) — Run events as asynchronous requests, concurrent with the process that caused them.
  • The setting defaults to this option and most admins should select this.
  • When you select this, WHMCS will present the optimal user experience with the lowest wait times for the client.
• Inline (Handle events within the same request.) — Run all events within the same request as the process that caused them. Use this option for WHMCS installations that use uncommon or constrained CGI environments in which concurrency is not possible.
  • Prior to WHMCS 8.3, which introduced the Event Handling setting, WHMCS used this mode of event preparation and execution.
  • When you select Inline (Handle events within the same request.), clients will still have a positive experience but it may not be as fast as Concurrent (Launch an asynchronous request.).
• Cron (Defer events until the next cron run.) — Defer events to the next time that the cron runs. For more information, see Crons.
  • We only recommend this option for specialized environments with unique runtime constraints or highly-customized provisioning and procurement systems.
  • When you select this option, clients will have a quick experience but it may delay changes to remote systems.

Display Errors

If you encounter a blank page or Oops! error page in WHMCS, make certain that display_errors is enabled in the server's PHP configuration and enable then this setting.

Use the displayed error when you troubleshoot the problem.

For more information, see Troubleshooting Guide and Error Management.

Log Errors

When you enable it, this option logs PHP errors to Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier) with any errors that may occur in your WHMCS installation. This is a good feature if you do not want to show sensitive path information on public-facing pages.

For technical information, refer to Error Management.

NOTE: Enabling this option will result in a number of activity log entries, so should be used sparingly and only when debugging PHP errors. It should then be promptly switched off.

SQL Debug Mode

This option should remain unticked unless specifically instructed to change it by WHMCS support staff. When you enable it, any database-related errors will be recorded in Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier).

For technical information, refer to Error Management.

Hooks Debug Mode

In order to troubleshoot problems with action hooks, it may be necessary to log action hook activity. Checking this option will do this to Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier).

NOTE: Enabling this option will result in a large number of activity log entries, so should be used sparingly and only when debugging hook problems. It should then be promptly switched off.