Configure Mailbox
  • 04 Mar 2024
  • 4 Minutes to read
  • PDF

Configure Mailbox

  • PDF

Article summary

Configuration

The configuration follows the protocol-based approach which provides the flexibility of configuring any kind of email provider such as ProtonMail, Microsoft, Zoho etc.
The application will use the chosen protocol and access the mailbox to retrieve the emails.

Let's see the available protocols and their functions!

1. IMAP

Internet Message Access Protocol (IMAP) is an Internet standard protocol used by email clients to retrieve email messages from a mail server over a TCP/IP connection. 

Refer to the below snapshot to understand IMAP configuration.

Figure: Configuration- IMAP Protocol

Field Description 
Server/IP Address *Enter the Server/IP Address. This is used by the application to reach the mailbox.
Port *The application auto-populates the port number based on the protocol selected. The port number can be changed manually.
Note
All protocols will have a unique port number.
Username *Enter the Username or Email ID required to connect with the mailbox.
Password *Enter a valid password.
Confirm Password *Confirm the entered password.
Security SSL/TLSEnable the Security SSL/TLS toggle switch.
This option is provided to add an additional layer of security.
Note
The application will either use SSL or TLS security based on the selected protocol. 

An asterisk(*) represents mandatory field.

2. POP3

Post Office Protocol is an application-layer Internet standard protocol used by e-mail clients to retrieve e-mail from a mail server. POP version 3 is the version commonly in use.

Refer to the below snapshot to understand POP3 configuration.

Figure: Configuration- POP3 protocol

Field Description
Server/IP Address *Enter the Server/IP Address. This is used by the application to reach the mailbox.
Port *The application auto-populates the port number based on the protocol selected. The port number can be changed manually.
Note
All protocols will have a unique port number.
Username *Enter the Username or Email ID required to connect with the mailbox.
Password *Enter a valid password.
Confirm Password *Confirm the entered password.
Security SSL/TLSEnable the Security SSL/TLS toggle switch.
This option is provided to add an additional layer of security.

Note
The application will either use SSL or TLS security based on the selected protocol.

An asterisk(*) represents mandatory field.

3. Exchange 

 Exchange is a service similar to IMAP, POP3, and ActiveSync that works to transfer and synchronize email/calendar information between the server and the end user's client.
This protocol can be selected when we need to configure any mailbox that is hosted on an exchange server.

Refer to the below snapshot to understand Exchange configuration.

a. When Enable Exchange for On-Premise is enabled:

Figure: Configuration- Exchange protocol when Exchange for On-Premise is enabled

b. When Enable Exchange for On-Premise is disabled:

Figure: Configuration- Exchange protocol when Exchange for On-Premise is disabled

Field Description 
Enable Exchange for On-premiseIf enabled, the Mailbox is configured to work with an on-premise Exchange server rather than a cloud-based solution. 
EWS URL *Enter the EWS URL.
Host Name *Enter the Host Name of the cloud Exchange server.
Username *Enter the Username or Email ID required to connect with the mailbox.
Password *Enter a valid password.
Confirm Password *Confirm the entered password.

An asterisk(*) represents mandatory field.

4. API

An API protocol defines the rules for API calls. It specifies accepted data types and commands.
API protocol can be selected to achieve mailbox configuration from the list of configured APIs displayed in the application.  

To understand API configuration, refer to the snapshot below.

Figure: Configuration- API Protocol 

If the required API is not available in the drop-down, a new API can be created to configure the mailbox by using Add API option.

By clicking Add API option, an API Configuration page is displayed where a new API can be configured and saved.

Note
The logged-in user must have access to Add API Configuration page to perform the above action.

Select the desired module from Module drop-down as shown below.

Figure: Add API Configuration page- Module drop-down

To understand API configuration, refer to the snapshot below.

Figure: Add API Configuration

If there is an API already configured, the configured API can be selected from the drop-down as shown below:

Figure: API Configuration

Change History and Versioning 

A Mailbox Configuration's Change History is often a log or record of any alterations, updates, or changes made to the mailbox throughout time. The term Versioning describes the process of keeping track of various changes or versions of the mailbox over time.

Figure: Versioning and Change History

Change History helps in maintaining transparency, compliance, and accuracy in managing multiple mailboxes across different teams. The change history feature provides a historical reference to each amendment and is a great audit trail. 

The below figure represents the changes made to each item along with the timestamp and user details. Change History gives a detailed overview of changes made to each record. 

Figure: Change History details

A detailed view of each of the records can be accessed by clicking the links. Refer to the image below. 

Figure: Mailbox Configuration Change History details

Versioning

Versioning helps to understand the number of revisions done to a record. For ex: The figure below depicts v6 which shows that there were 6 revisions done to record. 

Figure: Versioning details


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.