Child pages
  • Webmail
This documentation is for cPanel & WHM version 80 EDGE builds.  The "RELEASE" version of our documentation can be found in the Version 78 Documentation space.


Skip to end of metadata
Go to start of metadata

Overview

Webmail allows you to access your email account through any browser or mobile device.

Access Webmail

To log in to Webmail, you can use either of the following methods:

  • Navigate to https://example.com:2096 in your browser. In this example, replace example.com with your email address's domain. For more information, read our How to Log in to Your Server or Account documentation.
  • Navigate to cPanel's Email Accounts interface (cPanel >> Home >> Email >> Email Accounts). Then, locate the email account in the table and click Check Email. The Webmail interface will open in a new browser tab.

After you log in, the Webmail interface will display a logo for each email application.

  • Click a logo to access Webmail in that application.
  • Click Set as Default to always open Webmail in the selected application by default.

Disk usage

The top-right corner of the Webmail interface displays your email account's current disk usage. Click this value to navigate to Webmail's Manage Disk Usage interface. You can use this interface to ensure that you do not exceed your quota.

User Preferences

In the top-right corner of the interface, click your email address to access the User Preferences menu.

You can set any of the listed interfaces as the default interface when you log in to Webmail. For example, click the star icon () for the option in the menu. Webmail will automatically display the interface when you log in.

In This Document

For cPanel Users

The following table lists the options in the User Preferences menu:


Use the Horde application to sort, view, and send email. This application is useful for users who need a full set of features. It includes, for example, mobile email access and advanced productivity tools.

Remember:

Click Set as Default in the Webmail interface to automatically open Horde when you log in.

Application websiteThe Horde Project
Interface type
  • Three-pane format with view pane
  • Mobile interface available
Composition features
  • Attachments
  • HTML composition
  • Spell check
Organization features
  • Folder manipulation
  • Mail filters
  • Message flags
  • Search mail
  • Threaded conversation view
Additional features
  • Address book
  • Calendar
  • Task list
  • Event reminders
  • News feed
  • Notes

Use the Roundcube application to sort, view, and send email. It's useful if you need a friendly-to-use interface with a few additional features.

Remember:

Click Set as Default in the Webmail interface to automatically open Roundcube when you log in.

Application websiteRoundcube Webmail Project
Interface type
  • Three-pane format with view pane
Composition features
  • Attachments
  • HTML composition
  • Spell check
Organization features
  • Drag-and-drop organization
  • Folder manipulation
  • Message flags
  • Search mail
  • Threaded conversation view
  • Email archiving
Additional features
  • Address book
  • Calendar
  • System administrators can use plugins to add custom features.

Spam Filters

Use this interface to filter unwanted spam email before it reaches your inbox.

Spam Auto-Delete Threshold

Set this score to automatically delete messages that meet or exceed the Set a custom threshold score.

Warning:

Make certain that you properly configure the score. It permanently deletes any message that meets or exceeds the score. This could include non-spam messages.

Configure Auto-Delete Settings

To enable and customize the Set a custom threshold score:

  1. Select Set a custom threshold.
  2. Enter a number in the Set a custom threshold text box.
  3. Click Submit.

Note:

The lower the threshold, the more emails the server will discard.

To disable the Auto-Delete feature, select Disable Spam Auto-Delete, then click Submit.

Autoresponders

Use this interface to configure an email account to send automated emails. This can be useful if you're on vacation, unavailable, or have a generic message to send often.

Add an autoresponder

Important:

You can only add one autoresponder for each email address. If you attempt to add multiple autoresponders, an error message will appear.

To add an autoresponder, perform the following steps:

  1. Click Add Autoresponder. A new interface will appear.
  2. Select a character set from the Character Set menu. We recommend that you use the default Character Set value of utf-8.

  3. Enter the interval, in hours, to wait between responses to the same email address.

    • For example, you could create an autoresponder with an interval of 24. If it receives an email at 8:00 AM on Monday, it immediately responds to the message. It doesn't respond again to the same email address until 8:00 AM on Tuesday.

    • If you set the interval to 0, the system sends an automatic response to every email.

  4. In the From text box, enter the username to appear in the response.
  5. In the Subject text box, enter the subject to appear in the response.
  6. If the response message includes HTML tags, select the HTML checkbox.
  7. In the Body text box, enter the text of the response, for example:

    I am out of the office until July 2nd. You can reach me on my cell phone in case of emergencies.
    • You can use the following tags in the message. They represent information, such as the incoming email's sender or subject:

      • %subject% — The subject of the message that the autoresponder received.
      • %from% — The name of the sender of the message that the autoresponder received. If the sender's name was not in the original email's header, the %from% tag prints the sender's email address.
      • %email% — The sender's email address.

    • Tags use percentage signs (%) as markers.
  8. Select a start time. You can select Immediately or Custom.
    • If you select Custom, a small calendar will appear. Use the calendar to configure your start time. Click anywhere outside of the calendar to save the configuration and close the calendar. Your chosen date and time will replace the Custom text.

      Note:

      • The system bases the time on the user's local computer's time setting and translates it into it.
      • This feature uses 12-hour notation and reformats times in 24-hour notation. For example, if you select 18:30 as the start time, the system automatically reformats the time as 6:30 PM.
  9. Select a stop time. You can select Never or Custom.

    Note:

    You must select a stop time that is later than the start time.

  10. Click Create to create the autoresponder. Click Modify to update the current autoresponder.

Current autoresponders

This section lists any autoresponders that you create.

To find an autoresponder's specific email address, enter a keyword in the Search text box and click Go.

Important:

The autoresponders you create will ignore messages with a score of 5 or higher.

BoxTrapper

Use BoxTrapper to filter spam from your inbox. It uses a challenge-response method to verify the sender. BoxTrapper-enabled accounts respond to incoming emails with a verification email. The sender must finish the process before the email goes to your inbox.

Enable BoxTrapper

To enable BoxTrapper, click Enable.

Note:

When you enable BoxTrapper, it automatically whitelists the addresses you send email to. The system does this even if you disable automatic whitelisting.

BoxTrapper Configuration

Use the following options to edit BoxTrapper settings:

Configure Settings

To configure BoxTrapper settings, perform the following steps:

  1. Click Configure Settings.
  2. Enter a comma-separated list of email addresses that forward mail to the account in the Email addresses for this account text box.
  3. Enter your name in the Your Name text box.
  4. Enter the number of days for which you wish to keep logs and messages in the The number of days that you wish to keep logs and messages in the queue. text box. 
  5. Enter the desired minimum spam score in the Minimum SpamAssassin Spam Score required to bypass BoxTrapper text box.

    Note:

    When BoxTrapper receives an email with a spam score that is lower than the Minimum SpamAssassin Spam Score required to bypass BoxTrapper value, it automatically delivers the message. The default value for this option is -2.5

  6. To enable or disable automatic whitelisting, select the appropriate checkbox.

    Note:

    BoxTrapper will automatically whitelist any email address to which you send a message.

  7. Select the Automatically whitelist the To and From lines from whitelisted senders (whitelist by association) checkbox to automatically whitelist addresses in the To and CC lines of incoming whitelisted emails. 
  8. Click Save.

Edit Confirmation Messages

  1. To configure your BoxTrapper messages, click Edit Confirmation Messages. BoxTrapper automatically responds to email with messages that the system builds from the following templates:
    • blacklist — BoxTrapper responds with this message when a blacklisted address sends an email.
    • returnverify — BoxTrapper responds with this message when the verification process fails.
    • verifyreleased — BoxTrapper responds with this message when a person responds to the verify message with an email or a click on the verification link.
    • verify — BoxTrapper responds with this message when an address that does not exist on the whitelist or blacklist sends an email. This message requests a response to confirm that the sender is legitimate.
  2. To customize the verification and blacklist message templates, click Edit. (To restore the default message templates, click Reset to Default.) A new interface will appear. These templates use the following variables:
    • %email% — The sender's email address.
    • %fromname% — The recipient's name.
    • %subject% — The subject of the sender's email.
    • %acct% — The recipient's username.
    • %msgid% — The message ID of the sender's email.
    • %headers% — The heading information of the sender's email.
    • %if can_verify_web% and %endif% — These tags enclose a section that allows BoxTrapper to verify senders through a web link.

      Warning:

      Do not alter verify#%msgid% in the subject line of the verify message template. BoxTrapper requires that specific code to function properly.

Edit White/Black/Ignore Lists

To edit lists, perform the following steps:

  1. Click Edit White/Black/Ignore lists.
  2. Click the list that you want to modify.
  3. Enter any messages, subjects, or email addresses to filter.
  4. Click Save.
BoxTrapper lists

The system compares every new message that you receive against the following three lists:

  • Whitelist — The system delivers messages directly to your inbox.
  • Ignore list — The system deletes messages without a notification.
  • Blacklist — The system deletes messages, and the sender receives a reply that indicates that the system blocked the message.

Forward List

Click Forward List to update the account's forward list. Enter email addresses that you wish to add to the forward list, and click Save. The system will automatically forward whitelisted emails to these addresses.

Review Log

The system organizes this log by day and displays any activity for an email address that uses BoxTrapper. Use this log, for example, to isolate problems with email delivery.

Review Queue

Click Review Queue to view any unverified BoxTrapper mail.

To deliver or delete messages, perform the following steps:

  1. Select the checkbox for the desired day.
  2. Select Delete to delete the messages. Select Whitelist and Deliver to whitelist the address deliver the messages.
  3. Click Submit.

To see the contents of a message, perform the following steps:

  1. Click the email’s sender, subject, or date to see the entire message, headers, and more delivery options. For example, you can ignore or blacklist a sender.
  2. Select the option for which you wish to filter. 
  3. Click Go.

Calendars and Contacts

Use this interface to get the information you need to set up your calendar and your contacts. You can access your calendars and contacts on a mobile device.

To do this, configure your mobile email client (for example, iOS® Mail®). Connect to CalDAV for calendars, or connect to CardDAV for contacts.

For more information, read our How to Set Up Calendars and Contacts documentation.

Password and Security

Use this interface to update your account's password. A strong password helps you to secure your Webmail account.

Change your password

To change your password, enter the desired information and click Save, or use the Password Generator feature.

Note:

You must enable Digest Authentication if you use Windows® Vista, Windows® 7, Windows® 8, or Windows® 10 and you access Web Disk over a clear text, unencrypted connection.

Create a strong password

To ensure your account's security, make certain to create a strong password:

  • Use a different password for each of your important accounts (for example, your email accounts). 
  • Use a combination of letters, numbers, and symbols in your password.

Password Generator

The Password Generator feature generates secure passwords, which are hard to guess. You can use the Password Generator feature in any interface that displays it. 

When you click Password Generator, a new interface appears that contains a generated password in a text box. Click Generate Password until it generates a satisfactory password.

Configure security requirements

To set the security requirements of the new password, perform the following steps:

  1. Click Advanced Options.
  2. Enter the desired length of the password in the Length text box.
  3. Select whether to include uppercase letters, lowercase letters, numbers, or symbols.
  4. Copy the password in a safe place and select the I have copied this password in a safe place checkbox at the bottom of the interface.
  5. Click Use Password to use the generated password. To reject the password and close the Password Generator interface, click Cancel.

External Authentication

Note:

This section only appears if your hosting provider allows this.

Your hosting provider may let you access Webmail with external authentication credentials. For example, you could use cPanelID, WHMCS, Google® Accounts, Facebook®, or your hosting provider's portal. If you do this, you don't have to remember as many passwords.

The External Authentication tab lists the credentials for OpenID Connect-compliant identity providers that you can use to log in to Webmail.

You can also use this section of the Password and Security interface to link new credentials or unlink existing credentials.

Note:

  • You can only view external authentication methods if they are available.
  • Most identity providers let you register during this process.
  • Your cPanelID uses the same login as the store, the ticket system, and the billing system. If you do not already use a cPanelID, you can register for one during the authentication process.
  • You can link one or more external accounts to one or more Webmail accounts.

  • Some identity providers use two-factor authentication (2FA). You must log in through them and use 2FA.

Link your account

To link your account with a provider:

  1. Select the External Authentication tab.
  2. Click Link Account next to the name of the appropriate identity provider. A new login interface will appear for that identity provider.
  3. Enter the requested login credentials. If you're logged in to that provider, the Password and Security interface skips this step.
  4. Confirm linking your account with the provider.
  5. Confirm that you wish to link your Webmail account to the provider's authentication credentials.

Unlink your account

To unlink your account, click Unlink Account for the appropriate account.

A new interface will appear to confirm unlinking your account.

Configure Mail Client

Use this interface to configure a desktop email client (for example, MacOS® Mail.app® for Mojave). Email clients require specific information. The options below provide this information. Alternatively you can use the information in the Mail Client Manual Settings section.

Mail Client Automatic Configuration Scripts

This interface has information and tools to help you configure your mail client.

  • To download a tool that automatically configures your mail client, click the desired protocol. Then, follow the displayed directions.
  • To manually configure your mail client, use the information under Mail Client Manual Settings. We strongly recommend that you use the displayed SSL/TLS settings.

Mail Client Manual Settings

If you don't see your mail client in the list, you can configure it using the manual settings.

Email Instructions

You can also send the manual configuration settings as an email. To send the email, enter the recipient address in the Email Instructions text box and click Send.

Contact Information

Use this interface to store contact information for your Webmail account. You can also set your contact preferences.

Contact Preferences

Note:

To use this setting, your hosting provider must enable it.

You can select the following settings in the Contact Preferences section of the interface:

SettingDescription
Someone logs in to my account.

This setting notifies you when someone logs in to your account. It is useful if you suspect that someone else has your account password.

Note:

  • In order to use this setting, your hosting provider must enable cPHulk.
  • To resolve this issue, change your account password to a more secure password.
  • The system only sends a single notice in each 24-hour window for a specific username, service, and IP address combination.
  • The system won't send notices if you log in successfully from a location that successfully logged in before. To enable these notices, select the Send login notifications, even when the user logs in from an IP address range or netblock that contains an IP address from which a user successfully logged in previously. checkbox.

Send login notifications, even when the user logs in from an IP address range or netblock that contains an IP address from which a user successfully logged in previously.

This setting notifies you whenever someone logs in to your account. This sends notifications for logins from any IP address.

My preference for successful login notifications is disabled.

This setting notifies you if someone disabled the Someone logs in to my account setting.

Manage Disk Usage

Use this interface to free up disk space. You can view all of your mailboxes and remove old or large messages.

Use the Search text box to search for specific mailbox names.

The mailbox table

The mailbox table contains a list of mailboxes. You can sort this information by the name, the number of messages, or disk usage.

  • Mailbox Name — The name of the mailbox.
  • # of Messages — The number of messages for the address or in the mailbox folder.
  • Disk Usage — The disk usage for each address or mailbox, in bytes, Kilobytes (KB), Megabytes (MB), or Gigabytes (GB).
  • Actions — The actions available for the mailbox.

Remove messages

To remove messages, perform the following steps:

  1. Click Manage.

  2. Select a removal option from the menu.

    Note:

    Select Custom query ... to customize your removal option. For more information, read Dovecot's Search Query Format documentation.

  3. Click Delete Permanently.

Email Filters

Use this interface to create and manage email filters for your main email account.

Important:

We recommend using many simple filters instead of a single large filter. The system handles this more efficiently.

Create a filter

To create a new filter, perform the following steps:

  1. Click Create a New Filter.

  2. Enter a name for the filter in the Filter Name text box.
  3. Configure your filter's rules and actions.

    Note:

    For detailed information on how to configure your filter, read our How to Configure Mail Filters documentation.

  4. Click Create.

Current Filters

To list an email account's filters, click Manage Filters in the row of the appropriate email account. The Current Filters table lists all of the filters for the selected email account.

Edit a filter

To edit an existing filter, perform the following steps:

  1. Click Edit next to the appropriate filter name.

  2. Make the desired changes to the filter.
  3. Click Save.

Delete a filter

To delete a filter, perform the following steps:

  1. Click Delete for the appropriate filter name.
  2. Click Delete Filter.

Test a filter

To test a filter, perform the following steps:

  1. In the Filters by Users table, click Manage Filters next to the desired email account.

  2. Enter a test email message in the Filter Test text box.

    Note:

    Include the characters or words that you applied to configure the filter.

  3. Click Test Filter.

Forwarders

Use this interface to forward incoming emails from one address to another. For example, this could let you use one email account to check email for many accounts.

Note:

To manage forwarders for email accounts that use the BoxTrapper feature, use the BoxTrapper interface.

Add Forwarder

To add a mail forwarder, perform the following steps:

  1. Click Add Forwarder. A new tab will appear. Your email address will appear in the Forwarding section.
  2. Enter the address to forward email to in the text box.
  3. Click Add Forwarder.

Email Account Forwarders

The Email Account Forwarders table lists the email addresses that your account redirects to.

  • To quickly find a specific email address, enter a keyword in the Search text box and click Go.
  • To view the route that a forwarded email takes, click Trace in the Functions next to that email address.
  • To delete a forwarder, click Delete next to that email address, and then click Delete Forwarder to confirm.

    Important:

    • If you do not delete the Webmail account that uses email forwarding, both accounts will receive email.
    • You can forward all incoming mail from one account to another without receiving email at the first account. To do this, create a forwarder from an address that does not have an account.

Search Index

Use this interface if you have problems when you search for mail in your local mail application. When you click Reindex, you reorganize the databases. This feature should fix the problem.

To reorganize the databases, click Reindex.

Track Delivery

Use this interface to view email message delivery reports. You can also use this interface to trace a message's delivery route. This feature can help you find delivery problems.

Search

You can search for the status of an email address's message delivery attempts. By default, this lists the 250 most recent delivery failures for your mailboxes.

To view the status of message delivery attempts, perform the following steps:

  1. Enter a email address in the Recipient Emailtext box.

  2. Click Run Report.

  3. Click Show All to refresh the results in the Delivery Report table and the Email Server Trace diagram.

    Note:

    • To display all of the account's messages, do not enter an address in the Recipient Email text box.
    • To display only the delivery failures, click Show Blocked & Failed.

The Delivery Report table

Important:

Your hosting provider must enable this feature for the Delivery Report table to display messages.

Note:

To add columns to the Delivery Report table, follow the directions in the Column selection section.

By default, the table sorts your query's results into the following columns:

Column

Description

Event

An icon that indicates the message's delivery status:

IconDescription

The system successfully delivered the message.

The message's status is unknown, or delivery is in progress.

The system deferred the message.

The message encountered a delivery error.

The system archived the message.
The system rejected and discarded the message at SMTP time. This is usually because the sender's server doesn't use a secure configuration or is on a list.
The mail server accepted the message but did not deliver the message to the recipient's inbox. This usually happens if spam software filtered the message.
From AddressThe email address on your system that sent the message.
SenderThe sender's Webmail username.
Sent TimeThe date and time when the user sent the message.
Spam ScoreThe message's Apache SpamAssassin™ score.
RecipientThe email address to which the user sent the message.
ResultA message that describes the delivery results.
Actions

Click the information icon ( ) to view and print information about the message. (For example, the message's sender, recipient, and username.)

The system retains this data for the number of days that your hosting provider specifies.

Table Options

Record selection

To filter the records:

  1. Select any of the following checkboxes:
    • Show Successes
    • Show Deferred
    • Show Failures
    • Show In-Progress
  2. Select the maximum number of results to display from the Max Results/Type menu.
Column selection

To select the columns that you wish to display or hide in the Delivery Report table, click the table options icon ( ). A new interface will appear.

  • To display the column, select the checkbox.
  • To hide the column, deselect the checkbox.

From the Table Options interface, select or deselect the checkboxes for the following column headers:

Option

Description

Select AllSelect this checkbox to select all available options.
EventAn icon that indicates the message's delivery status. For more information, read the The Delivery Report table section.
UserThe sender's Webmail username.
DomainThe sender's domain.
From AddressThe email address on your system that sent the message
SenderThe sender's Webmail username.
Sent TimeThe date and time when the user sent the message.
Sender HostThe sender's host's IP address.
Sender IP Address
The sender's IP address.
AuthenticationThe sender's authentication type.
Spam ScoreThe email's Apache SpamAssassin score.
RecipientThe email address to which the user sent the message.
Delivery UserThe username that owns the recipient's email address.
Delivery DomainThe recipient's domain.
Delivered ToThe recipient's email address.
RouterThe internal router that the mail server used to determine the message's destination.
TransportThe recipient's SMTP type.
Out TimeThe date and time when the intended recipient received the message.
IDThe outgoing message's unique identifier.
Delivery HostThe recipient email exchanger's hostname.
Delivery IP Address
The recipient email exchanger's IP address.
SizeThe size of the outgoing message.
ResultA message that describes the delivery results.
Actions

Click the information icon ( ) to view and print information about the selected message. This information includes the message's sender, recipient, username, and more.

The Email Server Trace diagram

This diagram displays the sent email's route from its source to its destination. Under the Legend heading, the following icons appear:

Icon

Description

The mail routing errors that your message encountered.

The filters through which the message passed.

The message's SMTP destination.

The local mailbox to which the system delivered the message.

Each icon displays information about the message's delivery path.

Account Preferences

Use this interface to modify your Webmail account settings.

In the Automatically Create Folders for Plus Addressing section, you can decide how the server manages messages that use plus addressing. Select one of the following options:

  • Automatically Create Folders — The server creates a new folder.
  • Do Not Automatically Create Folders — The server does not create a new folder.

Note:

  • The server moves a message that uses plus addressing to a designated folder if the folder exists. For example, the system would place a message to user+plusaddress@example.com in the plusaddress folder.
  • If the folder does not exist, or if you select Do Not Automatically Create Folders, the server will deliver the message to the INBOX folder.

For more information, read our plus addressing documentation.

Mail client automatic configuration scripts

The Webmail interface can help you set up your local mail client (for example, MacOS® Mail.app® for Mojave).

  • To download a tool to configure your mail client, click the protocol for it. Then, follow the displayed instructions. If applicable, click Proceed and follow the displayed instructions.
  • To manually configure your mail client, use the information under Mail Client Manual Settings. We strongly recommend that you use the displayed SSL/TLS settings.

Note:

You can read your email messages in a mail program (for example, Thunderbird®). You can download your messages with one of two protocols, IMAP and POP3. We recommend that you use the IMAP protocol to download email to a mail program (mail client). POP3 protocol does not update the server when you read mail. Because of this, mail that you viewed in the mail client will appear unread in the Webmail interface.

Email Instructions

You can also send the manual configuration settings as an email. To send the email, enter the recipient address in the Email Instructions text box and click Send.