imip-agent

Annotated docs/preferences.txt

748:e332784ba2bb
2015-09-17 Paul Boddie Added a setting to control Web publication of free/busy details. Introduced separate files for Web server configuration and added a description of the Web server configuration activity. Added a test for publishing to the free/busy script.
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@734 20
add_method_response
paul@734 21
-------------------
paul@734 22
paul@734 23
Default: refresh
paul@740 24
Alternatives: (see below)
paul@734 25
paul@734 26
Indicate how ADD methods shall be responded to when received by a recipient:
paul@734 27
paul@734 28
  add                   apply them to events as received
paul@734 29
paul@734 30
  ignore                ignore attempts to add event occurrences
paul@734 31
paul@734 32
  refresh               respond with a REFRESH message to obtain a proper
paul@734 33
                        request will all event details
paul@734 34
paul@688 35
event_refreshing
paul@688 36
----------------
paul@688 37
paul@688 38
Default: never
paul@688 39
Alternative: always
paul@688 40
paul@688 41
Indicate whether messages requesting a refresh of event details shall be
paul@688 42
handled automatically. If not, such messages will be passed on to the
paul@688 43
recipient for their mail program to handle.
paul@688 44
paul@667 45
freebusy_bundling
paul@667 46
-----------------
paul@667 47
paul@667 48
Default: never
paul@667 49
Alternative: always
paul@463 50
paul@667 51
Indicate whether to bundle free/busy details with other payloads such as
paul@748 52
event and free/busy objects. The freebusy_sharing setting must be configured
paul@748 53
for bundling to operate.
paul@667 54
paul@667 55
freebusy_messages
paul@667 56
-----------------
paul@667 57
paul@667 58
Default: none
paul@667 59
Alternative: notify
paul@667 60
paul@667 61
Indicate whether recipients are notified about received free/busy payloads.
paul@463 62
paul@740 63
freebusy_offers
paul@740 64
---------------
paul@740 65
paul@740 66
Default: (none)
paul@740 67
Alternative: (see below)
paul@740 68
paul@740 69
Define the period for which free/busy offers are extended by participants
paul@740 70
supporting this setting when counter-proposals are made during event
paul@740 71
scheduling.
paul@740 72
paul@740 73
This setting requires a value of one of the following forms:
paul@740 74
paul@740 75
  <number of seconds>
paul@740 76
  <number of days>d
paul@740 77
paul@740 78
For example:
paul@740 79
paul@740 80
  600                   extend scheduling offers for 10 minutes
paul@740 81
  1d                    extend offers for 1 day
paul@740 82
paul@748 83
freebusy_publishing
paul@748 84
-------------------
paul@748 85
paul@748 86
Default: no
paul@748 87
Alternative: publish
paul@748 88
paul@748 89
Indicate whether to publish free/busy details as Web resources. The
paul@748 90
freebusy_sharing setting must be configured for publishing to operate.
paul@748 91
paul@667 92
freebusy_sharing
paul@667 93
----------------
paul@667 94
paul@667 95
Default: no
paul@667 96
Alternative: share
paul@667 97
paul@667 98
Share free/busy details generally:
paul@667 99
paul@667 100
  * bundling in e-mail messages if bundling is configured
paul@667 101
  * responding to free/busy requests via e-mail
paul@748 102
  * publishing as Web resources if a static Web resource is configured and if
paul@748 103
    publishing is configured
paul@667 104
paul@667 105
incoming
paul@667 106
--------
paul@667 107
paul@667 108
Default: summary-wraps-message
paul@667 109
Alternatives: (see below)
paul@463 110
paul@667 111
Define how incoming event messages are delivered to recipients:
paul@667 112
paul@669 113
  message-only          deliver only the incoming message as it was received
paul@669 114
paul@669 115
  message-then-summary  deliver the message first followed by a summary
paul@669 116
                        message
paul@669 117
paul@669 118
  summary-then-message  deliver a summary first followed by the message
paul@669 119
paul@669 120
  summary-only          deliver only a summary of the message
paul@667 121
paul@728 122
  summary-wraps-message deliver a summary that includes the original message
paul@728 123
                        as an attachment
paul@728 124
paul@728 125
organiser_replacement
paul@728 126
---------------------
paul@728 127
paul@728 128
Default: attendee
paul@728 129
Alternatives: (see below)
paul@728 130
paul@728 131
Indicate whether the organiser of an event can be replaced and the nature of
paul@728 132
any replacement:
paul@728 133
paul@728 134
  any                   any identity, regardless of whether it is already
paul@728 135
                        present or even previously unknown, may become the
paul@728 136
                        organiser
paul@728 137
paul@728 138
  attendee              any new organiser must be a previously-recognised
paul@728 139
                        attendee
paul@728 140
paul@728 141
  never                 forbid the replacement of an event's organiser
paul@728 142
paul@667 143
participating
paul@667 144
-------------
paul@667 145
paul@667 146
Default: participate
paul@667 147
Alternative: no
paul@667 148
paul@667 149
Indicate whether a recipient participates in the calendar system. Note that
paul@667 150
participation by default occurs because the handler programs will be defined
paul@667 151
in the mail system for recipients fulfilling certain criteria; other
paul@667 152
recipients will be handled in other ways. Thus, initial non-participation must
paul@667 153
be defined by initialising this setting to "no" for all eligible users, if
paul@667 154
this is the general policy on initial calendar system participation.
paul@669 155
paul@669 156
permitted_times
paul@669 157
---------------
paul@669 158
paul@669 159
Default: (none)
paul@669 160
Alternatives: (see below)
paul@669 161
paul@669 162
Define the time values at which events can be scheduled. In its simplest form,
paul@669 163
this indicates the resolution of a calendar for a participant supporting this
paul@669 164
setting, with the given minute values being those allowed for the start and
paul@669 165
end of an event. This setting requires a value of one of the following forms:
paul@669 166
paul@669 167
  <minute values>
paul@669 168
  <hour values>:<minute values>
paul@669 169
  <hour values>:<minute values>:<second values>
paul@669 170
paul@669 171
Each list of values is a comma-separated collection of permissible values for
paul@669 172
the unit of time being constrained. Any unspecified list is taken to permit
paul@669 173
all normally permissible values for that unit of time. For example:
paul@669 174
paul@669 175
  0,15,30,45            every 15 minutes from the start of each hour
paul@669 176
  10,12,14,16:0,20,40   every 20 minutes from 10:00 until 16:40 inclusive
paul@669 177
  12::0,30              every 30 seconds from the start of each minute during
paul@669 178
                        the period from 12:00:00 until 12:59:30 inclusive
paul@669 179
paul@669 180
The purpose of this setting is not necessarily to impose availability
paul@669 181
constraints but instead to impose a "grid" to which event start and end points
paul@669 182
shall be "locked".
paul@707 183
paul@707 184
The values are interpreted in the local time of the participant. Thus, a time
paul@707 185
represented in UTC may have apparently inappropriate hour (and for some zones)
paul@707 186
minute values that correspond to permitted values in this participant's own
paul@707 187
time zone.