imip-agent

Annotated docs/preferences.txt

667:4d441e96f22f
2015-08-29 Paul Boddie Added a preference to define overall participation in the calendar system. Changed the test handler to work with non-store objects so that unstored events can be tested with the outgoing message handler. Improved the preferences documentation.
paul@667 1
Preferences and Settings
paul@667 2
========================
paul@667 3
paul@667 4
LANG
paul@667 5
----
paul@463 6
paul@667 7
Default: en (English)
paul@667 8
Alternatives: (any recognised and supported locale)
paul@667 9
paul@667 10
The language for messages and user interface text.
paul@667 11
paul@667 12
TZID
paul@667 13
----
paul@667 14
paul@667 15
Default: system timezone (see /etc/timezone)
paul@667 16
Alternatives: (any recognised Olson time zone identifier)
paul@463 17
paul@667 18
The default time zone/regime for calendars, new events and local times.
paul@667 19
paul@667 20
freebusy_bundling
paul@667 21
-----------------
paul@667 22
paul@667 23
Default: never
paul@667 24
Alternative: always
paul@463 25
paul@667 26
Indicate whether to bundle free/busy details with other payloads such as
paul@667 27
event and free/busy objects.
paul@667 28
paul@667 29
freebusy_messages
paul@667 30
-----------------
paul@667 31
paul@667 32
Default: none
paul@667 33
Alternative: notify
paul@667 34
paul@667 35
Indicate whether recipients are notified about received free/busy payloads.
paul@463 36
paul@667 37
freebusy_sharing
paul@667 38
----------------
paul@667 39
paul@667 40
Default: no
paul@667 41
Alternative: share
paul@667 42
paul@667 43
Share free/busy details generally:
paul@667 44
paul@667 45
  * bundling in e-mail messages if bundling is configured
paul@667 46
  * responding to free/busy requests via e-mail
paul@667 47
  * publishing as Web resources if a static Web resource is configured
paul@667 48
paul@667 49
incoming
paul@667 50
--------
paul@667 51
paul@667 52
Default: summary-wraps-message
paul@667 53
Alternatives: (see below)
paul@463 54
paul@667 55
Define how incoming event messages are delivered to recipients:
paul@667 56
paul@667 57
  * message-only (deliver only the incoming message as it was received)
paul@667 58
  * message-then-summary (deliver the message first followed by a summary
paul@667 59
                          message)
paul@667 60
  * summary-then-message (deliver a summary first followed by the message)
paul@667 61
  * summary-only (deliver only a summary of the message)
paul@667 62
paul@667 63
participating
paul@667 64
-------------
paul@667 65
paul@667 66
Default: participate
paul@667 67
Alternative: no
paul@667 68
paul@667 69
Indicate whether a recipient participates in the calendar system. Note that
paul@667 70
participation by default occurs because the handler programs will be defined
paul@667 71
in the mail system for recipients fulfilling certain criteria; other
paul@667 72
recipients will be handled in other ways. Thus, initial non-participation must
paul@667 73
be defined by initialising this setting to "no" for all eligible users, if
paul@667 74
this is the general policy on initial calendar system participation.