|The following covers the features that administrators would wish to set up.|
|Generating Stat Logs|
If you are using WebMail v3.0d on a linux machine you can setup WebMail to email you General stat information about your WebMail system.
The program 'webcmdlog' which is generating the stats report can only be obtained by contacting: 'firstname.lastname@example.org' and asking for the 'WebMail cmd.log to Stats program'. You will need to state the O/S that you are using.
An example is show below:
To set this up you need to first add a webmail.ini setting:
Then create 2 .sh files. I suggest that you place these in a separate directory off webmail called 'cmdlog'
You should change the directories as needed for your system, and the 'email@example.com' email address. The next step is setting up 2 cron jobs so that the start and stop scripts are called at the correct times. An example of this is:
You should only run the stats over 1 day, as this does impact on the system performance when turned on.
Not only does the program provide information as above, but you can also get it to give you a breakdown of a command. To do this you run the file like this:
It will generate a report like this:
You can also give a break down of the commands that take longer than 10 seconds, like this:
It will generate a report like this:
WebMail can support server farming, where you set up a copy of the CGI on each machine.
On one machine you set up a workarea where all the user profiles are stored.
Then, on each of the other machines, you set up a (map/link) to this location. This way each machine can be set up to point to the one workarea location. On each machine, set the workarea ini setting to match the map/link you have setup.
With the templates you have a choice. You can either do the same as above where there is only 1 copy of the templates and each CGI points to it, or you can have a separate copy of the template set on each machine, thus saving networking bandwidth.
NOTE: If you are running the CGI on multiple machines you will need to purchase a license for each machine. Talk to firstname.lastname@example.org about discounts for multiple purchases.
WebMail versions 2.0f and higher have the ability to auto-login to any other NetWin products which include the auto-login feature. This saves time for the user because he/she can go from one product to another without having to login each time. The password is encrypted and stored temporarily on SurgeMail, making the process relatively safe.
In order to create links in WebMail which auto-login to another NetWin product, the following ini setting needs to be set up:
The <id> is the id number that you wish to be set up as. ie 10
The <url> is the relative or full url to the other product. The product directory is the workarea directory of the product. WebMail also allows multiple auto-logins, so you can set up multiple ini settings like the following:
The CGI must have write access to the 'product directory' because an encrypted password file is created which the other product uses for the login.
Once the ini setting is set up, the next step is to add a link somewhere in WebMail (on any template that logs the user into the other product). The links are as follows if the above 'netwin_autologin' ini settings are used (note: the order of the ini settings above must correspond to the numbers used in these urls):
NOTE: This will only work if the username and password are the same for both products.
Below are the common autologin setups in WebMail and how to set them up. Any ini setting changes stated will also have next to them the ini file name brackets like '(4th Setting)' What this means is that this is the autologin setting position it is expected to be in. For example the '4th setting' means that there is expected to already be 3 other autologin ini settings in the ini file before these settings. The above only matter for (netwin_autologin and not netwin_autologin_id)
If the order of the autologins do change, then WebMail logins will not login to the expected product. If you wish to change the order OR the order has to be different due to already setup settings then you will need to also change the templates commands to also match this.
Note: The versions stated below in each, are the version you need to get ALL of the feature stated. Older versions of WebMail will have some of the below, but some features will not be avalible without extra template changes.
WebMail <--> External Program or Single Sign On, SSO
|Auto-Login (Without SurgeMail)|
WebMail versions 3.0u and higher have the ability to auto-login to any other NetWin products which include the auto-login feature. This saves time for the user because he/she can go from one product to another without having to login each time. The password is encrypted and saved in a temporary file on the machine (not accessible from the net), making the process relatively safe.
Since that you are not using our mail server (SurgeMail) you have to use the old method which has a limiting factor.
"The WebNews and WebMail products MUST be able to get access to each other workarea's."
The reason for this is that the password is encoded and stored in a file which the other product then grabs and uses.
This means that the programs need to be on the same machine or that you have to setup network drives so that each can store files in the correct location. In this case you have to be careful of ownership of files that each will create as both will need to read/write and delete the files.
|WebMail Command Prompt Options|
WebMail has a few built in commands that you can run via command prompt. The list of the availabel commands in your current version of WebMail can be view by running WebMail like this:
This will then list all the available command like this:
Welcome to WebMail v3.1m Layout: webmail -version webmail -activate registration_number email_address webmail -deactivate registration_number email_address webmail -password <password> webmail -lang_tpl -version | Displays version Information -activate | This will activate a webmail key -deactivate | This will deactivate a webmail key -password | This will set the managers password. ini setting si ignored -lang_tpl | This will get webmail to rebuild the language tpl from | the mastersets. Layout: webmail -admin_fns webmail -admin_fns_full webmail -manager webmail -deleteuser <password> wild_user [wild_user [..]] webmail -checkutoken <user token> webmail -check <user@domain> webmail -show_path <user@domain> -admin_fns | This will force the CGI to check for | 'auto_delete wild xdays [ydays]' | and clear only logged in users (login.dat). -admin_fns_full | This will force the CGI to check for | 'auto_delete wild xdays [ydays]' | and clear ALL the users caches. -manager | Command line managers control -stats | This will geneate the manager login reports -deleteuser | Command line delete user lists -checkutoken | Check that the user token is currently valid -check | This checks if a user account is active (login session) -show_path | This will return back the full path to the user Layout: webmail -stats webmail -space webmail -clean) webmail -space_pop webmail -clean_pop webmail -enable_cmdlog webmail -disable_cmdlog These are more advance setting and should use with extreme care. Layout: webmail -remove_lock <username>@<domain> webmail -test_lock <username>@<domain> [<sleep in seconds>] -remove_lock | This attempts to remove the lock files for a user. -test_lock | This will test the locking routines for a user.
The '-stats' command is covered in the section 'Setup Webmail to generate more stat information' and will tell you how to setup and use this feature. Most of the others are self explanatory in their comments. I am going to talk about the '-manager' option.
The '-admin_fns' command cycle thoughs the login users (login.dat) and check to see if they should be logout and clears their cache at the same time. We suggest that you should set this up as a cron job to be run once every hour, and also including the webmail.ini setting:
This will stop the CGI from processing this command which for large systems can cause large delays once in a while.
The '-manager' is the command prompt manager screen with similar features to that of the web base manager. But were the web base can timeout for large system the command prompt does not have this issue. Once you run the manager option you will be asked for the managers password that you must have setup in the webmail.ini file before hand. Then CGI will then load all the user information in removing and empty users and display a menu like the following:
Welcome To Managers Page ------------------------ Stats: Located xxx Users based in d:\webimap\ 1. Display selected users to screen 2. Delete selected user 3. Change User.dat Variable for selected users. d. Delete all old Accounts. (ini setting - auto_delete) c. Clear All Users Caches. (ini setting - auto_logout) f. Delete Users from File. s. Switch user directories from one pop host to another. i. Users Information. (Displays how long since they lasted logged in) u. Delete Users Un-used for x days. r. All the email in user Y's mailbox older than X days are removed. (POP only) e. All the emails in user Y's folder X are removed. (POP only) v. Verify all user.dat files - user.dat repairs. x. Update users quotas (POP folders only). m. Move POP folder to IMAP server. q. exit
The number of users on your system will be shown and the list of available options. Each of these options are explained below:
|Using Gnu Privacy Guard (GnuPG)|
If you are using WebMail v3.0u or higher you can set it up to use GnuPG. For more information about this product see the URL:
The software for safe and encrypted e-mail-communication. GnuPG is published under General Public License (GPL) and there is a free software alternative to Pretty Good Privacy (TM), shortly known as PGP (TM). GnuPG is based on OpenPGP-standard.
To setup WebMail with GnuPG you first need to download GnuPG, compile and install in on your system. Due to the way GnuPG interfaces with the console, changes are needed to GnuPG to made so that webmail can correctly run gpg correctly. So before you build GnuPG you will need to replace '../util/ttyio.c' with the one provided here.
Windows and Linux Libc6 compiled version can be downloaded from the table below.
This is just the gpg.exe you will still need to download the orginal GnuPG and install it.
Once install you need to add to webmail.ini file the following:
This will then activate webmail pgp code and on the Panel tpl set on the 'Option' page. This new option called:
This will give you the option to generate a new Public/Private key, which is then used when sending emails. This will also list teh current Key that other users have sent you. On the 'New Message' page at teh top a new pull down menu will apear giving you the option to send your key or sign the message using yor key.
Warning: Since GnuPG is 3rd party software, Netwin Ltd is not liable for any damage caused by the use of this software, or any licensing requirements.
|Generate more Stat Information|
WebMail v3.0t and higher has more stat information that you can collect and use. The main information that customers want are:
To set up the above you need to add the following ini settings:
The stat information is display on the managers page at the URL like the following:
All this information is stored in WebMail's workarea, each in a seperate file. You might need to manually remove old files if they start taking up to much room.