imip-agent

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