← Back to branch summary

~ubuntu-branches/ubuntu/trusty/dovecot/trusty-proposed

« back to all changes in this revision

Viewing changes to pigeonhole/doc/extensions/vacation.txt

  • Committer: Package Import Robot
  • Author(s): James Page, James Page, Ante Karamatic
  • Date: 2013-02-11 12:41:24 UTC
  • mfrom: (4.1.33 sid)
  • Revision ID: package-import@ubuntu.com-20130211124124-v7bdegzftlhw7yfr
Tags: 1:2.1.7-7ubuntu1
https://launchpad.net/bugs/1117613
https://launchpad.net/bugs/1075456
https://launchpad.net/bugs/671065
[ James Page ]
* Merge from Debian unstable (LP: #1117613, #1075456), remaining changes:
  + Add mail-stack-delivery package:
    - Update d/rules
    - d/control: convert existing dovecot-postfix package to a dummy
      package and add new mail-stack-delivery package.
    - Update maintainer scripts.
    - Rename d/dovecot-postfix.* to debian/mail-stack-delivery.*
    - d/mail-stack-delivery.preinst: Move previously installed backups and
      config files to a new package namespace.
    - d/mail-stack-delivery.prerm: Added to handle downgrades.
  + Use Snakeoil SSL certificates by default:
    - d/control: Depend on ssl-cert.
    - d/dovecot-core.postinst: Relax grep for SSL_* a bit.
  + Add autopkgtest to debian/tests/*.
  + Add ufw integration:
    - d/dovecot-core.ufw.profile: new ufw profile.
    - d/rules: install profile in dovecot-core.
    - d/control: dovecot-core - suggest ufw.
  + d/dovecot-core.dirs: Added usr/share/doc/dovecot-core
  + Add apport hook:
    - d/rules, d/source_dovecot.py
  + Add upstart job:
    - d/rules, d/dovecot-core.dovecot.upstart, d/control,
      d/dovecot-core.dirs, dovecot-imapd.{postrm, postinst, prerm},
      d/dovecot-pop3d.{postinst, postrm, prerm}.
      d/mail-stack-deliver.postinst: Convert init script to upstart.
  + d/control: Added Pre-Depends: dpkg (>= 1.15.6) to dovecot-dbg to support
    xz compression in Ubuntu.
  + d/control: Demote dovecot-common Recommends: to Suggests: to prevent
    install of extra packages on upgrade.
  + d/patches/dovecot-drac.patch: Updated with version for dovecot >= 2.0.0.
* Dropped changes, included in Debian:
  + d/{control,rules}: enable PIE hardening.
  + d/control: Drop B-D on systemd.
* d/p/mail-stack-delivery.postinst: Updated to ensure that configured SSL
  cert and key locations are used when configuring postfix, sorted out
  formatting.
* d/p/dovecot-core.postinst: Create compat links to old style, existing
  SSL cert and key if found.
* d/rules: Don't pass hardening flags for DRAC plugin.
* d/dovecot-{pop3d,imapd}.prerm: Re-sync with Debian.
* d/dovecot-core.lintian-overrides: Drop override for DRAC plugin as not
  required in Ubuntu.
* d/01-mail-stack-delivery: Renamed 99-mail-stack-delivery to ensure that
  the mail-stack-delivery configuration overrides configuration options
  set elsewhere, updated with new cert/key file locations.

[ Ante Karamatic ]
* Change configuration file for LDA on new installs and upgrades
  (LP: #671065).

Show diffs side-by-side

added added

removed removed

Lines of Context:
pigeonhole/doc/extensions/vacation.txt
 
1
Vacation Extension
 
2
 
 
3
Relevant specifications
 
4
=======================
 
5
 
 
6
  RFC5230 - doc/rfc/vacation.rfc5230.txt
 
7
  RFC6131 - doc/rfc/vacation-seconds.rfc6131.txt
 
8
 
 
9
Description
 
10
===========
 
11
 
 
12
The Sieve vacation extension [RFC5230] defines a mechanism to generate automatic
 
13
replies to incoming email messages. It takes various precautions to make sure
 
14
replies are only sent when appropriate. Script authors specify how often replies
 
15
are sent to a particular contact. In the original vacation extension, this
 
16
interval is specified in days with a minimum of one day. When more granularity
 
17
is necessary and particularly when replies must be sent more frequently than one
 
18
day, the vacation-seconds extension [RFC6131] can be used. This allows
 
19
specifying the minimum reply interval in seconds with a minimum of zero (reply
 
20
is then always sent), depending on administrator configuration.
 
21
 
 
22
Configuration
 
23
=============
 
24
 
 
25
The vacation extension is available by default. In contrast, the
 
26
vacation-seconds extension - which implies the vacation extension when used - is 
 
27
not available by default and needs to be enabled explicitly by adding it to the
 
28
sieve_extensions setting. The configuration also needs to be adjusted
 
29
accordingly to allow a non-reply period of less than a day.  
 
30
 
 
31
The vacation and vacation-seconds extensions have their own specific settings.
 
32
The settings that specify a period are specified in s(econds), unless followed
 
33
by a d(ay), h(our) or m(inute) specifier character. 
 
34
 
 
35
The following settings can be configured for the vacation extension (default
 
36
values are indicated):
 
37
 
 
38
sieve_vacation_min_period = 1d
 
39
  This specifies the minimum period that can be specified for the :days and
 
40
  :seconds tags of the vacation command. A minimum of 0 indicates that users are
 
41
  allowed to make the Sieve interpreter send a vacation response message for
 
42
  every incoming message that meets the other reply criteria (refer to RFC5230).
 
43
  A value of zero is however not recommended. 
 
44
 
 
45
sieve_vacation_max_period = 0
 
46
  This specifies the maximum period that can be specified for the :days tag of
 
47
  the vacation command. The configured value must be larger than the
 
48
  sieve_vacation_min_period setting. A value of 0 has a special meaning: it
 
49
  indicates that there is no upper limit. 
 
50
 
 
51
sieve_vacation_default_period = 7d
 
52
  This specifies the default period that is used when no :days or :seconds tag
 
53
  is specified. The configured value must lie between the
 
54
  sieve_vacation_min_period and sieve_vacation_max_period.
 
55
 
 
56
sieve_vacation_use_original_recipient = no
 
57
  This specifies whether the original envelope recipient should be used in the
 
58
  check for implicit delivery.  The vacation command checks headers of the
 
59
  incoming message, such as To: and Cc: for the address of the recipient, to
 
60
  verify that the message is explicitly addressed at the recipient. If the
 
61
  recipient address is not found, the vacation action will not trigger a
 
62
  response to prevent sending a reply when it is not appropriate. Normally only
 
63
  the final recipient address is used in this check. This setting allows
 
64
  including the original recipient specified in the SMTP session if available.
 
65
  This is useful to handle mail accounts with aliases. Use this option with
 
66
  caution: if you are using aliases that point to more than a single account,
 
67
  senders can get multiple vacation responses for a single message. 
 
68
  
 
69
sieve_vacation_dont_check_recipient = no
 
70
  This disables the checks for implicit delivery entirely. This means that the
 
71
  vacation command does not verify that the message is explicitly addressed at
 
72
  the recipient. Use this option with caution. Specifying 'yes' will violate the
 
73
  Sieve standards and can cause vacation replies to be sent for messages not
 
74
  directly addressed at the recipient. 
 
75
 
 
76
Invalid values for the settings above will make the Sieve interpreter log a
 
77
warning and revert to the default values. 
 
78
 
 
79
Example
 
80
=======
 
81
 
 
82
plugin {
 
83
  # Use vacation-seconds
 
84
  sieve_extensions = +vacation-seconds
 
85
 
 
86
  # One hour at minimum
 
87
  sieve_vacation_min_period = 1h
 
88
 
 
89
  # Ten days default
 
90
  sieve_vacation_min_period = 10d
 
91
 
 
92
  # Thirty days at maximum
 
93
  sieve_vacation_max_period = 30d
 
94
}
 
95