help centre
For more info visit status.atmail.com

How can we help?


Search our knowledge base for answers to
common questions and latest updates.



My activities New request

Follow

WebAdmin Help Guide

Stewart -

PROBLEM
I need to know how to use the Atmail WebAdmin.

ENVIRONMENT

  • On-Premise Server + WebMail Installations: Version 7.0 > Current Version
  • Webmail Only Installations: Version 7.0 > Current Version

CAUSE
Requirement for understanding the Atmail WebAdmin.

RESOLUTION

Dashboard Help

After logging into Web Administration you'll be taken to the Dashboard, where you can view Atmail's log statistics. Click on a folder name in the left pane to view the statistics for the corresponding log. You can view log statistics for the last day, month, or year with the buttons in top-right corner of the interface.

Logins

View the number of account logins. Main graph displays total number of logins; separate graphs are provided for WebMail, POP3 and IMAP logins.

Received Mail

View the total number of messages received by Atmail's SMTP server.

Sent Mail

View the total number of messages sent from Atmail's SMTP server. Separate graphs are provided for email sent by SMTP and WebMail.

Spam

View the number of Spam messages. Separate graphs are provided for total Spam, Marked Spam, Rejected Spam, RBL Blocked Spam, and Moved Spam.

Viruses

View the number of viruses detected.

Search Logs

You can search the logs using predefined ranges. Such as weekly and monthly.

 

User Manager Help

The User Manager displays a list of user groups and domains in the left pane, a list of users in the selected group in the middle pane, and information about the selected user in the right pane. The right pane will also be used when creating or editing users.

Use the search facility to filter list results using name: surname: company: lastlogin:(YYYY-MM-DD) department: country: group: sort: order:(ASC,DESC) to filter results by specific fields (combinations allowed)

New Domain

Adds a new email domain to the Atmail server. Click the “New Domain” button and enter the DNS name of the domain you'd like to add. The domain's MX record must point to the Atmail server before mail will be received.

New Group

Adds a new group to the Atmail server.

New User

Click to create a new email account. Specify the new user's details in the appropriate fields, using the green ”+” (plus sign) and red ”-” (minus sign) buttons to add or remove fields as needed. Fields marked with an asterisk “*” are required. You can toggle optional fields using the “More Information” drop-down box. Click the “Create User” button when finished.

Import Users

Upload a CSV file to import users into the system for bulk automation.

Edit User

Click to edit the selected email account. Specify the user's new details in the appropriate fields, using the green ”+” (plus sign) and red ”-” (minus sign) buttons to add or remove fields as needed. You can toggle optional fields using the “More Information” drop-down box. Click the “Update User” button when finished.

Delete User

Deletes the selected user(s) from Atmail. Note that this does not ask for confirmation before deleting the selected user(s).

More

Select All

Selects all user accounts in the current view.

Deselected

Deselects all selected user accounts.

Edit Domain Settings

Inherit Settings

Switch on to inherit the main system settings, or specify custom settings.

Group Description

Optionally give a description for the group.

License Type     

Domains and users created on those Domains will be assigned to this license type unless they are assigned to a domain or group with a custom type set.

Webmail

Toggle on/off user access to WebMail.

External POP3

Toggle on/off external POP3 access to the server.

External IMAP

Toggle on/off external IMAP access to the server.

Groupware Zone

Groupware Zone sets the level of access for Calendar and Addressbook sharing.

Calendar

Enable or disable Calendar access for users.

Addressbook sharing

Allow users to share address book entries.

Sync Enabled

Allow synchronization with external devices and applications.

Edit Group Settings

Group Description

Give a description for the group.

License Type

Domains and users created on those Domains will be assigned to this license type unless they are assigned to a domain or group with a custom type set.

Webmail

Toggle on/off group members access to WebMail.

External POP3

Toggle on/off external POP3 access to the server for group members.

External IMAP

Toggle on/off external IMAP access to the server for group members.

Groupware Zone

Groupware Zone sets the level of access for Calendar and Addressbook sharing.

Calendar

Enable or disable Calendar access for group members.

Addressbook sharing

Allow group members to share address book entries.

Sync enabled

Allow synchronization with external devices and applications.

 

 

Services

 

Email Services

POP3/IMAP

Excluded Domains/Groups

There may be Domains or Groups that are excluded from some or all settings. Click the link to view the list.

Groups default POP3 state

Default state for new groups. Allow POP3 connections. This allows group users to connect to your server via any standard mail-client using POP3

Groups default IMAP state

Default state for new groups. Allow IMAP connections. This allows group users to connect to your server via any standard mail-client using IMAP

Enable SSL POP3/IMAP

Allow SSL for POP3 and IMAP connections. This allows users to connect to your server securely via POP3 and IMAP.

SSL Certificate Path

Specify the path to your SSL Certificate file.

SSL Key Path

Specify the path to your SSL Key file.

Default Domain

Specify the default domain to use when authenticating via POP or IMAP, this is used when users do not specify a domain-name during authentication.

Maximum POP3/IMAP processes

Set the maximum POP3/IMAP processes to allow simultaneously.

Maximum connections per IP

Set the maximum number of connections allowed per user/IP. Useful for preventing abuse and throttling connections from high-load.

 

SMTP

Enable SMTP Auth

Requires users to authenticate to the SMTP server before sending email.

Enable SMTP TLS

Allows users to send email via the SMTP server using TLS or SSL.

IMAP/POP before SMTP

Adds the user's IP address to the SMTP relay database after their mail client authenticates to the mailserver. This allows users who authenticate via POP or IMAP to send messages through the Atmail SMTP server.

IMAP/POP relay timeout

The length of time a POP/IMAP user can send messages via Atmail's SMTP server without reauthenticating via POP or IMAP. When this period of time has passed since the last time a POP or IMAP user authenticated, they will not be allowed to send SMTP messages until they've authenticated again.

Verify Senders

With this enabled, Atmail will check that the sender of each mail received by the system has a valid MX record (useful to help stop bogus messages from reaching the SMTP server).

Throttle Mail Recipients

When a user attempts to deliver a message to a large number or recipients, Atmail will reduce the connection speed to avoid abuse of the SMTP server by bots and spammers.

Limit Recipients per Address

You can set a limitation on how many emails a local user can send per hour. This discourages potential spammers from using your service to send out spam emails.

Maximum Recipients per Address per Hour

Set the maximum number of emails a single local user can send per hour.

Maximum Connections

The maximum number of simultaneous SMTP connections to allow. This should be low enough to prevent DOS-type attacks, and may help with tuning the performance of a busy server.

Maximum recipients per SMTP session

The maximum number of recipients allowed for a single SMTP transaction. This should not be much higher than the maximum number of senders one email should be sent to, in order to reduce spam traffic.

Load Reserve

Reject incoming SMTP session requests when the server reaches the specified load-average. Prevents the server from overloading due to heavy use.

Enable DKIM Outbound

Sign emails with DKIM signatures. The signatures will verify that the emails came from your server - allowing other servers to block emails that do otherwise. This can be helpful when your server is flagged as a spam source.

DKIM Signature

This is the signature that you need to append to your DNS entry. This makes your DKIM key available for verification, so that other servers will have a reference to check the DKIM-signed headers of the emails your server sends.

DKIM Domain

Set the domain to append the DKIM signatures for. This will activate DKIM for that domain only.

Queue Load

Send outgoing email to the mail-queue instead of delivering right away when the server reaches the specified load-average. Helps prevent performance issues due to heavy use.

Queue Delivery Load

Atmail will not process mail in the queue when the server reaches the specified load-average. Helps prevent performance issues due to heavy use.

Remote Parallel processes

Specifies the maximum number of simultaneous outbound messages to send.

Anti-Spam

Enable SpamAssassin

Enables the built-in SpamAssassin spam filter for Atmail. This build comes preset to learn spam according to users' behavior (Bayesian filtering) and includes a GUI for most key options. You can also create custom filters for SpamAssassin; see http://spamassassin.apache.org for detailed documentation.

Max Message Size

Specify the maximum email size to be scanned by SpamAssassin. Spam messages are usually small in size; we recommend setting this to 40kb to save resources unless you're having trouble with larger spam messages.

Spam Points

Specify the number of points needed to mark a message as spam. Recommended setting is 4, but you can change this if needed.

Reject Spam Points

Atmail can optionally reject high-scoring spam messages at the SMTP server, saving system resources and disk space. To enable this feature, specify a Spam Points value here.

Spam Tag

Specify the text to include in the headers/subject line of messages marked as spam.

Trusted Networks

Specify networks whose incoming mail should not be scanned with SpamAssassin. Messages originating from networks specified here will be automatically delivered without being scanned. You can include multiple IP addresses or netblocks separated by commas.

Skip Trusted Networks

Skip spam scanning for users who've authenticated via SMTP, or have IP addresses in the mail-relay table.

Enable Attachment Check

Blocks incoming messages with attachments matching the specified file extension. This helps prevent messages with executable viruses and other common malware from being delivered to a user's account.

Blocked Attachments

Specify the attachment file extensions to block when Enable Attachment Check is toggled on.

Enable URI/DNSBL Support

Enables URL checking against spamhaus.org; this will increase the Spam Point score of an email if a URL contained in it is found to be spam.

Enable SPF Support

Incoming messages are checked to make sure the recipient domains have an SPF record, and trusts the sender's IP address if so. This can be useful to help avoid spammers who use domain-spoofing.

Enable AWL Support

Auto-White-List scanned by SpamAssassin is recorded to MySQL along with the sender's email address. This helps train SpamAssassin's filtering both to increase accuracy and reduce false-positives when scanning for spam.

Enable Bayes

Bayesian filtering allows SpamAssassin to learn the patterns of spammers, and adapt its filtering over time to better combat unwanted email. High-scoring spam (or low-scoring if non-spam) emails are fed into the Bayesian learning system, and future emails with similar characteristics will be marked as spam or not spam based on the patterns learned.

Auto-Learn Non-Spam Score

Specify the Spam Point score an email must be below to be fed into the Bayesian learning system as a Non-Spam email.

Auto-Learn Spam Score

Specify the Spam Point score an email must be above to be fed into the Bayesian learning system as a Spam email.

Learning Threshold

By default, the Bayesian system learns 200 spam and non-spam messages before activating to ensure accuracy. You can specify a different value here if desired.

Enable DNSBL Support

Enables real-time DNS black-list support. Specify servers in DNSBL Servers field.

DNSBL Servers

Specify DNSBL servers here; separate multiple entries with commas.

 

Mobility

iOS Profiles

Enable Configuration Profiles

Allow iPhone/iPad clients to download a .mobileconfig profile.

Organization

Describes the issuing organization of the profile, as displayed to the user.

Display Name

A very short string to be displayed to the user describing the profile, such as "Mail Settings". It does not have to be unique.

Description

Descriptive, free-form text that will be shown to the user on the Detail screen for the entire profile. This string should clearly identify the profile so the user can decide whether to install it.

Server Hostname

Specify the mail-server hostname used in the profile URL references for users to connect via IMAP/SMTP/CalDAV/CardDAV. Leave blank for the server to try calculate automatically.

 

Mobile UI

Enable Mobile UI

Allow clients to be redirected to the mobile UI if detected.

Mobile UI Theme

Specify the theme used for the mobile UI interface.

 

DAV Services

CalDAV/CardDAV

Excluded Domains/Groups

There may be Domains or Groups that are excluded from some or all settings. Click the link to view the list.

Enable CalDAV server

Using the CalDAV protocol, people will be able to sync their desktop and mobile calendaring applications with their Atmail calendar.

Enable CardDAV server

Using the CardDAV protocol, people will be able to sync their desktop and mobile addressbook application with Atmail.

WebDAV base url

Specify an optional Base URL for DAV, to be used as a reference in the calendar and documentation for users to connect their desktop or mobile client.

Enable Calendar web interface

Enable Calendar interface. The calendaring interface gives people access to the calendar in the webmail application. The CalDAV service must be turned on for this to work.

Enable CardDav Client Service

Enable addressbook carddav client services. These user services provide access to user defined CardDav servers addressbook data.

 

WebDAV Files Storage

Excluded Domains/Groups

There may be Domains or Groups that are excluded from some or all settings. Click the link to view the list.

WebDav Service

Enable WebDav service so users can use 3rd party WebDav clients to access their Files Storage. Default domain setting. (Can be overridden with custom domain settings.)

Files Storage Tab

Enable user Files Storage. Default domain setting. (Can be overridden with custom domain settings).

Files Sharing

Allow users to share files in their Files Storage via a URL. Default domain setting. (Can be overridden with custom domain settings).

 

Email Management

Aliases

Filter by domain

Specify a domain or email to filter results.

Alias Type

Specify the alias type. Local aliases forward emails from one account to the other. Deliver locally and alias sends copies to both accounts. Domain aliases "catch" all emails for a domain and forwards copies of the emails to a single account.Alias to Maildir/File creates a copy of the emails and stores them in a single directory.

Local Email Address 

Specify a local or virtual email account

Forward To 

Specify the local or remote email address

Mail Relay

Filter by IP

Specify an IP or netblock to filter results.

IP Address or Net-block

Enter an IP address or Netblock in CIDR notation to allow SMTP relay of email messages.

Type

Choose if the relay is permanent, or expire after 60 minutes.

Mass Mail

Send to all

Use this option to send a message to all local users on the server.

Send to all SubAdmins

Use this option to send a message to all subadmins on the server.

 

System Services

Anti-virus

Enable Anti-virus

Enable Antivirus checks for incoming emails.

Enable Auto update

Toggle to automatically download the latest Anti-virus signatures each day.

Virus Error Message

Specify the message users will receive if their email contains a virus.

Anti-Virus Signatures

The date the Anti-Virus signatures were last updated.

 

ArchiveVault

Enable ArchiveVault

Enable the ArchiveVault service - Archive all incoming/outgoing messages to the Atmail ArchiveVault server. Store and archive all emails for legal and policy requirements.

ArchiveVault Hostname

Specify the hostname or IP address to route messages to the ArchiveVault server.

ArchiveVault Port

Specify the port of the ArchiveVault server ( default 2500 or 25 ).

ArchiveVault Status

Shows the status of the ArchiveVault service.

ArchiveVault URL

The primary URL for ArchiveVault. Make sure this is a hostname users can access outside of the localhost. e.g. http://server.com/archive

ArchiveVault API Key

Enter your ArchiveVault API key here. You can generate a new key from ArchiveVault Admin.

ArchiveVault API Status

Shows the status of the ArchiveVault Admin API service.

 

API Access

JSON API

Available by default JSON access to the Atmail API (Mail, Contacts, Calendaring) for 3rd party mashups and script usage.

Enable JSON-P API

JSON-P is a complement to the base JSON data format, allowing a page to request data from a server in a different domain. This is required when using a Javascript mashup which is outside of the domain used for Atmail to bypass browser restrictions. JSON-P is off by default for security.

WebMail

Excluded Domains/Groups

There may be Domains or Groups that are excluded from some or all settings. Click the link to view the list.

Webmail enabled

Sets if Webmail is enabled by default for customised domain groups and new user groups.

   

Settings

 

Global Settings

Installation Mode

Shows weather you have the server or webmail client only version installed.

Admin Email

Specify the administrator email that maintains the Atmail system.

Session timeout

Specify the timeout in minutes for a Webmail session to expire due to inactivity.

Default User License Type

Domains and users created on those Domains will be assigned to this license type unless they are assigned to a domain or group with a custom type set.

Exclusive Sessions

Enable clearing of current webmail session(s) when admin page is loaded. Disabling this setting is a security risk and may expose your system to cross site exploits.

SQL Hostname

Specify the hostname to the MySQL server. Seperate multiple servers with a comma. e.g. localhost,dbBackup1.lan

SQL Username

Specify the username to the MySQL server.

SQL Password

Optionally specify the password for the MySQL server. Leave blank if no password is defined.

Database Name

Specify the database used for Atmail. The table will be populated during the installer for the Atmail schema.

Authentication Type

Specify the authentication service used for POP3/IMAP/SMTP and Webmail logins. SQL recommended, if LDAP used, users must be managed via the LDAP server directly.

Authentication encryption

Specify the encryption type to use for internal user passwords in the database.

External user authentication encryption

Specify the encryption type to use for external user passwords in the database. (Encrypted passwords will require mcrypt dependency installed)

Encryption Master Key

The master key is used for external account password storage and user and admin session encryption. Once set, Atmail will encrypt all session data. Note: This key is VERY IMPORTANT and should have a SECURE BACKUP made. This field can only be set once.

Log Data Retention

How long Atmail will keep data in it's Log_* tables. This data is used to create the graphs on the Dashboard page. Note that keeping data for a long period of time may result in very large tables, which could consume considerable disk space and could impact performance.

Enable Debug

Enable debug logging to: webmail/log/debug.log, and webmail/log/imap.log

WebMail Settings

Sign-up page enabled

Sets if Webmail sign-up page is available and shows a link on the login page.

Show admin link

Sets if Webmail login page shows a link to the admin page.

Webmail Protocols

Specify which protocols can access the Webmail interface.

Enable Spell Check

Enable the Spell Check option for users. If this is enabled users will be able to submit their composed email for server side spell checks. The pspell php extension is required for this feature.

Enable Confirm On Send

Enable the Confirm On Send option for users. If this is enabled users will be able to choose whether or not they get a confirm message when sending an email.

Enable Mail Cache

Enable cache for Webmail data. User messages and IMAP requests are cached locally to improve performance.

Enable Dav Cache

Enable cache for Dav data. User dav requests are cached locally to improve performance.

Cache Type

Select the caching system that Atmail will use. The default "filesystem" cache does not require any dependencies. The "memcache" system has better performance but requires the memcache php extension.

Login Page Theme

Specify the login page used for the Webmail interface.

Theme Example

Shows a preview of the selected theme.

Allow External Domains

Turn on to allow any domain name to login via Webmail. Turn off to specifically define which domains can login. Any local domain automatically can access Webmail.

Specify Remote Domains

Specify a list of external domain-names that can access the Webmail interface. Separate each entry with a return. Useful to only allow users at a specified domain to use the Webmail interface.

Allow External Mailservers

Turn on to allow users to login to any specified mailserver. Turn off to specifically define the mailservers user can login via Webmail.

Specify Remote Servers

Specify a list of external IMAP servers that can access the Webmail interface. Separate each entry with a return. Useful to define a list of IMAP servers users are permitted to use. Optionally define a single mailserver to lock all users to one host.

Outgoing message method

SMTP Server: Select if messages are sent directly to an SMTP server without authentication.

SMTP Authentication: Select to send all messages via an SMTP server with authentication.

SMTP Hostname

Enter the SMTP server used for sending outgoing messages via Webmail. Default is 127.0.0.1 for the local server.

SMTP Auth Username

Specify the SMTP username for authentication.

SMTP Auth Password

Specify the SMTP password for authentication.

Groupware Settings

Groupware Zone

Set the Address book and Calendar sharing to Off, or System to allow sharing with users on all domains on the server, or Domain to only allow sharing to users on the same domain. (This setting has a global effect on the system.)

Shared Addressbook

Allows Address book sharing based on the Groupware Zone.

Branding

Brand Name

Specify the brand-name of the system. This will replace all references to Atmail in the Webmail interface and related services.

Webmail Logo

Click image to upload a logo which is displayed in the Webmail interface. Recommended PNG dimensions 89x31 with transparency enabled.

Login Logo

Click image to upload a logo which is displayed in the login interface. Recommended PNG dimensions 110x40 with transparency enabled.

Company URL

Specify the URL users are redirected when clicking the logo in the Webmail interface.

Footer Message

Optionally specify a footer used for all outgoing messages via Webmail for branding. Specify as HTML or plain-text.

Welcome email

Optionally specify the pathname to a HTML template which is emailed to new users during account creation.

Webmail URL

Specify the Webmail URL used in the welcome message for new users.

Mailserver Hostname

Specify the mail-server hostname used in the welcome email. References for users to connect via POP3/IMAP/SMTP.

User Defaults

User Quota

Specify the default User Quota in MB when creating a local user account.

Allow Theme Change

Enable user selected theme support.

Webmail Theme

Specify which theme to use for the Webmail interface.

Theme Example

Shows a preview of the selected theme.

Display Email Images

Toggle to automatically display external images in email messages.

Automatic Draft Save

Save drafts automatically while composing email messages.

Notifications

Enable automatic checking for new email in the currently selected folder. Optionally enable sound notification and/or animated favicon for new messages.

Delete Trash on Logout

Automatically delete all mail from the Trash folder upon logout.

Confirm on Send Email

Show confirm before sending email.

Default View

Select the mode to render the Webmail interface.

Enable message preview

Display an inline preview of each email message.

Date Display

Select the display format for date received.

Thread Support

Toggle to display email messages as threads by default.

Thread Limit

Determines how old emails can be before they are not included in threads.

Save sent emails to current folder

Enable to save sent emails to the current folder. This allows more complete thread building and tracking.

Interface Language

Select the default Language to render the Webmail interface.

Messages per page

Select the default number of email messages to display per page.

Timezone

Specify the default timezone for date calculation in the Web-interface.

  

Security

List Subadmins

Lists all subadmins on the system. From this list you can also individually delete, delete selected, or edit Subadmins, including the domains they have access to and their permissions: add, edit, delete users etc.

Add Subadmin

With this form you can add Subadmins, specifying admin permissions, and also available domains

Password Settings

Allows you to enable and disable password policy requirements within Atmail.

Change Password

This form is for changing password of currently logged in admin or Subadmin

  

License

Register License

Use this form to register a license or apply an upgraded license to installation.

Serial Details

Displays details of the currently installed license keys.

Update Software

Used when upgrading the Atmail software to the latest version available.

 

Have more questions? Submit a request

Comments


Contact our support team


+61 (7) 5357 6605       support@atmail.com