ROUNDCUBE PLUS WEATHER PLUGIN
=============================
This plugin displays weather information on the mail page sidebar.

REQUIREMENTS
------------
- Roundcube: 1.5, 1.6
- PHP: 7.4 or higher
- PHP cURL extension
- Config: OpenWeatherMap key

INSTALLATION
------------
1. Copy the directories xweather and xframework included in this package to the 'plugins' directory of your Roundcube
   installation.

2. Rename the file <roundcube>/plugins/xweather/config.inc.php.dist to config.inc.php.

3. Edit the file <roundcube>/plugins/xweather/config.inc.php, provide the API key and configure the plugin according to
   your needs. For more information about obtaining the API key, see the section below.

4. Edit the file <roundcube>/config/config.inc.php, add xweather to the plugins array and specify your license key.

For more information on installing Roundcube Plus plugins see:
https://roundcubeplus.com/helpdesk/knowledgebase.php?article=29

PHP CONFIGURATION
-----------------
This plugin uses cURL to retrieve the weather data from openweathermap.org. For this function to work properly
the cURL PHP extension must be installed.

COMPATIBILITY / LIMITATIONS
---------------------------
1. This plugin has been created for the standard version of Roundcube as provided on the Roundcube website:
   https://roundcube.net. It might not work properly with customized versions of Roundcube including the version
   provided as part of the Kolab system. Please note that we cannot provide any technical support for the plugin
   deployed on a non-standard version of Roundcube.

2. The service used for obtaining the weather information (openweathermap.org) provides SSL API connections only for the
   professional and enterprise accounts. If you use the free or startup account and your Roundcube runs on an SSL
   connection, this plugin will not work.

API KEY
-------
In order to use this plugin, you must provide the API key for the OpenWeatherMap service. In order to get the key
you need to create an account at http://openweathermap.org. At the writing of this document OpenWeatherMap service
provides free access to 60 API calls per minute and 50,000 calls per day. If you need to make more calls, you'll need
to purchase one of the paid plans.

DATA CACHE
----------
In order to minimize the amount of API calls, the plugin uses a per-user caching system. In the config file you can
specify for how long the retrieved weather data will be stored in a cookie on the user's browser.

LICENSE
-------
This plugin is distributed under a commercial license. In order to use the plugin, you must purchase the license
from Tecorama LLC. See the LICENSE file for details.

COPYRIGHT
---------
Copyright (c) 2025, Tecorama LLC
