Jump to: navigation, search
MithiWiki Home > ConnectXf Home > ConnectXf Administration > Configuration > Web Mail Client


Baya Administration

Configuring Baya

How to: Baya

Troubleshooting: Baya

Related Topics:



Server Configurations

Session time out

Session time out is a value in minutes which controls the time for which an http session should be valid despite of not being used.

This value is important depending on your usage scenario. If your users are going to use the server from a public computer (cyber cafes, shared computers) then it would be better to set a small session time out interval.

In case your server is used locally over the LAN primarily, and the users are going to use the web mail client all the time, it would be more efficient to have a larger session time out period.

You can query and modify the session time out value by using the following commands:

/mithi/mcs/bin/getsessiontimeout.sh
/mithi/mcs/bin/setsessiontimeout.sh

Configuring the attachment viewer

  • Starting with Connect Xf 3.12, you can configure Baya to show attachments online.
  • Certain types of attachments such as .doc, .pdf, .jpg files will be shown online so that a user need not download the document to view its contents. To enable the viewing, documents are first converted to PDF and then given to a PDF viewer.
  • The server component responsible for converting docs to PDF is referred to as the JOD Convertor.
  • The behaviour of the JOD convertor is controlled by the values of the parameters given in the following file:
/mithi/mcs/modules/mithi-bl/conf/server/jodconverter.ini
  • The JOD convertor is enabled by setting the value of the JOD_DISABLED to 0.
  • To disable the online viewing set the value of JOD_DISABLED to 1.
  • You can also configure the number of OpenOffice processes required for conversion of files to PDF format. This is by setting a value for OO_PIPES_NUM. The allowed values 1 or 2. Giving a number higher than 2 can cause the server load to increase.
  • After making any change to the configuration file, the tomcat service has to be restarted.
/etc/init.d/tomcat restart

Getting the last login details in the user panel

  • From Connect Xf 3.18, the user panel shows the last login details for the users.
  • To get this information, it is required that the data collection of Baya login is enabled. For details on how to configure data collection, refer to the following topic:
Server configuration for data collection
  • If the data is collected is on a server from which Baya is not executed, then the Baya servers also need to be configured to get the data from the external database servers. To configure refer to the following topic:
Server configuration for report generation

Integration with Framebench service

  • This feature is available from Connect XF 3.20+
  • The server configurations related to the integration with the framebench service are maintained in the following file:
/mithi/mcs/modules/mithi-mailclient/conf/server/framebench.conf
  • The properties and their values are as mentioned below:
  1. Publically accessible URL of the Connect Xf server to load the file to the framebench server
PUBLIC_ACCESS_URL=http://<public ip or URL for this server>
  1. API URL to upload the file to the framebench
FRAMEBENCH_API_FILE_URL=https://next.framebench.com/api/file
  1. API URL to fetch the comments for the file
FRAMEBENCH_API_COMMENTS_URL=https://next.framebench.com/api/file/comments
  1. A secured API key to interact with the framebench server
PRODUCTION_API_KEY=<secret key shared with framebench, framebench generates the key for us>
  • The PUBLIC_ACCESS_URL is the public IP of the Connect XF server. The rest of the property values should be taken from Framebench.
  • On changing any values and saving the file, the tomcat service has to be restarted for the changes to come into effect.

CDN Setup

  • From Connect Xf 3.28+, Baya has been designed to let browsers cache the js, css and images. This improves the overall Baya performance.
  • However whenever the server is upgraded or the first time a user logins, the css, js and images have to be downloaded to the desktop/browser.
  • One of the reasons users may experience a slow response in this case is because the mail server is geographically "far away".
  • To solve this issue, Baya is now designed to allow the css, js and images to be downloaded from a CDN server.
  • The flow of traffic with CDN enabled for a domain is depicted in the diagram below:

Baya CDN.png

  • The setup ensures that data requested on POP/IMAP/SMTP/XMPP/CalDAV/LDAP protocols is directly served from the Connect Xf servers.
  • In case of HTTP, the requests for css, js and images is redirected to the CDN server configured, whereas the remaining data is served by the Connect XF server.

Reference: Admin guide for CDN Setup

Domain, user and Group Configurations

  • This section describes in detail the properties used to customize the web client for your domain.
  • The properties are classified into seperate stages depending on the function they control

Help

Home or Landing page

  • On domain creation, a default landing page is automatically configured for each domain from where users can log into the web client.
  • This page can be customized as per your needs.
  • For details on how to customize a login page for Connect Xf version 3.10 or below, refer to the topic below:

Login

Follow the link for Login configuration. The document provides you Domain, User and Group Properties which are common to SkyConnect and ConnectXf.


Following table gives you some additional properties which are applicable for ConnectXf only.

Additional User Properties

User Property COS Property Description
mailclientloginfirstlogincheck mailclientloginfirstlogincheck
  • When a user signs into the Baya account for the first time, he/she is required to fill up the Update your personal information and Update your password pages. This can be used to get the users to fill their information themselves effectively de-loading the administrator (and team).
  • Also, the Update password page is useful in scenarios where multiple users are created, by the administrator,with a general password. Here, the users are then expected to personalize their email account with a unique password at the first login itself (for security reasons).
  • This password change is also essential in case of a migration, where all the users are migrated to a new system, with a general password. Unless the user fills up the mandatory fields on these forms, he/she will not be allowed to use the system.
  • Also the status of the user, as a new user, does not change unless these three forms are filled.
mailclientlogincount -
  • System generated value. 1 specifies that the user has logged in using the web client more than once. 0 specifies that the user has never logged in using the web client.
onpasswordexpiry -
  • This is a password property shown here as it affects the web client login.
mailclientloginallowlocalauthentication mailclientloginallowlocalauthentication
  • Enable/disable local authentication.
  • Local authentication should be disabled when you have configured remote directory authentication for the user.
mailclientloginhost mailclientloginhost
  • Login host name
mailclientloginid -
  • Authenticate using this ID
webmaillocation webmaillocation
  • Name of the alternate server on which the user's login request has to be redirected. The value must be the server name as specified in servers.ini.

Additional Group Properties

Group Property Description
mailclientloginallowgrouplogin
  • Allow login to the web mail client Baya, using the group ids.
mailclientloginfirstlogincheck
  • Ask for registration on first time login.
mailclientlogincount
  • System generated value.
  • 1 specifies that the user has logged in using the web client more than once.
  • 0 specifies that the id has never been used to log in to the web client.
onpasswordexpiry
  • This is a password property shown here as it affects the web client login.
mailclientloginallowlocalauthentication
  • Enable/disable local authentication.
  • Local authentication should be disabled when you have configured remote directory authentication for the group id.
mailclientloginhost
  • Login host name
mailclientloginid
  • Authenticate using this ID


Folders

Follow the link to learn more about Folders configuration (User and Group configuration properties)which are common to SkyConnect and ConnectXf.

View Mail

Follow the link to learn more about View Mail Configuration (User and Group configuration properties)which are common to SkyConnect and ConnectXf.

Print

  • Starting from Connect Xf 3.14, you can customize the template used when printing an email.
  • By using the default template, the company logo is printed on the left hand side of the first page.
  • You can customize this template as per your needs. The process to do so is as follows:
  • The default template is available at
/mithi/mcs/modules/mithi-mailclient/user/pl/webapp/webroot/Templates/Print/PrintMailLogoTemplate.html
  • By default any domain on the server will use this template
  • To customize make a copy of this template in the domain folder
cp /mithi/mcs/modules/mithi-mailclient/user/pl/webapp/webroot//Templates/Print/PrintMailLogoTemplate.html to 
/mithi/mcs/modules/mithi-mailclient/user/pl/webapp/webroot//Templates/<domain name>/Print/PrintMailLogoTemplate.html  

where <domain name> is to be replaced by the domain name
  • Update the template as per your requirements
  • IMPORTANT: The directive src="<%= domainLogoImgSrc %>" tells the template to pick up the logo of the domain and should nt be changed in <img border="0" src="<%= domainLogoImgSrc %>" id="domainLogoIcon"> tag
  • IMPORTANT: If the server which has the SISA is different from the mailstore, then the same setting has to be done on both the servers.

Compose

Follow the link to learn more about Compose configuration (User and Group configuration properties)which are common to SkyConnect and ConnectXf.

Following table gives you some additional properties which are applicable for ConnectXf only.

Additional User Configuration Properties

User Property COS Property Description
mailclientcomposeshowbcc mailclientcomposeshowbcc
  • Show BCC on the compose page
mailsignatureinsertinforwardreply mailsignatureinsertinforwardreply
  • Insert signature in mail responses (forwarded and replied mail).

Address Book

Follow the link to learn more about Address Book Configuration (Domain, User, and Group Configuration Properties) which are common to SkyConnect and ConnectXf.


Following table gives you some additional properties which are applicable for ConnectXf only.

Additional User Properties

User Property COS Property Description
mailclientaddressbookshowcorporatedirlink mailclientaddressbookshowcorporatedirlink
  • Enable/disable the Corporate Directory (CD).
  • The Corporate Directory maintains a list of users in your domain. It also maintains a list of groups in the domain.
  • Using this command, you can enable or disable the users of Web Mail from viewing/using this.
  • Note
  • If the Corporate Directory is disabled for the domain then the auto-complete engine will not look-up the email address in the Corporate Directory.

Send

User Configuration

  • The user and COS properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Send stage.
User Property COS Property Description
mailclientcomposealiasloginsendasalias mailclientcomposealiasloginsendasalias
  • Users can login with the email ID or the alias ID.
  • When this option is selected and the user logs in using the alias ID, then any mail sent will have the alias ID as the sender ID.
mailclientsmtphost mailclientsmtphost
  • SMTP host name
mailclientcomposedirectorytolookforfromid mailclientcomposedirectorytolookforfromid
  • Search for the From id in this address book
mailclientcomposeoutgoingmailserver mailclientcomposeoutgoingmailserver
  • IP of the outgoing mail (SMTP) server.
  • Usually it is the SMTP server on the server itself.
mailclientcomposeoutgoingmailport mailclientcomposeoutgoingmailport
  • The port number on which the SMTP is running. Usually it is port 25.
Note: This property is deprecated from ConnectXf 3.6
mailclientcomposeredirectaftersend mailclientcomposeredirectaftersend
  • Redirect to this page after send.
mailclientsmtphost mailclientsmtphost *SMTP host name

Group Configuration

  • The group properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Send stage.
Group Property Description
mailclientcomposealiasloginsendasalias
  • Users can login with the email ID or the alias ID.
  • When this option is selected and the user logs in using the alias ID, then any mail sent will have the alias ID as the sender ID.
mailcientcomposesendfrom
  • Send using this domain
mailclientsmtphost
  • SMTP host name
mailclientcomposedirectorytolookforfromid
  • Search for the From id in this address book
mailclientcomposeoutgoingmailserver
  • IP of the outgoing mail (SMTP) server.
  • Usually it is the SMTP server on the server itself.
mailclientcomposeoutgoingmailport
  • The port number on which the SMTP is running. Usually it is port 25.
Note: This property is deprecated from ConnectXf 3.6
mailclientcomposeredirectaftersend
  • Redirect to this page after send.

Options

Follow the link to learn more about Configuring various Options for User and Group which are common to SkyConnect and ConnectXf.


Following table gives you some additional properties which are applicable for ConnectXf only.

User Configuration

  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Options stage.
User Property COS Property Description
mailclientlooksshowspammanagementpage mailclientlooksshowspammanagementpage
  • Allow user to manage their whitelists, balcklists etc.
mailclientloginallowspammailfilteringconfigurations mailclientloginallowspammailfilteringconfigurations
  • Allow user to enable/disable spam mail filtering.
mailclientautoresponsesupport mailclientautoresponsesupport
  • Allow the users to set an automatic reply to incoming messages. This can be used when the users are traveling or going to be out of office for a while.
  • The text in the vacation reply message cannot exceed 2048 characters.
mailclientroamingsupport mailclientroamingsupport
  • Allow the users to change their roaming status to enable them to view their Internet mail on the ISP server from anywhere.
  • Valid only for INTRANET/GATEWAY setups of Mithi Connect Server.
mailclientpopcollectionsupport mailclientpopcollectionsupport
  • Allow/disallow the user to fetch mail from POP accounts.
  • Typically each user has multiple email accounts e.g. user@yahoo.com, along with an account in this domain.
  • Connect XF is capable of receiving mail from multiple POP accounts for each user. This is useful to give the users a 'Universal Inbox'.
mailclientpasswordsupport mailclientpasswordsupport
  • Allow user to change password.
mailclientpasswordsecretquestionsupport mailclientpasswordsecretquestionsupport
  • Enable/disable secret question support for password.
mailclientloginsendmailtouseronpwdupdation mailclientloginsendmailtouseronpwdupdation
  • Send mail to user when the password is updated using the web client.
mailclientloginsendmailtowebmasteronpwdupdation mailclientloginsendmailtowebmasteronpwdupdation
  • Send mail to webmaster when the password is updated using the web client.
mailclientcomposeshowpopupwindow

Group Configuration

  • The group properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Options stage.
Group Property Description
mailclientloginallowspammailfilteringconfigurations
  • Allow user to enable/disable spam mail filtering

Looks

Follow the link to learnCustomizing Looks of Mail Client. The document provides you properties which are common to SkyConnect and ConnectXf.


Following table gives you some additional properties which are applicable for ConnectXf only.

Domain Configuration

Domain Property Description
mailclientlogincopyrightyear
  • Copy right year
mailclientlogintoslink
  • Link to the terms of service page on the server
virtualhostbasenode
  • Link to define the virtual host settings for the domain
  • Virtual host settings are require to access the web mail client using a URL or an IP
  • Click here to know more on setting the virtual hosts.
qmaildomainentry
  • Add this domain name in Qmail Locals and RCPTHost files
mailclientlogindomaingif
  • Name of the file containing the domain logo in the required folder.
  • The steps to upload logo are as follows:
  • Make a folder of "domain name" in following location.
/mithi/mcs/modules/mithi-mailclient/user/pl/webapp/webroot/Templates/
  • In the folder, copy the gif file having the logo.
  • Make a copy of the default logo if present (if the logo is not proper, then the web mail client may not work, in which case you have to copy the old logo back)
  • Rename the newly copied logo file to domainlogo.gif
  • Change this property to domainlogo.gif

Knowledge Discovery/Advanced Search

Domain Configuration

  • The domain properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Advanced Search stage.
Domain Property Description
enableadvancesearch
  • Enable/disable the Knowledge discovery feature for the entire domain.

User Configuration

  • The user and COS properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Advanced Search stage.
User Property COS Property Description
enableadvancedsearch enableadvancedsearch
  • Enable/disable the advance search or knowledge discovery feature for the user.
bimaxsearchresultslimit -
  • Max search results to be displayed in intelligent search
bimaxsearchresultslimitforassociations -
  • Max search results to be used to compute associations in intelligent search

Spam Management

Domain Configuration

  • The domain properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Spam Management stage.
Domain Property Description
enableantispampage
  • Enable/disable the Spam Management feature for the entire domain.
  • If this option is selected, then the Spam Management link is shown in the Options page of Baya (the web client).
showspambuttoninfolders
  • Show/hide the 'Spam' button on folder page of Baya (the web client).
shownotspambuttoninfolders
  • Show/hide the 'Not Spam' button from the folder pages of Baya (the web client).
allowspammailfilteringconfigurations
  • Enable/disable the Spam Filter management interface in Baya (the web client).

Security

Domain Configuration

  • The domain properties can be set using the Command Line Interface and the Application Manager.
  • In the Application Manager, the properties can be set from the Application View->Mail->Mail client->Security stage.
Domain Property Description
enablehtmlsanitization
  • This option is available from Connect Xf 3.8
  • Enable/disable the HTML mail sanitization feature for the entire domain.
  • If this option is selected, then the mail is sanitized before rendering in Baya.
  • The sanitization process removes XSS code which might redirect the users to rouge sites and thus prevents cross scripting attacks
  • Default value is disable.
  • Note: This feature should be used with discretion, as the sanitization may remove valid XSS code required for the proper rendering of the mail. It is advised instead to use Intrusion detection systems, firewalls and use browsers such as Chrome/Safari.

Troubleshooting

For troubleshooting topics refer Troubleshooting Baya

Browser Support

For release 3.10+, following browser versions are supported

  • Firefox - 4.0+
  • Google crome - 11.0+
  • IE - 7,8,9
  • Opera - 9.0+
  • Safari - 5.0+

For Video Calling application integrated in Baya from version 3.14+, following browser versions are supported

  • Chrome v23.0+
  • Firefox v22.0+