imip-agent

docs/preferences.txt

789:c90e7281106d
2015-09-29 Paul Boddie Added missing escaping for text within elements.
     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 indicating a duration as described in the
    74 iCalendar format specification:
    75 
    76 http://tools.ietf.org/html/rfc5545#section-3.3.6
    77 
    78 For example:
    79 
    80   PT10M                 extend scheduling offers for 10 minutes
    81   PT600S                extend scheduling offers for 600 seconds (10 minutes)
    82   PT1D                  extend offers for 1 day
    83 
    84 freebusy_publishing
    85 -------------------
    86 
    87 Default: no
    88 Alternative: publish
    89 
    90 Indicate whether to publish free/busy details as Web resources. The
    91 freebusy_sharing setting must be configured for publishing to operate.
    92 
    93 freebusy_sharing
    94 ----------------
    95 
    96 Default: no
    97 Alternative: share
    98 
    99 Share free/busy details generally:
   100 
   101   * bundling in e-mail messages if bundling is configured
   102   * responding to free/busy requests via e-mail
   103   * publishing as Web resources if a static Web resource is configured and if
   104     publishing is configured
   105 
   106 incoming
   107 --------
   108 
   109 Default: summary-wraps-message
   110 Alternatives: (see below)
   111 
   112 Define how incoming event messages are delivered to recipients:
   113 
   114   message-only          deliver only the incoming message as it was received
   115 
   116   message-then-summary  deliver the message first followed by a summary
   117                         message
   118 
   119   summary-then-message  deliver a summary first followed by the message
   120 
   121   summary-only          deliver only a summary of the message
   122 
   123   summary-wraps-message deliver a summary that includes the original message
   124                         as an attachment
   125 
   126 organiser_replacement
   127 ---------------------
   128 
   129 Default: attendee
   130 Alternatives: (see below)
   131 
   132 Indicate whether the organiser of an event can be replaced and the nature of
   133 any replacement:
   134 
   135   any                   any identity, regardless of whether it is already
   136                         present or even previously unknown, may become the
   137                         organiser
   138 
   139   attendee              any new organiser must be a previously-recognised
   140                         attendee
   141 
   142   never                 forbid the replacement of an event's organiser
   143 
   144 participating
   145 -------------
   146 
   147 Default: participate
   148 Alternative: no
   149 
   150 Indicate whether a recipient participates in the calendar system. Note that
   151 participation by default occurs because the handler programs will be defined
   152 in the mail system for recipients fulfilling certain criteria; other
   153 recipients will be handled in other ways. Thus, initial non-participation must
   154 be defined by initialising this setting to "no" for all eligible users, if
   155 this is the general policy on initial calendar system participation.
   156 
   157 permitted_times
   158 ---------------
   159 
   160 Default: (none)
   161 Alternatives: (see below)
   162 
   163 Define the time values at which events can be scheduled. In its simplest form,
   164 this indicates the resolution of a calendar for a participant supporting this
   165 setting, with the given minute values being those allowed for the start and
   166 end of an event. This setting requires a value of one of the following forms:
   167 
   168   <minute values>
   169   <hour values>:<minute values>
   170   <hour values>:<minute values>:<second values>
   171 
   172 Each list of values is a comma-separated collection of permissible values for
   173 the unit of time being constrained. Any unspecified list is taken to permit
   174 all normally permissible values for that unit of time. For example:
   175 
   176   0,15,30,45            every 15 minutes from the start of each hour
   177   10,12,14,16:0,20,40   every 20 minutes from 10:00 until 16:40 inclusive
   178   12::0,30              every 30 seconds from the start of each minute during
   179                         the period from 12:00:00 until 12:59:30 inclusive
   180 
   181 The purpose of this setting is not necessarily to impose availability
   182 constraints but instead to impose a "grid" to which event start and end points
   183 shall be "locked".
   184 
   185 The values are interpreted in the local time of the participant. Thus, a time
   186 represented in UTC may have apparently inappropriate hour (and for some zones)
   187 minute values that correspond to permitted values in this participant's own
   188 time zone.