imip-agent

docs/preferences.txt

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