summaryrefslogtreecommitdiff
path: root/plugins/zipdownload/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/zipdownload/README')
-rw-r--r--plugins/zipdownload/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/plugins/zipdownload/README b/plugins/zipdownload/README
new file mode 100644
index 000000000..4fa3c17b6
--- /dev/null
+++ b/plugins/zipdownload/README
@@ -0,0 +1,35 @@
+Roundcube Webmail ZipDownload
+=============================
+This plugin adds an option to download all attachments to a message in one zip
+file, when a message has multiple attachments. The plugin also allows the
+download of a selection of messages in 1 zip file and the download of entire
+folders.
+
+Requirements
+============
+* php_zip extension (including ZipArchive class)
+ Either install it via PECL or for PHP >= 5.2 compile with --enable-zip option
+
+License
+=======
+This plugin is released under the GNU General Public License Version 3
+or later (http://www.gnu.org/licenses/gpl.html).
+
+Even if skins might contain some programming work, they are not considered
+as a linked part of the plugin and therefore skins DO NOT fall under the
+provisions of the GPL license. See the README file located in the core skins
+folder for details on the skin license.
+
+Install
+=======
+* Place this plugin folder into plugins directory of Roundcube
+* Add zipdownload to $rcmail_config['plugins'] in your Roundcube config
+
+NB: When downloading the plugin from GitHub you will need to create a
+directory called zipdownload and place the files in there, ignoring the
+root directory in the downloaded archive
+
+Config
+======
+The default config file is plugins/zipdownload/config.inc.php.dist
+Rename this to plugins/zipdownload/config.inc.php \ No newline at end of file