Add managesieve plugin documentation

pull/6833/head
Aleksander Machniak 8 years ago
parent ac592fd169
commit 194690f59b

@ -0,0 +1,55 @@
.. index:: Filters
.. _settings-managesieve-filters:
*******
Filters
*******
Incoming mail is automatically processed by the server and handled/organized
according to defined criteria. For example you can tell the server to move the message to
specified folder, redirect it to another account, send a reply, discard, delete, etc.
Filtering is based on `Sieve <https://www.rfc-editor.org/info/rfc5228>`_ language, which means that under the hood
all filters are stored as a Sieve script on the server. This interface allows you to
define rules in easy way without the need to know the language.
Each filter definition has a name and set of rules and actions. Usually
the number of definitions is unlimited and they can be grouped into sets
(scripts) for convenience.
Filter sets
-----------
Filter definitions can be grouped into sets. These can be activated or disactivated.
Depending on server configuration there can be none, one or more active sets
at the same time. They need to have a unique name.
New sets can be created as empty or as a copy of an existing set. It is also possible
to import them from a text file containing Sieve script. Sets in form of a script
can be also downloaded e.g. for backup or migration purposes.
Filter definition
-----------------
Every filter can be active or inactive, which is convenient if you want to
disable some actions temporarily.
Because filters are executed in specified order (from top to bottom as you see them on the list)
you can use drag-and-drop technique to rearange filters on the list.
Every filter definition contains at least one rule and one action. Depending on server
capabilities a rule can be based e.g. on message headers, body, date or size.
A set of actions also depends on server capabilities. Most servers support:
* moving/copying messages to specified folder
* redirecting/copying messages to another account
* discarding messages with specified error message
* replying (vacation)
* deleting (ignoring) messages
* setting flags (e.g. marking as Read)
Note: Some actions stop filtering process, some do not. Use *Stop evaluating rules*
and *Keep message in Inbox* actions to have more control on this.

@ -0,0 +1,58 @@
.. index:: Vacation
.. _settings-managesieve-vacation:
********
Vacation
********
The vacation autoresponder's purpose is to provide correspondents with
notification that the user is away for an extended period of time and that
they should not expect quick responses.
**Vacation** is used to respond to an incoming message with another message.
This interface is part of :ref:`settings-managesieve-filters` functionality
and provides a simple way to manage vacation responses.
Vacation message
----------------
To enable the autoresponder you have to set at least the response body and change
the status to *On*.
**Subject**
Response subject is optional. By default the reply subject will be set
to *Auto: <original subject>*
**Body**
Response body. Here you put the reason of your absence or any other text
that will be send to sender.
**Vacation start/end**
These fields define when the vacation rule is active and are optional.
**Status**
This field activates the rule. If you always use the same response body it is
convenient to disable the vacation rule when it's not needed and enable again
another time.
Advanced settings
-----------------
**Reply sender address**
This is an email address that will be used as sender of the vacation reply.
**My email addresses**
Normally the vacation response is send if recipient address of the incoming
message is one of your addresses known to the server. Here you can add
more addresses.
**Reply interval**
This parameter defines how often the reply to the same sender is generated.
When you receive a lot of messages from the same sender in short time,
usually you don't want to reply to all of them. By default reply is send once a day.
**Incoming message action**
This field defines an action taken on the incoming message. You can discard or keep
it or redirect/copy to another account (so it can be handled by another person).

@ -0,0 +1,113 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2015, roundcube.net
# This file is distributed under the same license as the Roundcube Webmail Help package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Roundcube Webmail Help 1.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-06-07 16:59\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../en_US/_plugins/managesieve/settings-filters.rst:9
# cdb4a7c71e5343edb8015510da83a0b8
msgid "Filters"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:11
# 94cde05fc3f049e8911dffacfb9af0e5
msgid "Incoming mail is automatically processed by the server and handled/organized according to defined criteria. For example you can tell the server to move the message to specified folder, redirect it to another account, send a reply, discard, delete, etc."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:15
# c33e9a7b05f24fe59464ff2f1c9e10a5
msgid "Filtering is based on `Sieve <https://www.rfc-editor.org/info/rfc5228>`_ language, which means that under the hood all filters are stored as a Sieve script on the server. This interface allows you to define rules in easy way without the need to know the language."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:19
# 95eb7e571ec44698a474407092b6b79c
msgid "Each filter definition has a name and set of rules and actions. Usually the number of definitions is unlimited and they can be grouped into sets (scripts) for convenience."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:25
# aa2da905741247b9971687cd4fdb6a21
msgid "Filter sets"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:27
# dc9dbc4144034676a720caaf4379e4e3
msgid "Filter definitions can be grouped into sets. These can be activated or disactivated. Depending on server configuration there can be none, one or more active sets at the same time. They need to have a unique name."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:31
# 03f58cdba04c4282b867c792572a55e6
msgid "New sets can be created as empty or as a copy of an existing set. It is also possible to import them from a text file containing Sieve script. Sets in form of a script can be also downloaded e.g. for backup or migration purposes."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:37
# 9144e63ba44b476dadfcc84e33e72b86
msgid "Filter definition"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:39
# 602e3696b4bd4db5960351b5af0e72fd
msgid "Every filter can be active or inactive, which is convenient if you want to disable some actions temporarily."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:42
# 0f01b114450f4439b210f3831d66c534
msgid "Because filters are executed in specified order (from top to bottom as you see them on the list) you can use drag-and-drop technique to rearange filters on the list."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:45
# 0a30f2aa835e430c9f9de2e446f4c311
msgid "Every filter definition contains at least one rule and one action. Depending on server capabilities a rule can be based e.g. on message headers, body, date or size."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:48
# d3b9c2df232c4cd891ec6ba4751e02cf
msgid "A set of actions also depends on server capabilities. Most servers support:"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:50
# 1ee77f36a88746e0809e903838314e5a
msgid "moving/copying messages to specified folder"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:51
# c2669d203d104753830a170af2ceffde
msgid "redirecting/copying messages to another account"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:52
# b04abf50eb1948518caff0c9f6d32ad4
msgid "discarding messages with specified error message"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:53
# 439873796de6457985088a206b449c5b
msgid "replying (vacation)"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:54
# 5b7bce17840647bdba48ffa944b30ec5
msgid "deleting (ignoring) messages"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:55
# a12f2f2bebe74c668b637be66352ddb7
msgid "setting flags (e.g. marking as Read)"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-filters.rst:57
# a19231cf44e64eeca67da4cd31b0303a
msgid "Note: Some actions stop filtering process, some do not. Use *Stop evaluating rules* and *Keep message in Inbox* actions to have more control on this."
msgstr ""

@ -0,0 +1,93 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2015, roundcube.net
# This file is distributed under the same license as the Roundcube Webmail Help package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Roundcube Webmail Help 1.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-06-07 16:59\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:9
# 6f1988e3ca10490f8b46fdf11ce3553a
msgid "Vacation"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:11
# 628c07bf4b424a039800ef834f891841
msgid "The vacation autoresponder's purpose is to provide correspondents with notification that the user is away for an extended period of time and that they should not expect quick responses."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:15
# 57607d8b841b42859d3bb4e6abc4d653
msgid "**Vacation** is used to respond to an incoming message with another message."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:17
# 34f46a208d324588906b0d3d10a6176c
msgid "This interface is part of :ref:`settings-managesieve-filters` functionality and provides a simple way to manage vacation responses."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:22
# 895cd4752ec649bc87850eb4bd149853
msgid "Vacation message"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:24
# 5de6ddf9931a481e9d1c9953183b28d8
msgid "To enable the autoresponder you have to set at least the response body and change the status to *On*."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:28
# c4790be6b0454aa190190c1e77087414
msgid "Response subject is optional. By default the reply subject will be set to *Auto: <original subject>*"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:32
# 65eb9d5c2f8d4a8cb3077c824ecf597f
msgid "Response body. Here you put the reason of your absence or any other text that will be send to sender."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:36
# 2b05975ad2ee40e9b64356eb39308a92
msgid "These fields define when the vacation rule is active and are optional."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:39
# 575bd1430cdf4ea4bbcfb9d8556393bc
msgid "This field activates the rule. If you always use the same response body it is convenient to disable the vacation rule when it's not needed and enable again another time."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:44
# 22d533b9cffd47d39c04cbca07d9513d
msgid "Advanced settings"
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:47
# d56d3eac661f41799e4538be4d2806cd
msgid "This is an email address that will be used as sender of the vacation reply."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:50
# f2c3d5d2e05c4147bdca65d3b12acdf4
msgid "Normally the vacation response is send if recipient address of the incoming message is one of your addresses known to the server. Here you can add more addresses."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:55
# 9b1ee71a799d43ebb8cef4a2555a7b83
msgid "This parameter defines how often the reply to the same sender is generated. When you receive a lot of messages from the same sender in short time, usually you don't want to reply to all of them. By default reply is send once a day."
msgstr ""
#: ../../en_US/_plugins/managesieve/settings-vacation.rst:60
# 8ce4de76e26543f1be25dedb372ce296
msgid "This field defines an action taken on the incoming message. You can discard or keep it or redirect/copy to another account (so it can be handled by another person)."
msgstr ""
Loading…
Cancel
Save