imip-agent

Annotated docs/preferences.txt

728:575ed0737946
2015-09-12 Paul Boddie Added support for different organiser replacement preferences.
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@688 20
event_refreshing
paul@688 21
----------------
paul@688 22
paul@688 23
Default: never
paul@688 24
Alternative: always
paul@688 25
paul@688 26
Indicate whether messages requesting a refresh of event details shall be
paul@688 27
handled automatically. If not, such messages will be passed on to the
paul@688 28
recipient for their mail program to handle.
paul@688 29
paul@667 30
freebusy_bundling
paul@667 31
-----------------
paul@667 32
paul@667 33
Default: never
paul@667 34
Alternative: always
paul@463 35
paul@667 36
Indicate whether to bundle free/busy details with other payloads such as
paul@667 37
event and free/busy objects.
paul@667 38
paul@667 39
freebusy_messages
paul@667 40
-----------------
paul@667 41
paul@667 42
Default: none
paul@667 43
Alternative: notify
paul@667 44
paul@667 45
Indicate whether recipients are notified about received free/busy payloads.
paul@463 46
paul@667 47
freebusy_sharing
paul@667 48
----------------
paul@667 49
paul@667 50
Default: no
paul@667 51
Alternative: share
paul@667 52
paul@667 53
Share free/busy details generally:
paul@667 54
paul@667 55
  * bundling in e-mail messages if bundling is configured
paul@667 56
  * responding to free/busy requests via e-mail
paul@667 57
  * publishing as Web resources if a static Web resource is configured
paul@667 58
paul@667 59
incoming
paul@667 60
--------
paul@667 61
paul@667 62
Default: summary-wraps-message
paul@667 63
Alternatives: (see below)
paul@463 64
paul@667 65
Define how incoming event messages are delivered to recipients:
paul@667 66
paul@669 67
  message-only          deliver only the incoming message as it was received
paul@669 68
paul@669 69
  message-then-summary  deliver the message first followed by a summary
paul@669 70
                        message
paul@669 71
paul@669 72
  summary-then-message  deliver a summary first followed by the message
paul@669 73
paul@669 74
  summary-only          deliver only a summary of the message
paul@667 75
paul@728 76
  summary-wraps-message deliver a summary that includes the original message
paul@728 77
                        as an attachment
paul@728 78
paul@728 79
organiser_replacement
paul@728 80
---------------------
paul@728 81
paul@728 82
Default: attendee
paul@728 83
Alternatives: (see below)
paul@728 84
paul@728 85
Indicate whether the organiser of an event can be replaced and the nature of
paul@728 86
any replacement:
paul@728 87
paul@728 88
  any                   any identity, regardless of whether it is already
paul@728 89
                        present or even previously unknown, may become the
paul@728 90
                        organiser
paul@728 91
paul@728 92
  attendee              any new organiser must be a previously-recognised
paul@728 93
                        attendee
paul@728 94
paul@728 95
  never                 forbid the replacement of an event's organiser
paul@728 96
paul@667 97
participating
paul@667 98
-------------
paul@667 99
paul@667 100
Default: participate
paul@667 101
Alternative: no
paul@667 102
paul@667 103
Indicate whether a recipient participates in the calendar system. Note that
paul@667 104
participation by default occurs because the handler programs will be defined
paul@667 105
in the mail system for recipients fulfilling certain criteria; other
paul@667 106
recipients will be handled in other ways. Thus, initial non-participation must
paul@667 107
be defined by initialising this setting to "no" for all eligible users, if
paul@667 108
this is the general policy on initial calendar system participation.
paul@669 109
paul@669 110
permitted_times
paul@669 111
---------------
paul@669 112
paul@669 113
Default: (none)
paul@669 114
Alternatives: (see below)
paul@669 115
paul@669 116
Define the time values at which events can be scheduled. In its simplest form,
paul@669 117
this indicates the resolution of a calendar for a participant supporting this
paul@669 118
setting, with the given minute values being those allowed for the start and
paul@669 119
end of an event. This setting requires a value of one of the following forms:
paul@669 120
paul@669 121
  <minute values>
paul@669 122
  <hour values>:<minute values>
paul@669 123
  <hour values>:<minute values>:<second values>
paul@669 124
paul@669 125
Each list of values is a comma-separated collection of permissible values for
paul@669 126
the unit of time being constrained. Any unspecified list is taken to permit
paul@669 127
all normally permissible values for that unit of time. For example:
paul@669 128
paul@669 129
  0,15,30,45            every 15 minutes from the start of each hour
paul@669 130
  10,12,14,16:0,20,40   every 20 minutes from 10:00 until 16:40 inclusive
paul@669 131
  12::0,30              every 30 seconds from the start of each minute during
paul@669 132
                        the period from 12:00:00 until 12:59:30 inclusive
paul@669 133
paul@669 134
The purpose of this setting is not necessarily to impose availability
paul@669 135
constraints but instead to impose a "grid" to which event start and end points
paul@669 136
shall be "locked".
paul@707 137
paul@707 138
The values are interpreted in the local time of the participant. Thus, a time
paul@707 139
represented in UTC may have apparently inappropriate hour (and for some zones)
paul@707 140
minute values that correspond to permitted values in this participant's own
paul@707 141
time zone.