diff --git a/.gitignore b/.gitignore
index f70b6fde..fd6cd363 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,7 +23,6 @@
# misc
.DS_Store
*.pem
-/specifications/
# debug
npm-debug.log*
diff --git a/specifications/addon-plugin-theme-concept.md b/specifications/addon-plugin-theme-concept.md
new file mode 100644
index 00000000..801ee8c9
--- /dev/null
+++ b/specifications/addon-plugin-theme-concept.md
@@ -0,0 +1,937 @@
+# Addons, Plugins & Themes — Architecture Concept
+
+> **Status**: Draft Concept
+> **Date**: 2026-03-13
+
+---
+
+## Table of Contents
+
+1. [Overview](#1-overview)
+2. [Terminology](#2-terminology)
+3. [Manifest Format](#3-manifest-format)
+4. [Themes](#4-themes)
+5. [Plugins](#5-plugins)
+6. [Addon Lifecycle](#6-addon-lifecycle)
+7. [Extension Points (Hooks & Slots)](#7-extension-points-hooks--slots)
+8. [Security & Sandboxing](#8-security--sandboxing)
+9. [Storage & Distribution](#9-storage--distribution)
+10. [Settings Integration](#10-settings-integration)
+11. [API Surface](#11-api-surface)
+12. [Migration Path](#12-migration-path)
+
+---
+
+## 1. Overview
+
+This document describes a system that allows the JMAP Webmail application to be extended through **themes** (visual customization) and **plugins** (functional extensions). Together, these are called **addons**.
+
+### Design Goals
+
+- **Safe by default** — addons cannot break core functionality or access data beyond their declared scope.
+- **Zero-config for users** — install, enable, done. No code changes to the host app.
+- **Declarative where possible** — prefer JSON/CSS-based customization over imperative code.
+- **Aligned with existing architecture** — builds on Zustand stores, React context/providers, CSS variables, and the Next.js App Router patterns already in use.
+- **Incrementally adoptable** — the core app can ship without any addons; the addon system is a layer on top.
+
+### Non-Goals (for v1)
+
+- Server-side plugin execution (all addons run client-side).
+- A public addon marketplace (addons are self-hosted or bundled).
+- Modifying JMAP protocol behavior (addons consume JMAP data, not intercept it).
+
+---
+
+## 2. Terminology
+
+| Term | Definition |
+|------|-----------|
+| **Addon** | Any installable extension — umbrella term for themes and plugins. |
+| **Theme** | An addon that only customizes visual appearance (colors, fonts, spacing, density). Ships as CSS + a manifest. Contains no executable code. |
+| **Plugin** | An addon that adds or modifies functionality. Ships as a JS/TS module + a manifest. May include a theme. |
+| **Slot** | A named insertion point in the UI where plugins can render components. |
+| **Hook Point** | A named event or state transition where plugins can run logic. |
+| **Manifest** | A `addon.json` file that declares metadata, permissions, and extension points. |
+
+---
+
+## 3. Manifest Format
+
+Every addon has an `addon.json` at its root:
+
+```jsonc
+{
+ // ── Identity ──
+ "id": "com.example.my-addon", // Reverse-domain unique ID
+ "name": "My Addon",
+ "version": "1.0.0", // Semver
+ "description": "A brief description.",
+ "author": {
+ "name": "Jane Doe",
+ "url": "https://example.com"
+ },
+ "license": "MIT",
+ "homepage": "https://example.com/my-addon",
+
+ // ── Compatibility ──
+ "engine": {
+ "webmail": ">=1.0.0" // Required host app version range
+ },
+
+ // ── Type ──
+ "type": "plugin", // "theme" | "plugin"
+
+ // ── Entry Points (plugins only) ──
+ "main": "dist/index.js", // Plugin entry module
+ "styles": "dist/styles.css", // Optional supplementary CSS
+
+ // ── Theme Definition (themes, or plugins that include a theme) ──
+ "theme": {
+ "variables": "theme.css", // CSS file with variable overrides
+ "presets": ["light", "dark"], // Which base modes it provides
+ "preview": "preview.png" // Screenshot for settings UI
+ },
+
+ // ── Permissions (plugins only) ──
+ "permissions": [
+ "emails:read", // Read email data from store
+ "emails:write", // Modify email data (move, flag, etc.)
+ "contacts:read",
+ "calendar:read",
+ "settings:read",
+ "settings:write",
+ "notifications", // Show toasts / browser notifications
+ "compose:toolbar", // Add buttons to composer toolbar
+ "sidebar:section", // Add sections to the sidebar
+ "viewer:action", // Add actions to email viewer toolbar
+ "navigation:tab", // Add a top-level navigation tab
+ "context-menu:email", // Extend email context menu
+ "keyboard-shortcuts", // Register keyboard shortcuts
+ "external-fetch" // Fetch external URLs (declared origins)
+ ],
+
+ // ── External Origins (if external-fetch permission is declared) ──
+ "allowedOrigins": [
+ "https://api.example.com"
+ ],
+
+ // ── Slots (declares which UI slots the plugin uses) ──
+ "slots": [
+ "sidebar.bottom",
+ "compose.toolbar",
+ "viewer.actions"
+ ],
+
+ // ── Settings Schema (plugin-specific preferences) ──
+ "settings": {
+ "apiKey": {
+ "type": "string",
+ "label": "API Key",
+ "description": "Your API key for the service.",
+ "secret": true
+ },
+ "enabled": {
+ "type": "boolean",
+ "label": "Enable integration",
+ "default": true
+ }
+ },
+
+ // ── i18n ──
+ "locales": "locales/" // Directory with {locale}.json files
+}
+```
+
+---
+
+## 4. Themes
+
+Themes are the simplest addon type — pure CSS, no executable code.
+
+### 4.1 How Themes Work
+
+The app already uses CSS custom properties (variables) for all colors, defined in `globals.css` under `:root` and `.dark`. A theme overrides these variables:
+
+```css
+/* theme.css — "Nord" theme example */
+
+:root[data-theme="com.example.nord"] {
+ --color-background: #eceff4;
+ --color-foreground: #2e3440;
+ --color-primary: #5e81ac;
+ --color-primary-foreground: #eceff4;
+ --color-border: #d8dee9;
+ --color-sidebar-bg: #e5e9f0;
+ --color-sidebar-hover: #d8dee9;
+ --color-muted: #4c566a;
+ --color-accent: #88c0d0;
+ --color-destructive: #bf616a;
+
+ /* Extended variables for advanced customization */
+ --font-family-base: "Inter", sans-serif;
+ --font-family-mono: "JetBrains Mono", monospace;
+ --radius-base: 8px;
+ --spacing-density: 1; /* 0.8 = compact, 1 = normal, 1.2 = comfortable */
+ --shadow-elevation-1: 0 1px 3px rgba(0,0,0,0.08);
+}
+
+:root[data-theme="com.example.nord"].dark {
+ --color-background: #2e3440;
+ --color-foreground: #eceff4;
+ --color-primary: #88c0d0;
+ --color-border: #3b4252;
+ --color-sidebar-bg: #3b4252;
+ --color-sidebar-hover: #434c5e;
+}
+```
+
+### 4.2 Theme Application
+
+```
+User selects theme in Settings → Appearance
+ → ThemeStore sets `activeTheme: "com.example.nord"`
+ →
+ → Theme CSS is loaded via a tag with the theme's CSS file
+ → CSS specificity ensures theme variables override defaults
+```
+
+### 4.3 Theme Capabilities
+
+| Capability | Mechanism |
+|-----------|-----------|
+| Colors | Override `--color-*` CSS variables |
+| Typography | Override `--font-family-*` variables |
+| Spacing/density | Override `--spacing-density` multiplier |
+| Border radius | Override `--radius-*` variables |
+| Shadows | Override `--shadow-*` variables |
+| Dark mode variant | Provide `.dark` overrides |
+| Tag/label colors | Override `--tag-color-*` palette |
+| Custom CSS | Additional rules scoped under `[data-theme="..."]` |
+
+### 4.4 Theme Constraints
+
+- Themes **cannot** add or remove DOM elements.
+- Themes **cannot** execute JavaScript.
+- Themes **cannot** override layout structure (flexbox directions, grid templates).
+- Theme CSS is scoped by `[data-theme]` attribute — removing the attribute instantly reverts to defaults.
+- A maximum CSS file size is enforced (e.g., 100 KB) to prevent abuse.
+
+---
+
+## 5. Plugins
+
+Plugins are JavaScript modules that interact with the app through a controlled API.
+
+### 5.1 Plugin Entry Point
+
+A plugin exports a single `activate` function and optionally a `deactivate` function:
+
+```ts
+// index.ts — Plugin entry point
+import type { PluginContext } from "@jmap-webmail/addon-api";
+
+export function activate(ctx: PluginContext) {
+ // Register a sidebar section
+ ctx.slots.register("sidebar.bottom", {
+ component: MySidebarWidget,
+ priority: 10,
+ });
+
+ // Register a composer toolbar button
+ ctx.slots.register("compose.toolbar", {
+ component: EncryptButton,
+ priority: 50,
+ });
+
+ // Listen to store changes
+ ctx.hooks.on("email:selected", (email) => {
+ // React to email selection
+ });
+
+ // Register a keyboard shortcut
+ ctx.shortcuts.register({
+ key: "g t",
+ description: "Open translation panel",
+ action: () => ctx.panels.open("translate"),
+ });
+
+ // Add a context menu item
+ ctx.contextMenu.register("email", {
+ label: ctx.i18n.t("translateEmail"),
+ icon: "Languages",
+ action: (emailId) => { /* ... */ },
+ });
+}
+
+export function deactivate(ctx: PluginContext) {
+ // Cleanup — called when the plugin is disabled or uninstalled.
+ // All slot registrations and event subscriptions are
+ // automatically cleaned up, so this is only needed
+ // for external resource cleanup.
+}
+```
+
+### 5.2 PluginContext API
+
+The `PluginContext` object is the plugin's only interface to the host app. It is scoped and sandboxed based on the declared permissions:
+
+```ts
+interface PluginContext {
+ /** Plugin metadata from manifest */
+ manifest: AddonManifest;
+
+ /** UI slot registration */
+ slots: {
+ register(slotId: string, registration: SlotRegistration): Disposable;
+ };
+
+ /** Event hooks */
+ hooks: {
+ on(event: HookEvent, handler: Function): Disposable;
+ once(event: HookEvent, handler: Function): Disposable;
+ };
+
+ /** Store access (read-only or read-write based on permissions) */
+ stores: {
+ emails: PluginEmailStore; // If emails:read or emails:write
+ contacts: PluginContactStore; // If contacts:read
+ calendar: PluginCalendarStore; // If calendar:read
+ settings: PluginSettingsStore; // If settings:read or settings:write
+ };
+
+ /** Plugin-specific settings (defined in manifest "settings" schema) */
+ config: {
+ get(key: string): T;
+ set(key: string, value: unknown): void;
+ onChange(key: string, handler: (value: unknown) => void): Disposable;
+ };
+
+ /** Toast notifications */
+ notifications: {
+ success(message: string): void;
+ error(message: string): void;
+ info(message: string): void;
+ };
+
+ /** i18n — scoped to plugin's locale files */
+ i18n: {
+ t(key: string, params?: Record): string;
+ locale: string;
+ };
+
+ /** Keyboard shortcuts */
+ shortcuts: {
+ register(shortcut: ShortcutDefinition): Disposable;
+ };
+
+ /** Context menu extensions */
+ contextMenu: {
+ register(target: ContextMenuTarget, item: ContextMenuItem): Disposable;
+ };
+
+ /** Panel API — open side panels or modals */
+ panels: {
+ open(panelId: string, props?: Record): void;
+ close(panelId: string): void;
+ register(panelId: string, component: React.ComponentType): Disposable;
+ };
+
+ /** Scoped fetch — only allowed origins from manifest */
+ fetch(url: string, init?: RequestInit): Promise;
+}
+```
+
+### 5.3 Disposable Pattern
+
+All registrations return a `Disposable` object. On plugin deactivation, all disposables are automatically cleaned up:
+
+```ts
+interface Disposable {
+ dispose(): void;
+}
+```
+
+---
+
+## 6. Addon Lifecycle
+
+```
+┌──────────────────────────────────────────────────────────┐
+│ Addon Lifecycle │
+├──────────────────────────────────────────────────────────┤
+│ │
+│ ┌─────────┐ install ┌───────────┐ enable │
+│ │ Store │────────────▶│ Installed │──────────┐ │
+│ │ / URL │ │ (disabled) │ │ │
+│ └─────────┘ └───────────┘ ▼ │
+│ ▲ ┌──────────┐ │
+│ disable│ │ Active │ │
+│ │ │(running) │ │
+│ └───────────┤ │ │
+│ └──────────┘ │
+│ │ ▲ │
+│ uninstall update│ │
+│ │ │ │
+│ ▼ ┌────┴─────┐ │
+│ ┌────────┐ │ Updating │ │
+│ │Removed │ └──────────┘ │
+│ └────────┘ │
+│ │
+└──────────────────────────────────────────────────────────┘
+```
+
+### 6.1 Loading Sequence
+
+1. **Boot**: App starts, `AddonManager` reads the addon registry from `localStorage` (list of installed addons + enabled state).
+2. **Resolve**: For each enabled addon, load its manifest and verify compatibility (`engine.webmail`).
+3. **Load Themes**: Inject theme CSS `` for the active theme.
+4. **Load Plugins**: Dynamically import each plugin's `main` entry point.
+5. **Activate**: Call `activate(ctx)` for each plugin, passing a scoped `PluginContext`.
+6. **Ready**: Emit `app:ready` hook — plugins can now interact with stores.
+
+### 6.2 Addon Manager Store
+
+A new Zustand store manages addon state:
+
+```ts
+interface AddonManagerState {
+ /** Registry of all installed addons */
+ addons: Record;
+
+ /** Currently active theme ID (null = default) */
+ activeTheme: string | null;
+
+ /** Actions */
+ installAddon(source: AddonSource): Promise;
+ uninstallAddon(id: string): void;
+ enableAddon(id: string): void;
+ disableAddon(id: string): void;
+ setActiveTheme(id: string | null): void;
+ getAddon(id: string): InstalledAddon | undefined;
+ getEnabledPlugins(): InstalledAddon[];
+}
+
+interface InstalledAddon {
+ manifest: AddonManifest;
+ enabled: boolean;
+ installedAt: string; // ISO timestamp
+ source: AddonSource; // Where it was loaded from
+ runtimeState: "inactive" | "active" | "error";
+ error?: string; // Last activation error
+}
+
+type AddonSource =
+ | { type: "bundled" } // Shipped with the app
+ | { type: "url"; url: string } // Loaded from a URL
+ | { type: "local"; path: string }; // Development: local file
+```
+
+---
+
+## 7. Extension Points (Hooks & Slots)
+
+### 7.1 UI Slots
+
+Slots are named insertion points scattered across the UI. The host app renders a `` component at each point; plugins register components into slots.
+
+```tsx
+// Host app — in sidebar.tsx
+import { Slot } from "@/components/addons/slot";
+
+function Sidebar() {
+ return (
+
+ );
+}
+```
+
+```tsx
+// Slot component implementation
+function Slot({ name }: { name: string }) {
+ const registrations = useAddonSlot(name);
+ if (registrations.length === 0) return null;
+
+ return (
+ <>
+ {registrations
+ .sort((a, b) => a.priority - b.priority)
+ .map((reg) => (
+
+
+
+ ))}
+ >
+ );
+}
+```
+
+#### Available Slots
+
+| Slot Name | Location | Use Case |
+|-----------|----------|----------|
+| `sidebar.top` | Top of sidebar, below compose button | Quick-access widgets |
+| `sidebar.bottom` | Bottom of sidebar, above storage quota | Extra navigation, widgets |
+| `navigation.tabs` | Navigation rail, below contacts icon | New top-level views |
+| `compose.toolbar` | Composer toolbar (formatting bar) | Encrypt, translate, AI assist buttons |
+| `compose.footer` | Below composer body, above send button | Send-time options (delay, schedule) |
+| `viewer.actions` | Email viewer toolbar | Custom actions (translate, summarize) |
+| `viewer.header` | Above email body in viewer | Banners, warnings, metadata |
+| `viewer.footer` | Below email body in viewer | Related content, suggestions |
+| `list.toolbar` | Above email list | Additional filters, bulk actions |
+| `settings.sections` | Settings page, below existing sections | Plugin settings panels |
+| `calendar.toolbar` | Calendar view toolbar | Calendar-specific actions |
+| `contacts.toolbar` | Contacts view toolbar | Contact-specific actions |
+
+### 7.2 Hook Events
+
+Plugins can listen to app events and state transitions:
+
+#### Email Hooks
+
+| Event | Payload | Description |
+|-------|---------|-------------|
+| `email:selected` | `{ emailId, email }` | User selected an email |
+| `email:opened` | `{ emailId, email }` | Email viewer rendered |
+| `email:compose:open` | `{ mode, replyTo? }` | Composer opened |
+| `email:compose:before-send` | `{ draft }` | Before sending — can modify draft |
+| `email:compose:sent` | `{ emailId }` | Email sent successfully |
+| `email:moved` | `{ emailId, from, to }` | Email moved between mailboxes |
+| `email:deleted` | `{ emailId }` | Email deleted |
+| `email:flagged` | `{ emailId, flags }` | Email flags changed |
+
+#### Calendar Hooks
+
+| Event | Payload | Description |
+|-------|---------|-------------|
+| `calendar:event:created` | `{ event }` | New event created |
+| `calendar:event:updated` | `{ event, changes }` | Event modified |
+| `calendar:event:deleted` | `{ eventId }` | Event deleted |
+| `calendar:view:changed` | `{ view, date }` | Calendar view switched |
+
+#### Contact Hooks
+
+| Event | Payload | Description |
+|-------|---------|-------------|
+| `contact:selected` | `{ contactId }` | Contact selected |
+| `contact:created` | `{ contact }` | New contact created |
+| `contact:updated` | `{ contact }` | Contact modified |
+
+#### App Hooks
+
+| Event | Payload | Description |
+|-------|---------|-------------|
+| `app:ready` | `{}` | App fully loaded |
+| `app:theme:changed` | `{ theme }` | Theme switched |
+| `app:locale:changed` | `{ locale }` | Language changed |
+| `app:navigation` | `{ from, to }` | User navigated between views |
+
+---
+
+## 8. Security & Sandboxing
+
+### 8.1 Permission Model
+
+Plugins declare required permissions in their manifest. On installation, the user sees a permission prompt:
+
+```
+"My Translation Plugin" requests:
+ ✉️ Read your emails
+ 🔔 Show notifications
+ 🌐 Connect to https://api.translate.example.com
+
+ [Allow] [Cancel]
+```
+
+Permissions are enforced at the `PluginContext` level — if a plugin didn't declare `emails:read`, `ctx.stores.emails` is `undefined`.
+
+### 8.2 Sandboxing Strategy
+
+| Layer | Mechanism |
+|-------|-----------|
+| **Store access** | `PluginContext` exposes only permitted store slices. Write access returns proxied objects — mutations are validated before applying. |
+| **DOM access** | Plugin components render inside an ``. They receive a scoped React tree — no direct `document` manipulation. |
+| **Network** | `ctx.fetch()` is a controlled wrapper. Requests are only allowed to origins listed in `allowedOrigins`. All other `fetch` / `XMLHttpRequest` calls from plugin code are blocked via CSP headers. |
+| **Storage** | Plugins use `ctx.config` (backed by a namespaced key in `localStorage`). No direct `localStorage` / `sessionStorage` access. |
+| **Error isolation** | Each plugin slot is wrapped in an `AddonErrorBoundary`. A crashing plugin is caught and disabled without affecting the rest of the app. |
+| **Resource limits** | Plugin CSS is limited to 100 KB. Plugin JS bundles are limited to 500 KB (configurable). |
+
+### 8.3 Content Security Policy
+
+Theme CSS is sanitized to disallow:
+- `url()` references to external domains (only data URIs and same-origin).
+- `@import` statements.
+- `expression()` or `behavior:` (legacy IE attack vectors).
+
+### 8.4 Error Boundary
+
+```tsx
+function AddonErrorBoundary({ addonId, children }) {
+ return (
+ }
+ onError={(error) => {
+ console.error(`[Addon: ${addonId}] Crashed:`, error);
+ addonManager.reportError(addonId, error);
+ // Auto-disable after 3 crashes in 5 minutes
+ }}
+ >
+ {children}
+
+ );
+}
+```
+
+---
+
+## 9. Storage & Distribution
+
+### 9.1 Addon Formats
+
+| Format | Description | Use Case |
+|--------|-------------|----------|
+| **Bundled** | Shipped inside the app's `/addons/` directory | Default themes, first-party plugins |
+| **URL** | Loaded from a remote URL at runtime | Self-hosted or third-party addons |
+| **Local file** | Loaded from a local path (dev mode only) | Plugin development |
+
+### 9.2 Addon Bundle Structure
+
+```
+my-addon/
+├── addon.json # Manifest (required)
+├── dist/
+│ ├── index.js # Plugin entry (plugins only)
+│ └── styles.css # Additional styles (optional)
+├── theme.css # Theme variables (themes only)
+├── preview.png # Theme preview image (optional)
+└── locales/
+ ├── en.json # English strings
+ ├── fr.json # French strings
+ └── ...
+```
+
+### 9.3 Built-in Addon Directory
+
+```
+addons/
+├── themes/
+│ ├── nord/
+│ │ ├── addon.json
+│ │ ├── theme.css
+│ │ └── preview.png
+│ ├── dracula/
+│ ├── solarized/
+│ ├── catppuccin/
+│ └── high-contrast/
+└── plugins/
+ └── (none bundled by default)
+```
+
+### 9.4 Installation Flow
+
+**From URL:**
+1. User pastes addon URL into Settings → Addons → "Install from URL".
+2. App fetches `{url}/addon.json`, validates schema and compatibility.
+3. Manifest is stored in addon registry (`localStorage`).
+4. On next activation, the addon's assets are fetched and cached.
+
+**Bundled:**
+1. Addons in `/addons/` are auto-discovered at build time.
+2. A generated `addon-registry.json` maps addon IDs to their local paths.
+3. Bundled addons appear pre-installed (but can be disabled).
+
+---
+
+## 10. Settings Integration
+
+### 10.1 Addon Settings Page
+
+A new page at `/settings/addons` integrates into the existing settings layout:
+
+```
+Settings
+├── Appearance
+├── Language & Region
+├── Email
+├── Composer
+├── Calendar
+├── Privacy & Security
+├── Keyboard Shortcuts
+├── Addons ← NEW
+│ ├── Themes
+│ │ ├── Default (active)
+│ │ ├── Nord
+│ │ ├── Dracula
+│ │ └── [Install Theme...]
+│ ├── Plugins
+│ │ ├── Translation Plugin (enabled) [Settings] [Disable]
+│ │ ├── PGP Encryption (disabled) [Enable] [Uninstall]
+│ │ └── [Install Plugin...]
+│ └── Developer
+│ └── [Load from local path...]
+```
+
+### 10.2 Plugin-Specific Settings
+
+Plugins declare their settings schema in `addon.json`. The app auto-generates a settings UI:
+
+```jsonc
+// In addon.json
+"settings": {
+ "provider": {
+ "type": "select",
+ "label": "Translation Provider",
+ "options": [
+ { "value": "deepl", "label": "DeepL" },
+ { "value": "google", "label": "Google Translate" }
+ ],
+ "default": "deepl"
+ },
+ "targetLanguage": {
+ "type": "select",
+ "label": "Default Target Language",
+ "options": "locales", // Special: populated from app locales
+ "default": "en"
+ },
+ "autoTranslate": {
+ "type": "boolean",
+ "label": "Auto-translate foreign emails",
+ "default": false
+ }
+}
+```
+
+Supported setting types: `string`, `boolean`, `number`, `select`, `multiselect`, `color`, `secret` (masked input).
+
+### 10.3 Theme Selector
+
+The existing Appearance settings page gains a theme gallery:
+
+```
+Appearance
+├── Theme: [Default ▾] ← dropdown with installed themes
+│ Preview: [████████████████] ← live color preview strip
+├── Mode: Light / Dark / System
+├── Font Size: Small / Medium / Large
+└── ...
+```
+
+When a theme is selected, the app:
+1. Sets `data-theme` attribute on ``.
+2. Loads the theme's CSS file.
+3. Persists the choice in `ThemeStore`.
+
+---
+
+## 11. API Surface
+
+### 11.1 Core Registry (`AddonRegistry`)
+
+```ts
+class AddonRegistry {
+ /** Register a slot for plugin component injection */
+ defineSlot(name: string, options?: SlotOptions): void;
+
+ /** Get all registrations for a slot */
+ getSlotRegistrations(name: string): SlotRegistration[];
+
+ /** Subscribe to slot changes (for reactive rendering) */
+ onSlotChange(name: string, cb: () => void): Disposable;
+
+ /** Emit a hook event to all listening plugins */
+ emitHook(event: string, payload: unknown): void;
+
+ /** Emit a hook event that plugins can modify (pipeline) */
+ emitHookPipeline(event: string, value: T): T;
+}
+```
+
+### 11.2 Hook Pipeline (Interceptors)
+
+Some hooks allow plugins to transform data flowing through them. For example, `email:compose:before-send` lets plugins modify the draft before it's sent:
+
+```ts
+// Plugin: auto-add disclaimer
+ctx.hooks.on("email:compose:before-send", (draft) => {
+ return {
+ ...draft,
+ htmlBody: draft.htmlBody + "
Sent from JMAP Webmail
",
+ };
+});
+```
+
+Pipeline hooks execute in priority order. If any handler throws, the pipeline is aborted and the action is cancelled (with a notification to the user).
+
+### 11.3 React Hooks for Addon Developers
+
+```ts
+// Available inside plugin components:
+
+/** Access the plugin's scoped context */
+usePluginContext(): PluginContext;
+
+/** Access plugin-specific settings (reactive) */
+usePluginConfig(key: string): [T, (value: T) => void];
+
+/** Access plugin's i18n */
+usePluginI18n(): { t: (key: string, params?: Record) => string };
+
+/** Access host app theme info */
+useHostTheme(): { mode: "light" | "dark"; resolvedMode: "light" | "dark" };
+```
+
+---
+
+## 12. Migration Path
+
+### Phase 1: Foundation
+
+- [ ] Define the complete `addon.json` schema with JSON Schema validation.
+- [ ] Create the `AddonManagerStore` (Zustand store for managing installed addons).
+- [ ] Extend `ThemeStore` with `activeTheme` and `data-theme` attribute management.
+- [ ] Implement CSS variable injection for themes.
+- [ ] Add 3–5 bundled themes (Nord, Dracula, Solarized, Catppuccin, High Contrast).
+- [ ] Add the theme selector to Settings → Appearance.
+
+### Phase 2: Plugin Infrastructure
+
+- [ ] Implement the `` component and `AddonErrorBoundary`.
+- [ ] Add `` insertion points to the 12 defined locations in the UI.
+- [ ] Build the `PluginContext` factory with permission-gated store access.
+- [ ] Implement the hook event system (`emitHook`, `emitHookPipeline`).
+- [ ] Create the Settings → Addons page with install/enable/disable/uninstall UI.
+- [ ] Implement auto-generated settings UI from plugin settings schema.
+
+### Phase 3: Developer Experience
+
+- [ ] Create `@jmap-webmail/addon-api` — TypeScript type definitions package.
+- [ ] Create `create-jmap-addon` CLI scaffolding tool.
+- [ ] Write addon developer documentation with examples.
+- [ ] Build a sample plugin (e.g., email translation) as a reference.
+- [ ] Add dev mode: hot-reload addons from local filesystem.
+
+### Phase 4: Hardening
+
+- [ ] Security audit of the sandboxing layer.
+- [ ] CSP header configuration for addon CSS/JS.
+- [ ] Rate limiting for hook events (prevent infinite loops).
+- [ ] Performance budgets: measure and enforce bundle size + render time limits.
+- [ ] Auto-disable addons that crash repeatedly.
+
+---
+
+## Appendix: Example Addons
+
+### A. Theme: "Nord"
+
+```
+nord-theme/
+├── addon.json
+├── theme.css
+└── preview.png
+```
+
+`addon.json`:
+```json
+{
+ "id": "org.nordtheme.jmap-webmail",
+ "name": "Nord",
+ "version": "1.0.0",
+ "type": "theme",
+ "description": "An arctic, north-bluish color palette.",
+ "author": { "name": "Arctic Ice Studio" },
+ "license": "MIT",
+ "engine": { "webmail": ">=1.0.0" },
+ "theme": {
+ "variables": "theme.css",
+ "presets": ["light", "dark"],
+ "preview": "preview.png"
+ }
+}
+```
+
+### B. Plugin: "Email Translator"
+
+```
+email-translator/
+├── addon.json
+├── dist/
+│ └── index.js
+└── locales/
+ ├── en.json
+ └── fr.json
+```
+
+`addon.json`:
+```json
+{
+ "id": "com.example.email-translator",
+ "name": "Email Translator",
+ "version": "1.0.0",
+ "type": "plugin",
+ "description": "Translate emails with one click.",
+ "author": { "name": "JMAP Community" },
+ "license": "MIT",
+ "engine": { "webmail": ">=1.0.0" },
+ "main": "dist/index.js",
+ "permissions": [
+ "emails:read",
+ "notifications",
+ "viewer:action",
+ "external-fetch"
+ ],
+ "allowedOrigins": ["https://api.deepl.com"],
+ "slots": ["viewer.actions"],
+ "settings": {
+ "apiKey": {
+ "type": "secret",
+ "label": "DeepL API Key"
+ },
+ "targetLanguage": {
+ "type": "select",
+ "label": "Target Language",
+ "options": "locales",
+ "default": "en"
+ }
+ },
+ "locales": "locales/"
+}
+```
+
+### C. Plugin: "Send Later"
+
+Adds a "Schedule Send" button to the composer:
+
+```ts
+export function activate(ctx: PluginContext) {
+ ctx.slots.register("compose.footer", {
+ component: ScheduleSendPicker,
+ priority: 10,
+ });
+
+ ctx.hooks.on("email:compose:before-send", (draft) => {
+ const scheduledTime = ctx.config.get("pendingSchedule");
+ if (scheduledTime) {
+ // Store the scheduled time — the host app handles deferred sending
+ return { ...draft, deliverAt: scheduledTime };
+ }
+ return draft;
+ });
+}
+```
+
+---
+
+## Open Questions
+
+1. **Should plugins be able to define new routes (pages)?** Adding full pages (e.g., `/addons/my-plugin/dashboard`) would require deeper Next.js integration. Could use a `navigation:tab` slot that renders a full-pane view instead.
+
+2. **Web Worker isolation?** Running plugin JS in a Web Worker would provide stronger isolation but prevents direct React rendering. A message-passing bridge is possible but adds complexity. Probably not worth it for v1.
+
+3. **Server-side plugins?** Some use cases (email filtering, webhook integrations) need server execution. This is out of scope for v1 but could be explored as Sieve filter generation or JMAP push notification handlers.
+
+4. **Addon signing?** For URL-installed addons, a signature verification system would prevent tampering. Worth considering for v2.
+
+5. **Shared dependencies?** Should plugins be able to declare peer dependencies on the host app's packages (React, date-fns, Lucide icons)? This would reduce bundle sizes but creates coupling. Recommend providing these as globals via the plugin runtime.
diff --git a/specifications/auth/rfc6570.pdf b/specifications/auth/rfc6570.pdf
new file mode 100644
index 00000000..76def4cc
Binary files /dev/null and b/specifications/auth/rfc6570.pdf differ
diff --git a/specifications/auth/rfc6570.txt b/specifications/auth/rfc6570.txt
new file mode 100644
index 00000000..12d5c0f9
--- /dev/null
+++ b/specifications/auth/rfc6570.txt
@@ -0,0 +1,1907 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) J. Gregorio
+Request for Comments: 6570 Google
+Category: Standards Track R. Fielding
+ISSN: 2070-1721 Adobe
+ M. Hadley
+ MITRE
+ M. Nottingham
+ Rackspace
+ D. Orchard
+ Salesforce.com
+ March 2012
+
+
+ URI Template
+
+Abstract
+
+ A URI Template is a compact sequence of characters for describing a
+ range of Uniform Resource Identifiers through variable expansion.
+ This specification defines the URI Template syntax and the process
+ for expanding a URI Template into a URI reference, along with
+ guidelines for the use of URI Templates on the Internet.
+
+Status of This Memo
+
+ This is an Internet Standards Track document.
+
+ This document is a product of the Internet Engineering Task Force
+ (IETF). It represents the consensus of the IETF community. It has
+ received public review and has been approved for publication by the
+ Internet Engineering Steering Group (IESG). Further information on
+ Internet Standards is available in Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6570.
+
+Copyright Notice
+
+ Copyright (c) 2012 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) in effect on the date of
+ publication of this document. Please review these documents
+ carefully, as they describe your rights and restrictions with respect
+ to this document. Code Components extracted from this document must
+
+
+
+Gregorio, et al. Standards Track [Page 1]
+
+RFC 6570 URI Template March 2012
+
+
+ include Simplified BSD License text as described in Section 4.e of
+ the Trust Legal Provisions and are provided without warranty as
+ described in the Simplified BSD License.
+
+Table of Contents
+
+ 1. Introduction ....................................................3
+ 1.1. Overview ...................................................3
+ 1.2. Levels and Expression Types ................................5
+ 1.3. Design Considerations ......................................9
+ 1.4. Limitations ...............................................10
+ 1.5. Notational Conventions ....................................11
+ 1.6. Character Encoding and Unicode Normalization ..............12
+ 2. Syntax .........................................................13
+ 2.1. Literals ..................................................13
+ 2.2. Expressions ...............................................13
+ 2.3. Variables .................................................14
+ 2.4. Value Modifiers ...........................................15
+ 2.4.1. Prefix Values ......................................15
+ 2.4.2. Composite Values ...................................16
+ 3. Expansion ......................................................18
+ 3.1. Literal Expansion .........................................18
+ 3.2. Expression Expansion ......................................18
+ 3.2.1. Variable Expansion .................................19
+ 3.2.2. Simple String Expansion: {var} .....................21
+ 3.2.3. Reserved Expansion: {+var} .........................22
+ 3.2.4. Fragment Expansion: {#var} .........................23
+ 3.2.5. Label Expansion with Dot-Prefix: {.var} ............24
+ 3.2.6. Path Segment Expansion: {/var} .....................24
+ 3.2.7. Path-Style Parameter Expansion: {;var} .............25
+ 3.2.8. Form-Style Query Expansion: {?var} .................26
+ 3.2.9. Form-Style Query Continuation: {&var} ..............27
+ 4. Security Considerations ........................................27
+ 5. Acknowledgments ................................................28
+ 6. References .....................................................28
+ 6.1. Normative References ......................................28
+ 6.2. Informative References ....................................29
+ Appendix A. Implementation Hints ..................................30
+
+
+
+
+
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 2]
+
+RFC 6570 URI Template March 2012
+
+
+1. Introduction
+
+1.1. Overview
+
+ A Uniform Resource Identifier (URI) [RFC3986] is often used to
+ identify a specific resource within a common space of similar
+ resources (informally, a "URI space"). For example, personal web
+ spaces are often delegated using a common pattern, such as
+
+ http://example.com/~fred/
+ http://example.com/~mark/
+
+ or a set of dictionary entries might be grouped in a hierarchy by the
+ first letter of the term, as in
+
+ http://example.com/dictionary/c/cat
+ http://example.com/dictionary/d/dog
+
+ or a service interface might be invoked with various user input in a
+ common pattern, as in
+
+ http://example.com/search?q=cat&lang=en
+ http://example.com/search?q=chien&lang=fr
+
+ A URI Template is a compact sequence of characters for describing a
+ range of Uniform Resource Identifiers through variable expansion.
+
+ URI Templates provide a mechanism for abstracting a space of resource
+ identifiers such that the variable parts can be easily identified and
+ described. URI Templates can have many uses, including the discovery
+ of available services, configuring resource mappings, defining
+ computed links, specifying interfaces, and other forms of
+ programmatic interaction with resources. For example, the above
+ resources could be described by the following URI Templates:
+
+ http://example.com/~{username}/
+ http://example.com/dictionary/{term:1}/{term}
+ http://example.com/search{?q,lang}
+
+ We define the following terms:
+
+ expression: The text between '{' and '}', including the enclosing
+ braces, as defined in Section 2.
+
+ expansion: The string result obtained from a template expression
+ after processing it according to its expression type, list of
+ variable names, and value modifiers, as defined in Section 3.
+
+
+
+
+Gregorio, et al. Standards Track [Page 3]
+
+RFC 6570 URI Template March 2012
+
+
+ template processor: A program or library that, given a URI Template
+ and a set of variables with values, transforms the template string
+ into a URI reference by parsing the template for expressions and
+ substituting each one with its corresponding expansion.
+
+ A URI Template provides both a structural description of a URI space
+ and, when variable values are provided, machine-readable instructions
+ on how to construct a URI corresponding to those values. A URI
+ Template is transformed into a URI reference by replacing each
+ delimited expression with its value as defined by the expression type
+ and the values of variables named within the expression. The
+ expression types range from simple string expansion to multiple
+ name=value lists. The expansions are based on the URI generic
+ syntax, allowing an implementation to process any URI Template
+ without knowing the scheme-specific requirements of every possible
+ resulting URI.
+
+ For example, the following URI Template includes a form-style
+ parameter expression, as indicated by the "?" operator appearing
+ before the variable names.
+
+ http://www.example.com/foo{?query,number}
+
+ The expansion process for expressions beginning with the question-
+ mark ("?") operator follows the same pattern as form-style interfaces
+ on the World Wide Web:
+
+ http://www.example.com/foo{?query,number}
+ \_____________/
+ |
+ |
+ For each defined variable in [ 'query', 'number' ],
+ substitute "?" if it is the first substitution or "&"
+ thereafter, followed by the variable name, '=', and the
+ variable's value.
+
+ If the variables have the values
+
+ query := "mycelium"
+ number := 100
+
+ then the expansion of the above URI Template is
+
+ http://www.example.com/foo?query=mycelium&number=100
+
+ Alternatively, if 'query' is undefined, then the expansion would be
+
+ http://www.example.com/foo?number=100
+
+
+
+Gregorio, et al. Standards Track [Page 4]
+
+RFC 6570 URI Template March 2012
+
+
+ or if both variables are undefined, then it would be
+
+ http://www.example.com/foo
+
+ A URI Template may be provided in absolute form, as in the examples
+ above, or in relative form. A template is expanded before the
+ resulting reference is resolved from relative to absolute form.
+
+ Although the URI syntax is used for the result, the template string
+ is allowed to contain the broader set of characters that can be found
+ in Internationalized Resource Identifier (IRI) references [RFC3987].
+ Therefore, a URI Template is also an IRI template, and the result of
+ template processing can be transformed to an IRI by following the
+ process defined in Section 3.2 of [RFC3987].
+
+1.2. Levels and Expression Types
+
+ URI Templates are similar to a macro language with a fixed set of
+ macro definitions: the expression type determines the expansion
+ process. The default expression type is simple string expansion,
+ wherein a single named variable is replaced by its value as a string
+ after pct-encoding any characters not in the set of unreserved URI
+ characters (Section 1.5).
+
+ Since most template processors implemented prior to this
+ specification have only implemented the default expression type, we
+ refer to these as Level 1 templates.
+
+ .-----------------------------------------------------------------.
+ | Level 1 examples, with variables having values of |
+ | |
+ | var := "value" |
+ | hello := "Hello World!" |
+ | |
+ |-----------------------------------------------------------------|
+ | Op Expression Expansion |
+ |-----------------------------------------------------------------|
+ | | Simple string expansion (Sec 3.2.2) |
+ | | |
+ | | {var} value |
+ | | {hello} Hello%20World%21 |
+ `-----------------------------------------------------------------'
+
+ Level 2 templates add the plus ("+") operator, for expansion of
+ values that are allowed to include reserved URI characters
+ (Section 1.5), and the crosshatch ("#") operator for expansion of
+ fragment identifiers.
+
+
+
+
+Gregorio, et al. Standards Track [Page 5]
+
+RFC 6570 URI Template March 2012
+
+
+ .-----------------------------------------------------------------.
+ | Level 2 examples, with variables having values of |
+ | |
+ | var := "value" |
+ | hello := "Hello World!" |
+ | path := "/foo/bar" |
+ | |
+ |-----------------------------------------------------------------|
+ | Op Expression Expansion |
+ |-----------------------------------------------------------------|
+ | + | Reserved string expansion (Sec 3.2.3) |
+ | | |
+ | | {+var} value |
+ | | {+hello} Hello%20World! |
+ | | {+path}/here /foo/bar/here |
+ | | here?ref={+path} here?ref=/foo/bar |
+ |-----+-----------------------------------------------------------|
+ | # | Fragment expansion, crosshatch-prefixed (Sec 3.2.4) |
+ | | |
+ | | X{#var} X#value |
+ | | X{#hello} X#Hello%20World! |
+ `-----------------------------------------------------------------'
+
+ Level 3 templates allow multiple variables per expression, each
+ separated by a comma, and add more complex operators for dot-prefixed
+ labels, slash-prefixed path segments, semicolon-prefixed path
+ parameters, and the form-style construction of a query syntax
+ consisting of name=value pairs that are separated by an ampersand
+ character.
+
+ .-----------------------------------------------------------------.
+ | Level 3 examples, with variables having values of |
+ | |
+ | var := "value" |
+ | hello := "Hello World!" |
+ | empty := "" |
+ | path := "/foo/bar" |
+ | x := "1024" |
+ | y := "768" |
+ | |
+ |-----------------------------------------------------------------|
+ | Op Expression Expansion |
+ |-----------------------------------------------------------------|
+ | | String expansion with multiple variables (Sec 3.2.2) |
+ | | |
+ | | map?{x,y} map?1024,768 |
+ | | {x,hello,y} 1024,Hello%20World%21,768 |
+ | | |
+
+
+
+Gregorio, et al. Standards Track [Page 6]
+
+RFC 6570 URI Template March 2012
+
+
+ |-----+-----------------------------------------------------------|
+ | + | Reserved expansion with multiple variables (Sec 3.2.3) |
+ | | |
+ | | {+x,hello,y} 1024,Hello%20World!,768 |
+ | | {+path,x}/here /foo/bar,1024/here |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | # | Fragment expansion with multiple variables (Sec 3.2.4) |
+ | | |
+ | | {#x,hello,y} #1024,Hello%20World!,768 |
+ | | {#path,x}/here #/foo/bar,1024/here |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | . | Label expansion, dot-prefixed (Sec 3.2.5) |
+ | | |
+ | | X{.var} X.value |
+ | | X{.x,y} X.1024.768 |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | / | Path segments, slash-prefixed (Sec 3.2.6) |
+ | | |
+ | | {/var} /value |
+ | | {/var,x}/here /value/1024/here |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | ; | Path-style parameters, semicolon-prefixed (Sec 3.2.7) |
+ | | |
+ | | {;x,y} ;x=1024;y=768 |
+ | | {;x,y,empty} ;x=1024;y=768;empty |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | ? | Form-style query, ampersand-separated (Sec 3.2.8) |
+ | | |
+ | | {?x,y} ?x=1024&y=768 |
+ | | {?x,y,empty} ?x=1024&y=768&empty= |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | & | Form-style query continuation (Sec 3.2.9) |
+ | | |
+ | | ?fixed=yes{&x} ?fixed=yes&x=1024 |
+ | | {&x,y,empty} &x=1024&y=768&empty= |
+ | | |
+ `-----------------------------------------------------------------'
+
+ Finally, Level 4 templates add value modifiers as an optional suffix
+ to each variable name. A prefix modifier (":") indicates that only a
+ limited number of characters from the beginning of the value are used
+ by the expansion (Section 2.4.1). An explode ("*") modifier
+
+
+
+Gregorio, et al. Standards Track [Page 7]
+
+RFC 6570 URI Template March 2012
+
+
+ indicates that the variable is to be treated as a composite value,
+ consisting of either a list of names or an associative array of
+ (name, value) pairs, that is expanded as if each member were a
+ separate variable (Section 2.4.2).
+
+ .-----------------------------------------------------------------.
+ | Level 4 examples, with variables having values of |
+ | |
+ | var := "value" |
+ | hello := "Hello World!" |
+ | path := "/foo/bar" |
+ | list := ("red", "green", "blue") |
+ | keys := [("semi",";"),("dot","."),("comma",",")] |
+ | |
+ | Op Expression Expansion |
+ |-----------------------------------------------------------------|
+ | | String expansion with value modifiers (Sec 3.2.2) |
+ | | |
+ | | {var:3} val |
+ | | {var:30} value |
+ | | {list} red,green,blue |
+ | | {list*} red,green,blue |
+ | | {keys} semi,%3B,dot,.,comma,%2C |
+ | | {keys*} semi=%3B,dot=.,comma=%2C |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | + | Reserved expansion with value modifiers (Sec 3.2.3) |
+ | | |
+ | | {+path:6}/here /foo/b/here |
+ | | {+list} red,green,blue |
+ | | {+list*} red,green,blue |
+ | | {+keys} semi,;,dot,.,comma,, |
+ | | {+keys*} semi=;,dot=.,comma=, |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | # | Fragment expansion with value modifiers (Sec 3.2.4) |
+ | | |
+ | | {#path:6}/here #/foo/b/here |
+ | | {#list} #red,green,blue |
+ | | {#list*} #red,green,blue |
+ | | {#keys} #semi,;,dot,.,comma,, |
+ | | {#keys*} #semi=;,dot=.,comma=, |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | . | Label expansion, dot-prefixed (Sec 3.2.5) |
+ | | |
+ | | X{.var:3} X.val |
+ | | X{.list} X.red,green,blue |
+
+
+
+Gregorio, et al. Standards Track [Page 8]
+
+RFC 6570 URI Template March 2012
+
+
+ | | X{.list*} X.red.green.blue |
+ | | X{.keys} X.semi,%3B,dot,.,comma,%2C |
+ | | X{.keys*} X.semi=%3B.dot=..comma=%2C |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | / | Path segments, slash-prefixed (Sec 3.2.6) |
+ | | |
+ | | {/var:1,var} /v/value |
+ | | {/list} /red,green,blue |
+ | | {/list*} /red/green/blue |
+ | | {/list*,path:4} /red/green/blue/%2Ffoo |
+ | | {/keys} /semi,%3B,dot,.,comma,%2C |
+ | | {/keys*} /semi=%3B/dot=./comma=%2C |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | ; | Path-style parameters, semicolon-prefixed (Sec 3.2.7) |
+ | | |
+ | | {;hello:5} ;hello=Hello |
+ | | {;list} ;list=red,green,blue |
+ | | {;list*} ;list=red;list=green;list=blue |
+ | | {;keys} ;keys=semi,%3B,dot,.,comma,%2C |
+ | | {;keys*} ;semi=%3B;dot=.;comma=%2C |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | ? | Form-style query, ampersand-separated (Sec 3.2.8) |
+ | | |
+ | | {?var:3} ?var=val |
+ | | {?list} ?list=red,green,blue |
+ | | {?list*} ?list=red&list=green&list=blue |
+ | | {?keys} ?keys=semi,%3B,dot,.,comma,%2C |
+ | | {?keys*} ?semi=%3B&dot=.&comma=%2C |
+ | | |
+ |-----+-----------------------------------------------------------|
+ | & | Form-style query continuation (Sec 3.2.9) |
+ | | |
+ | | {&var:3} &var=val |
+ | | {&list} &list=red,green,blue |
+ | | {&list*} &list=red&list=green&list=blue |
+ | | {&keys} &keys=semi,%3B,dot,.,comma,%2C |
+ | | {&keys*} &semi=%3B&dot=.&comma=%2C |
+ | | |
+ `-----------------------------------------------------------------'
+
+1.3. Design Considerations
+
+ Mechanisms similar to URI Templates have been defined within several
+ specifications, including WSDL [WSDL], WADL [WADL], and OpenSearch
+ [OpenSearch]. This specification extends and formally defines the
+
+
+
+Gregorio, et al. Standards Track [Page 9]
+
+RFC 6570 URI Template March 2012
+
+
+ syntax so that URI Templates can be used consistently across multiple
+ Internet applications and within Internet message fields, while at
+ the same time retaining compatibility with those earlier definitions.
+
+ The URI Template syntax has been designed to carefully balance the
+ need for a powerful expansion mechanism with the need for ease of
+ implementation. The syntax is designed to be trivial to parse while
+ at the same time providing enough flexibility to express many common
+ template scenarios. Implementations are able to parse the template
+ and perform the expansions in a single pass.
+
+ Templates are simple and readable when used with common examples
+ because the single-character operators match the URI generic syntax
+ delimiters. The operator's associated delimiter (".", ";", "/", "?",
+ "&", and "#") is omitted when none of the listed variables are
+ defined. Likewise, the expansion process for ";" (path-style
+ parameters) will omit the "=" when the variable value is empty,
+ whereas the process for "?" (form-style parameters) will not omit the
+ "=" when the value is empty. Multiple variables and list values have
+ their values joined with "," if there is no predefined joining
+ mechanism for the operator. The "+" and "#" operators will
+ substitute unencoded reserved characters found inside the variable
+ values; the other operators will pct-encode reserved characters found
+ in the variable values prior to expansion.
+
+ The most common cases for URI spaces can be described with Level 1
+ template expressions. If we were only concerned with URI generation,
+ then the template syntax could be limited to just simple variable
+ expansion, since more complex forms could be generated by changing
+ the variable values. However, URI Templates have the additional goal
+ of describing the layout of identifiers in terms of preexisting data
+ values. Therefore, the template syntax includes operators that
+ reflect how resource identifiers are commonly allocated. Likewise,
+ since prefix substrings are often used to partition large spaces of
+ resources, modifiers on variable values provide a way to specify both
+ the substring and the full value string with a single variable name.
+
+1.4. Limitations
+
+ Since a URI Template describes a superset of the identifiers, there
+ is no implication that every possible expansion for each delimited
+ variable expression corresponds to a URI of an existing resource.
+ Our expectation is that an application constructing URIs according to
+ the template will be provided with an appropriate set of values for
+ the variables being substituted, or at least a means of validating
+ user data-entry for those values.
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 10]
+
+RFC 6570 URI Template March 2012
+
+
+ URI Templates are not URIs: they do not identify an abstract or
+ physical resource, they are not parsed as URIs, and they should not
+ be used in places where a URI would be expected unless the template
+ expressions will be expanded by a template processor prior to use.
+ Distinct field, element, or attribute names should be used to
+ differentiate protocol elements that carry a URI Template from those
+ that expect a URI reference.
+
+ Some URI Templates can be used in reverse for the purpose of variable
+ matching: comparing the template to a fully formed URI in order to
+ extract the variable parts from that URI and assign them to the named
+ variables. Variable matching only works well if the template
+ expressions are delimited by the beginning or end of the URI or by
+ characters that cannot be part of the expansion, such as reserved
+ characters surrounding a simple string expression. In general,
+ regular expression languages are better suited for variable matching.
+
+1.5. Notational Conventions
+
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
+ document are to be interpreted as described in [RFC2119].
+
+ This specification uses the Augmented Backus-Naur Form (ABNF)
+ notation of [RFC5234]. The following ABNF rules are imported from
+ the normative references [RFC5234], [RFC3986], and [RFC3987].
+
+ ALPHA = %x41-5A / %x61-7A ; A-Z / a-z
+ DIGIT = %x30-39 ; 0-9
+ HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F"
+ ; case-insensitive
+
+ pct-encoded = "%" HEXDIG HEXDIG
+ unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ reserved = gen-delims / sub-delims
+ gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
+ sub-delims = "!" / "$" / "&" / "'" / "(" / ")"
+ / "*" / "+" / "," / ";" / "="
+
+ ucschar = %xA0-D7FF / %xF900-FDCF / %xFDF0-FFEF
+ / %x10000-1FFFD / %x20000-2FFFD / %x30000-3FFFD
+ / %x40000-4FFFD / %x50000-5FFFD / %x60000-6FFFD
+ / %x70000-7FFFD / %x80000-8FFFD / %x90000-9FFFD
+ / %xA0000-AFFFD / %xB0000-BFFFD / %xC0000-CFFFD
+ / %xD0000-DFFFD / %xE1000-EFFFD
+
+ iprivate = %xE000-F8FF / %xF0000-FFFFD / %x100000-10FFFD
+
+
+
+
+Gregorio, et al. Standards Track [Page 11]
+
+RFC 6570 URI Template March 2012
+
+
+1.6. Character Encoding and Unicode Normalization
+
+ This specification uses the terms "character", "character encoding
+ scheme", "code point", "coded character set", "glyph", "non-ASCII",
+ "normalization", "protocol element", and "regular expression" as they
+ are defined in [RFC6365].
+
+ The ABNF notation defines its terminal values to be non-negative
+ integers (code points) that are a superset of the US-ASCII coded
+ character set [ASCII]. This specification defines terminal values as
+ code points within the Unicode coded character set [UNIV6].
+
+ In spite of the syntax and template expansion process being defined
+ in terms of Unicode code points, it should be understood that
+ templates occur in practice as a sequence of characters in whatever
+ form or encoding is suitable for the context in which they occur,
+ whether that be octets embedded in a network protocol element or
+ glyphs painted on the side of a bus. This specification does not
+ mandate any particular character encoding scheme for mapping between
+ URI Template characters and the octets used to store or transmit
+ those characters. When a URI Template appears in a protocol element,
+ the character encoding scheme is defined by that protocol; without
+ such a definition, a URI Template is assumed to be in the same
+ character encoding scheme as the surrounding text. It is only during
+ the process of template expansion that a string of characters in a
+ URI Template is REQUIRED to be processed as a sequence of Unicode
+ code points.
+
+ The Unicode Standard [UNIV6] defines various equivalences between
+ sequences of characters for various purposes. Unicode Standard Annex
+ #15 [UTR15] defines various Normalization Forms for these
+ equivalences. The normalization form determines how to consistently
+ encode equivalent strings. In theory, all URI processing
+ implementations, including template processors, should use the same
+ normalization form for generating a URI reference. In practice, they
+ do not. If a value has been provided by the same server as the
+ resource, then it can be assumed that the string is already in the
+ form expected by that server. If a value is provided by a user, such
+ as via a data-entry dialog, then the string SHOULD be normalized as
+ Normalization Form C (NFC: Canonical Decomposition, followed by
+ Canonical Composition) prior to being used in expansions by a
+ template processor.
+
+ Likewise, when non-ASCII data that represents readable strings is
+ pct-encoded for use in a URI reference, a template processor MUST
+ first encode the string as UTF-8 [RFC3629] and then pct-encode any
+ octets that are not allowed in a URI reference.
+
+
+
+
+Gregorio, et al. Standards Track [Page 12]
+
+RFC 6570 URI Template March 2012
+
+
+2. Syntax
+
+ A URI Template is a string of printable Unicode characters that
+ contains zero or more embedded variable expressions, each expression
+ being delimited by a matching pair of braces ('{', '}').
+
+ URI-Template = *( literals / expression )
+
+ Although templates (and template processor implementations) are
+ described above in terms of four gradual levels, we define the URI-
+ Template syntax in terms of the ABNF for Level 4. A template
+ processor limited to lower-level templates MAY exclude the ABNF rules
+ applicable only to higher levels. However, it is RECOMMENDED that
+ all parsers implement the full syntax such that unsupported levels
+ can be properly identified as such to the end user.
+
+2.1. Literals
+
+ The characters outside of expressions in a URI Template string are
+ intended to be copied literally to the URI reference if the character
+ is allowed in a URI (reserved / unreserved / pct-encoded) or, if not
+ allowed, copied to the URI reference as the sequence of pct-encoded
+ triplets corresponding to that character's encoding in UTF-8
+ [RFC3629].
+
+ literals = %x21 / %x23-24 / %x26 / %x28-3B / %x3D / %x3F-5B
+ / %x5D / %x5F / %x61-7A / %x7E / ucschar / iprivate
+ / pct-encoded
+ ; any Unicode character except: CTL, SP,
+ ; DQUOTE, "'", "%" (aside from pct-encoded),
+ ; "<", ">", "\", "^", "`", "{", "|", "}"
+
+2.2. Expressions
+
+ Template expressions are the parameterized parts of a URI Template.
+ Each expression contains an optional operator, which defines the
+ expression type and its corresponding expansion process, followed by
+ a comma-separated list of variable specifiers (variable names and
+ optional value modifiers). If no operator is provided, the
+ expression defaults to simple variable expansion of unreserved
+ values.
+
+ expression = "{" [ operator ] variable-list "}"
+ operator = op-level2 / op-level3 / op-reserve
+ op-level2 = "+" / "#"
+ op-level3 = "." / "/" / ";" / "?" / "&"
+ op-reserve = "=" / "," / "!" / "@" / "|"
+
+
+
+
+Gregorio, et al. Standards Track [Page 13]
+
+RFC 6570 URI Template March 2012
+
+
+ The operator characters have been chosen to reflect each of their
+ roles as reserved characters in the URI generic syntax. The
+ operators defined in Section 3 of this specification include:
+
+ + Reserved character strings;
+
+ # Fragment identifiers prefixed by "#";
+
+ . Name labels or extensions prefixed by ".";
+
+ / Path segments prefixed by "/";
+
+ ; Path parameter name or name=value pairs prefixed by ";";
+
+ ? Query component beginning with "?" and consisting of
+ name=value pairs separated by "&"; and,
+
+ & Continuation of query-style &name=value pairs within
+ a literal query component.
+
+ The operator characters equals ("="), comma (","), exclamation ("!"),
+ at sign ("@"), and pipe ("|") are reserved for future extensions.
+
+ The expression syntax specifically excludes use of the dollar ("$")
+ and parentheses ["(" and ")"] characters so that they remain
+ available for use outside the scope of this specification. For
+ example, a macro language might use these characters to apply macro
+ substitution to a string prior to that string being processed as a
+ URI Template.
+
+2.3. Variables
+
+ After the operator (if any), each expression contains a list of one
+ or more comma-separated variable specifiers (varspec). The variable
+ names serve multiple purposes: documentation for what kinds of values
+ are expected, identifiers for associating values within a template
+ processor, and the literal string to use for the name in name=value
+ expansions (aside from when exploding an associative array).
+ Variable names are case-sensitive because the name might be expanded
+ within a case-sensitive URI component.
+
+ variable-list = varspec *( "," varspec )
+ varspec = varname [ modifier-level4 ]
+ varname = varchar *( ["."] varchar )
+ varchar = ALPHA / DIGIT / "_" / pct-encoded
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 14]
+
+RFC 6570 URI Template March 2012
+
+
+ A varname MAY contain one or more pct-encoded triplets. These
+ triplets are considered an essential part of the variable name and
+ are not decoded during processing. A varname containing pct-encoded
+ characters is not the same variable as a varname with those same
+ characters decoded. Applications that provide URI Templates are
+ expected to be consistent in their use of pct-encoding within
+ variable names.
+
+ An expression MAY reference variables that are unknown to the
+ template processor or whose value is set to a special "undefined"
+ value, such as undef or null. Such undefined variables are given
+ special treatment by the expansion process (Section 3.2.1).
+
+ A variable value that is a string of length zero is not considered
+ undefined; it has the defined value of an empty string.
+
+ In Level 4 templates, a variable may have a composite value in the
+ form of a list of values or an associative array of (name, value)
+ pairs. Such value types are not directly indicated by the template
+ syntax, but they do have an impact on the expansion process
+ (Section 3.2.1).
+
+ A variable defined as a list value is considered undefined if the
+ list contains zero members. A variable defined as an associative
+ array of (name, value) pairs is considered undefined if the array
+ contains zero members or if all member names in the array are
+ associated with undefined values.
+
+2.4. Value Modifiers
+
+ Each of the variables in a Level 4 template expression can have a
+ modifier indicating either that its expansion is limited to a prefix
+ of the variable's value string or that its expansion is exploded as a
+ composite value in the form of a value list or an associative array
+ of (name, value) pairs.
+
+ modifier-level4 = prefix / explode
+
+2.4.1. Prefix Values
+
+ A prefix modifier indicates that the variable expansion is limited to
+ a prefix of the variable's value string. Prefix modifiers are often
+ used to partition an identifier space hierarchically, as is common in
+ reference indices and hash-based storage. It also serves to limit
+ the expanded value to a maximum number of characters. Prefix
+ modifiers are not applicable to variables that have composite values.
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 15]
+
+RFC 6570 URI Template March 2012
+
+
+ prefix = ":" max-length
+ max-length = %x31-39 0*3DIGIT ; positive integer < 10000
+
+ The max-length is a positive integer that refers to a maximum number
+ of characters from the beginning of the variable's value as a Unicode
+ string. Note that this numbering is in characters, not octets, in
+ order to avoid splitting between the octets of a multi-octet-encoded
+ character or within a pct-encoded triplet. If the max-length is
+ greater than the length of the variable's value, then the entire
+ value string is used.
+
+ For example,
+
+ Given the variable assignments
+
+ var := "value"
+ semi := ";"
+
+ Example Template Expansion
+
+ {var} value
+ {var:20} value
+ {var:3} val
+ {semi} %3B
+ {semi:2} %3B
+
+2.4.2. Composite Values
+
+ An explode ("*") modifier indicates that the variable is to be
+ treated as a composite value consisting of either a list of values or
+ an associative array of (name, value) pairs. Hence, the expansion
+ process is applied to each member of the composite as if it were
+ listed as a separate variable. This kind of variable specification
+ is significantly less self-documenting than non-exploded variables,
+ since there is less correspondence between the variable name and how
+ the URI reference appears after expansion.
+
+ explode = "*"
+
+ Since URI Templates do not contain an indication of type or schema,
+ the type for an exploded variable is assumed to be determined by
+ context. For example, the processor might be supplied values in a
+ form that differentiates values as strings, lists, or associative
+ arrays. Likewise, the context in which the template is used (script,
+ mark-up language, Interface Definition Language, etc.) might define
+ rules for associating variable names with types, structures, or
+ schema.
+
+
+
+
+Gregorio, et al. Standards Track [Page 16]
+
+RFC 6570 URI Template March 2012
+
+
+ Explode modifiers improve brevity in the URI Template syntax. For
+ example, a resource that provides a geographic map for a given street
+ address might accept a hundred permutations on fields for address
+ input, including partial addresses (e.g., just the city or postal
+ code). Such a resource could be described as a template with each
+ and every address component listed in order, or with a far more
+ simple template that makes use of an explode modifier, as in
+
+ /mapper{?address*}
+
+ along with some context that defines what the variable named
+ "address" can include, such as by reference to some other standard
+ for addressing (e.g., [UPU-S42]). A recipient aware of the schema
+ can then provide appropriate expansions, such as:
+
+ /mapper?city=Newport%20Beach&state=CA
+
+ The expansion process for exploded variables is dependent on both the
+ operator being used and whether the composite value is to be treated
+ as a list of values or as an associative array of (name, value)
+ pairs. Structures are processed as if they are an associative array
+ with names corresponding to the fields in the structure definition
+ and "." separators used to indicate name hierarchy in substructures.
+
+ If a variable has a composite structure and only some of the fields
+ in that structure have defined values, then only the defined pairs
+ are present in the expansion. This can be useful for templates that
+ consist of a large number of potential query terms.
+
+ An explode modifier applied to a list variable causes the expansion
+ to iterate over the list's member values. For path and query
+ parameter expansions, each member value is paired with the variable's
+ name as a (varname, value) pair. This allows path and query
+ parameters to be repeated for multiple values, as in
+
+ Given the variable assignments
+
+ year := ("1965", "2000", "2012")
+ dom := ("example", "com")
+
+ Example Template Expansion
+
+ find{?year*} find?year=1965&year=2000&year=2012
+ www{.dom*} www.example.com
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 17]
+
+RFC 6570 URI Template March 2012
+
+
+3. Expansion
+
+ The process of URI Template expansion is to scan the template string
+ from beginning to end, copying literal characters and replacing each
+ expression with the result of applying the expression's operator to
+ the value of each variable named in the expression. Each variable's
+ value MUST be formed prior to template expansion.
+
+ The requirements on expansion for each aspect of the URI Template
+ grammar are defined in this section. A non-normative algorithm for
+ the expansion process as a whole is provided in Appendix A.
+
+ If a template processor encounters a character sequence outside an
+ expression that does not match the grammar, then
+ processing of the template SHOULD cease, the URI reference result
+ SHOULD contain the expanded part of the template followed by the
+ remainder unexpanded, and the location and type of error SHOULD be
+ indicated to the invoking application.
+
+ If an error is encountered in an expression, such as an operator or
+ value modifier that the template processor does not recognize or does
+ not yet support, or a character is found that is not allowed by the
+ grammar, then the unprocessed parts of the expression
+ SHOULD be copied to the result unexpanded, processing of the
+ remainder of the template SHOULD continue, and the location and type
+ of error SHOULD be indicated to the invoking application.
+
+ If an error occurs, the result returned might not be a valid URI
+ reference; it will be an incompletely expanded template string that
+ is only intended for diagnostic use.
+
+3.1. Literal Expansion
+
+ If the literal character is allowed anywhere in the URI syntax
+ (unreserved / reserved / pct-encoded ), then it is copied directly to
+ the result string. Otherwise, the pct-encoded equivalent of the
+ literal character is copied to the result string by first encoding
+ the character as its sequence of octets in UTF-8 and then encoding
+ each such octet as a pct-encoded triplet.
+
+3.2. Expression Expansion
+
+ Each expression is indicated by an opening brace ("{") character and
+ continues until the next closing brace ("}"). Expressions cannot be
+ nested.
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 18]
+
+RFC 6570 URI Template March 2012
+
+
+ An expression is expanded by determining its expression type and then
+ following that type's expansion process for each comma-separated
+ varspec in the expression. Level 1 templates are limited to the
+ default operator (simple string value expansion) and a single
+ variable per expression. Level 2 templates are limited to a single
+ varspec per expression.
+
+ The expression type is determined by looking at the first character
+ after the opening brace. If the character is an operator, then
+ remember the expression type associated with that operator for later
+ expansion decisions and skip to the next character for the variable-
+ list. If the first character is not an operator, then the expression
+ type is simple string expansion and the first character is the
+ beginning of the variable-list.
+
+ The examples in the subsections below use the following definitions
+ for variable values:
+
+ count := ("one", "two", "three")
+ dom := ("example", "com")
+ dub := "me/too"
+ hello := "Hello World!"
+ half := "50%"
+ var := "value"
+ who := "fred"
+ base := "http://example.com/home/"
+ path := "/foo/bar"
+ list := ("red", "green", "blue")
+ keys := [("semi",";"),("dot","."),("comma",",")]
+ v := "6"
+ x := "1024"
+ y := "768"
+ empty := ""
+ empty_keys := []
+ undef := null
+
+3.2.1. Variable Expansion
+
+ A variable that is undefined (Section 2.3) has no value and is
+ ignored by the expansion process. If all of the variables in an
+ expression are undefined, then the expression's expansion is the
+ empty string.
+
+ Variable expansion of a defined, non-empty value results in a
+ substring of allowed URI characters. As described in Section 1.6,
+ the expansion process is defined in terms of Unicode code points in
+ order to ensure that non-ASCII characters are consistently pct-
+ encoded in the resulting URI reference. One way for a template
+
+
+
+Gregorio, et al. Standards Track [Page 19]
+
+RFC 6570 URI Template March 2012
+
+
+ processor to obtain a consistent expansion is to transcode the value
+ string to UTF-8 (if it is not already in UTF-8) and then transform
+ each octet that is not in the allowed set into the corresponding pct-
+ encoded triplet. Another is to map directly from the value's native
+ character encoding to the set of allowed URI characters, with any
+ remaining disallowed characters mapping to the sequence of pct-
+ encoded triplets that correspond to the octet(s) of that character
+ when encoded as UTF-8 [RFC3629].
+
+ The allowed set for a given expansion depends on the expression type:
+ reserved ("+") and fragment ("#") expansions allow the set of
+ characters in the union of ( unreserved / reserved / pct-encoded ) to
+ be passed through without pct-encoding, whereas all other expression
+ types allow only unreserved characters to be passed through without
+ pct-encoding. Note that the percent character ("%") is only allowed
+ as part of a pct-encoded triplet and only for reserved/fragment
+ expansion: in all other cases, a value character of "%" MUST be pct-
+ encoded as "%25" by variable expansion.
+
+ If a variable appears more than once in an expression or within
+ multiple expressions of a URI Template, the value of that variable
+ MUST remain static throughout the expansion process (i.e., the
+ variable must have the same value for the purpose of calculating each
+ expansion). However, if reserved characters or pct-encoded triplets
+ occur in the value, they will be pct-encoded by some expression types
+ and not by others.
+
+ For a variable that is a simple string value, expansion consists of
+ appending the encoded value to the result string. An explode
+ modifier has no effect. A prefix modifier limits the expansion to
+ the first max-length characters of the decoded value. If the value
+ contains multi-octet or pct-encoded characters, care must be taken to
+ avoid splitting the value in mid-character: count each Unicode code
+ point as one character.
+
+ For a variable that is an associative array, expansion depends on
+ both the expression type and the presence of an explode modifier. If
+ there is no explode modifier, expansion consists of appending a
+ comma-separated concatenation of each (name, value) pair that has a
+ defined value. If there is an explode modifier, expansion consists
+ of appending each pair that has a defined value as either
+ "name=value" or, if the value is the empty string and the expression
+ type does not indicate form-style parameters (i.e., not a "?" or "&"
+ type), simply "name". Both name and value strings are encoded in the
+ same way as simple string values. A separator string is appended
+ between defined pairs according to the expression type, as defined by
+ the following table:
+
+
+
+
+Gregorio, et al. Standards Track [Page 20]
+
+RFC 6570 URI Template March 2012
+
+
+ Type Separator
+ "," (default)
+ + ","
+ # ","
+ . "."
+ / "/"
+ ; ";"
+ ? "&"
+ & "&"
+
+ For a variable that is a list of values, expansion depends on both
+ the expression type and the presence of an explode modifier. If
+ there is no explode modifier, the expansion consists of a comma-
+ separated concatenation of the defined member string values. If
+ there is an explode modifier and the expression type expands named
+ parameters (";", "?", or "&"), then the list is expanded as if it
+ were an associative array in which each member value is paired with
+ the list's varname. Otherwise, the value will be expanded as if it
+ were a list of separate variable values, each value separated by the
+ expression type's associated separator as defined by the table above.
+
+ Example Template Expansion
+
+ {count} one,two,three
+ {count*} one,two,three
+ {/count} /one,two,three
+ {/count*} /one/two/three
+ {;count} ;count=one,two,three
+ {;count*} ;count=one;count=two;count=three
+ {?count} ?count=one,two,three
+ {?count*} ?count=one&count=two&count=three
+ {&count*} &count=one&count=two&count=three
+
+3.2.2. Simple String Expansion: {var}
+
+ Simple string expansion is the default expression type when no
+ operator is given.
+
+ For each defined variable in the variable-list, perform variable
+ expansion, as defined in Section 3.2.1, with the allowed characters
+ being those in the unreserved set. If more than one variable has a
+ defined value, append a comma (",") to the result string as a
+ separator between variable expansions.
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 21]
+
+RFC 6570 URI Template March 2012
+
+
+ Example Template Expansion
+
+ {var} value
+ {hello} Hello%20World%21
+ {half} 50%25
+ O{empty}X OX
+ O{undef}X OX
+ {x,y} 1024,768
+ {x,hello,y} 1024,Hello%20World%21,768
+ ?{x,empty} ?1024,
+ ?{x,undef} ?1024
+ ?{undef,y} ?768
+ {var:3} val
+ {var:30} value
+ {list} red,green,blue
+ {list*} red,green,blue
+ {keys} semi,%3B,dot,.,comma,%2C
+ {keys*} semi=%3B,dot=.,comma=%2C
+
+3.2.3. Reserved Expansion: {+var}
+
+ Reserved expansion, as indicated by the plus ("+") operator for Level
+ 2 and above templates, is identical to simple string expansion except
+ that the substituted values may also contain pct-encoded triplets and
+ characters in the reserved set.
+
+ For each defined variable in the variable-list, perform variable
+ expansion, as defined in Section 3.2.1, with the allowed characters
+ being those in the set (unreserved / reserved / pct-encoded). If
+ more than one variable has a defined value, append a comma (",") to
+ the result string as a separator between variable expansions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 22]
+
+RFC 6570 URI Template March 2012
+
+
+ Example Template Expansion
+
+ {+var} value
+ {+hello} Hello%20World!
+ {+half} 50%25
+
+ {base}index http%3A%2F%2Fexample.com%2Fhome%2Findex
+ {+base}index http://example.com/home/index
+ O{+empty}X OX
+ O{+undef}X OX
+
+ {+path}/here /foo/bar/here
+ here?ref={+path} here?ref=/foo/bar
+ up{+path}{var}/here up/foo/barvalue/here
+ {+x,hello,y} 1024,Hello%20World!,768
+ {+path,x}/here /foo/bar,1024/here
+
+ {+path:6}/here /foo/b/here
+ {+list} red,green,blue
+ {+list*} red,green,blue
+ {+keys} semi,;,dot,.,comma,,
+ {+keys*} semi=;,dot=.,comma=,
+
+3.2.4. Fragment Expansion: {#var}
+
+ Fragment expansion, as indicated by the crosshatch ("#") operator for
+ Level 2 and above templates, is identical to reserved expansion
+ except that a crosshatch character (fragment delimiter) is appended
+ first to the result string if any of the variables are defined.
+
+ Example Template Expansion
+
+ {#var} #value
+ {#hello} #Hello%20World!
+ {#half} #50%25
+ foo{#empty} foo#
+ foo{#undef} foo
+ {#x,hello,y} #1024,Hello%20World!,768
+ {#path,x}/here #/foo/bar,1024/here
+ {#path:6}/here #/foo/b/here
+ {#list} #red,green,blue
+ {#list*} #red,green,blue
+ {#keys} #semi,;,dot,.,comma,,
+ {#keys*} #semi=;,dot=.,comma=,
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 23]
+
+RFC 6570 URI Template March 2012
+
+
+3.2.5. Label Expansion with Dot-Prefix: {.var}
+
+ Label expansion, as indicated by the dot (".") operator for Level 3
+ and above templates, is useful for describing URI spaces with varying
+ domain names or path selectors (e.g., filename extensions).
+
+ For each defined variable in the variable-list, append "." to the
+ result string and then perform variable expansion, as defined in
+ Section 3.2.1, with the allowed characters being those in the
+ unreserved set.
+
+ Since "." is in the unreserved set, a value that contains a "." has
+ the effect of adding multiple labels.
+
+ Example Template Expansion
+
+ {.who} .fred
+ {.who,who} .fred.fred
+ {.half,who} .50%25.fred
+ www{.dom*} www.example.com
+ X{.var} X.value
+ X{.empty} X.
+ X{.undef} X
+ X{.var:3} X.val
+ X{.list} X.red,green,blue
+ X{.list*} X.red.green.blue
+ X{.keys} X.semi,%3B,dot,.,comma,%2C
+ X{.keys*} X.semi=%3B.dot=..comma=%2C
+ X{.empty_keys} X
+ X{.empty_keys*} X
+
+3.2.6. Path Segment Expansion: {/var}
+
+ Path segment expansion, as indicated by the slash ("/") operator in
+ Level 3 and above templates, is useful for describing URI path
+ hierarchies.
+
+ For each defined variable in the variable-list, append "/" to the
+ result string and then perform variable expansion, as defined in
+ Section 3.2.1, with the allowed characters being those in the
+ unreserved set.
+
+ Note that the expansion process for path segment expansion is
+ identical to that of label expansion aside from the substitution of
+ "/" instead of ".". However, unlike ".", a "/" is a reserved
+ character and will be pct-encoded if found in a value.
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 24]
+
+RFC 6570 URI Template March 2012
+
+
+ Example Template Expansion
+
+ {/who} /fred
+ {/who,who} /fred/fred
+ {/half,who} /50%25/fred
+ {/who,dub} /fred/me%2Ftoo
+ {/var} /value
+ {/var,empty} /value/
+ {/var,undef} /value
+ {/var,x}/here /value/1024/here
+ {/var:1,var} /v/value
+ {/list} /red,green,blue
+ {/list*} /red/green/blue
+ {/list*,path:4} /red/green/blue/%2Ffoo
+ {/keys} /semi,%3B,dot,.,comma,%2C
+ {/keys*} /semi=%3B/dot=./comma=%2C
+
+3.2.7. Path-Style Parameter Expansion: {;var}
+
+ Path-style parameter expansion, as indicated by the semicolon (";")
+ operator in Level 3 and above templates, is useful for describing URI
+ path parameters, such as "path;property" or "path;name=value".
+
+ For each defined variable in the variable-list:
+
+ o append ";" to the result string;
+
+ o if the variable has a simple string value or no explode modifier
+ is given, then:
+
+ * append the variable name (encoded as if it were a literal
+ string) to the result string;
+
+ * if the variable's value is not empty, append "=" to the result
+ string;
+
+ o perform variable expansion, as defined in Section 3.2.1, with the
+ allowed characters being those in the unreserved set.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 25]
+
+RFC 6570 URI Template March 2012
+
+
+ Example Template Expansion
+
+ {;who} ;who=fred
+ {;half} ;half=50%25
+ {;empty} ;empty
+ {;v,empty,who} ;v=6;empty;who=fred
+ {;v,bar,who} ;v=6;who=fred
+ {;x,y} ;x=1024;y=768
+ {;x,y,empty} ;x=1024;y=768;empty
+ {;x,y,undef} ;x=1024;y=768
+ {;hello:5} ;hello=Hello
+ {;list} ;list=red,green,blue
+ {;list*} ;list=red;list=green;list=blue
+ {;keys} ;keys=semi,%3B,dot,.,comma,%2C
+ {;keys*} ;semi=%3B;dot=.;comma=%2C
+
+3.2.8. Form-Style Query Expansion: {?var}
+
+ Form-style query expansion, as indicated by the question-mark ("?")
+ operator in Level 3 and above templates, is useful for describing an
+ entire optional query component.
+
+ For each defined variable in the variable-list:
+
+ o append "?" to the result string if this is the first defined value
+ or append "&" thereafter;
+
+ o if the variable has a simple string value or no explode modifier
+ is given, append the variable name (encoded as if it were a
+ literal string) and an equals character ("=") to the result
+ string; and,
+
+ o perform variable expansion, as defined in Section 3.2.1, with the
+ allowed characters being those in the unreserved set.
+
+
+ Example Template Expansion
+
+ {?who} ?who=fred
+ {?half} ?half=50%25
+ {?x,y} ?x=1024&y=768
+ {?x,y,empty} ?x=1024&y=768&empty=
+ {?x,y,undef} ?x=1024&y=768
+ {?var:3} ?var=val
+ {?list} ?list=red,green,blue
+ {?list*} ?list=red&list=green&list=blue
+ {?keys} ?keys=semi,%3B,dot,.,comma,%2C
+ {?keys*} ?semi=%3B&dot=.&comma=%2C
+
+
+
+Gregorio, et al. Standards Track [Page 26]
+
+RFC 6570 URI Template March 2012
+
+
+3.2.9. Form-Style Query Continuation: {&var}
+
+ Form-style query continuation, as indicated by the ampersand ("&")
+ operator in Level 3 and above templates, is useful for describing
+ optional &name=value pairs in a template that already contains a
+ literal query component with fixed parameters.
+
+ For each defined variable in the variable-list:
+
+ o append "&" to the result string;
+
+ o if the variable has a simple string value or no explode modifier
+ is given, append the variable name (encoded as if it were a
+ literal string) and an equals character ("=") to the result
+ string; and,
+
+ o perform variable expansion, as defined in Section 3.2.1, with the
+ allowed characters being those in the unreserved set.
+
+
+ Example Template Expansion
+
+ {&who} &who=fred
+ {&half} &half=50%25
+ ?fixed=yes{&x} ?fixed=yes&x=1024
+ {&x,y,empty} &x=1024&y=768&empty=
+ {&x,y,undef} &x=1024&y=768
+
+ {&var:3} &var=val
+ {&list} &list=red,green,blue
+ {&list*} &list=red&list=green&list=blue
+ {&keys} &keys=semi,%3B,dot,.,comma,%2C
+ {&keys*} &semi=%3B&dot=.&comma=%2C
+
+4. Security Considerations
+
+ A URI Template does not contain active or executable content.
+ However, it might be possible to craft unanticipated URIs if an
+ attacker is given control over the template or over the variable
+ values within an expression that allows reserved characters in the
+ expansion. In either case, the security considerations are largely
+ determined by who provides the template, who provides the values to
+ use for variables within the template, in what execution context the
+ expansion occurs (client or server), and where the resulting URIs are
+ used.
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 27]
+
+RFC 6570 URI Template March 2012
+
+
+ This specification does not limit where URI Templates might be used.
+ Current implementations exist within server-side development
+ frameworks and within client-side javascript for computed links or
+ forms.
+
+ Within frameworks, templates usually act as guides for where data
+ might occur within later (request-time) URIs in client requests.
+ Hence, the security concerns are not in the templates themselves, but
+ rather in how the server extracts and processes the user-provided
+ data within a normal Web request.
+
+ Within client-side implementations, a URI Template has many of the
+ same properties as HTML forms, except limited to URI characters and
+ possibly included in HTTP header field values instead of just message
+ body content. Care ought to be taken to ensure that potentially
+ dangerous URI reference strings, such as those beginning with
+ "javascript:", do not appear in the expansion unless both the
+ template and the values are provided by a trusted source.
+
+ Other security considerations are the same as those for URIs, as
+ described in Section 7 of [RFC3986].
+
+5. Acknowledgments
+
+ The following people made contributions to this specification: Mike
+ Burrows, Michaeljohn Clement, DeWitt Clinton, John Cowan, Stephen
+ Farrell, Robbie Gates, Vijay K. Gurbani, Peter Johanson, Murray S.
+ Kucherawy, James H. Manger, Tom Petch, Marc Portier, Pete Resnick,
+ James Snell, and Jiankang Yao.
+
+6. References
+
+6.1. Normative References
+
+ [ASCII] American National Standards Institute, "Coded Character
+ Set - 7-bit American Standard Code for Information
+ Interchange", ANSI X3.4, 1986.
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
+ 10646", STD 63, RFC 3629, November 2003.
+
+ [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter,
+ "Uniform Resource Identifier (URI): Generic Syntax",
+ STD 66, RFC 3986, January 2005.
+
+
+
+
+Gregorio, et al. Standards Track [Page 28]
+
+RFC 6570 URI Template March 2012
+
+
+ [RFC3987] Duerst, M. and M. Suignard, "Internationalized Resource
+ Identifiers (IRIs)", RFC 3987, January 2005.
+
+ [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax
+ Specifications: ABNF", STD 68, RFC 5234, January 2008.
+
+ [RFC6365] Hoffman, P. and J. Klensin, "Terminology Used in
+ Internationalization in the IETF", BCP 166, RFC 6365,
+ September 2011.
+
+ [UNIV6] The Unicode Consortium, "The Unicode Standard, Version
+ 6.0.0", (Mountain View, CA: The Unicode Consortium,
+ 2011. ISBN 978-1-936213-01-6),
+ .
+
+ [UTR15] Davis, M. and M. Duerst, "Unicode Normalization Forms",
+ Unicode Standard Annex # 15, April 2003,
+ .
+
+6.2. Informative References
+
+ [OpenSearch] Clinton, D., "OpenSearch 1.1", Draft 5, December 2011,
+ .
+
+ [UPU-S42] Universal Postal Union, "International Postal Address
+ Components and Templates", UPU S42-1, November 2002,
+ .
+
+ [WADL] Hadley, M., "Web Application Description Language",
+ World Wide Web Consortium Member Submission
+ SUBM-wadl-20090831, August 2009,
+ .
+
+ [WSDL] Weerawarana, S., Moreau, J., Ryman, A., and R.
+ Chinnici, "Web Services Description Language (WSDL)
+ Version 2.0 Part 1: Core Language", World Wide Web
+ Consortium Recommendation REC-wsdl20-20070626,
+ June 2007, .
+
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 29]
+
+RFC 6570 URI Template March 2012
+
+
+Appendix A. Implementation Hints
+
+ The normative sections on expansion describe each operator with a
+ separate expansion process for the sake of descriptive clarity. In
+ actual implementations, we expect the expressions to be processed
+ left-to-right using a common algorithm that has only minor variations
+ in process per operator. This non-normative appendix describes one
+ such algorithm.
+
+ Initialize an empty result string and its non-error state.
+
+ Scan the template and copy literals to the result string (as in
+ Section 3.1) until an expression is indicated by a "{", an error is
+ indicated by the presence of a non-literals character other than "{",
+ or the template ends. When it ends, return the result string and its
+ current error or non-error state.
+
+ o If an expression is found, scan the template to the next "}" and
+ extract the characters in between the braces.
+
+ o If the template ends before a "}", then append the "{" and
+ extracted characters to the result string and return with an error
+ status indicating the expression is malformed.
+
+ Examine the first character of the extracted expression for an
+ operator.
+
+ o If the expression ended (i.e., is "{}"), an operator is found that
+ is unknown or unimplemented, or the character is not in the
+ varchar set (Section 2.3), then append "{", the extracted
+ expression, and "}" to the result string, remember that the result
+ is in an error state, and then go back to scan the remainder of
+ the template.
+
+ o If a known and implemented operator is found, store the operator
+ and skip to the next character to begin the varspec-list.
+
+ o Otherwise, store the operator as NUL (simple string expansion).
+
+ Use the following value table to determine the processing behavior by
+ expression type operator. The entry for "first" is the string to
+ append to the result first if any of the expression's variables are
+ defined. The entry for "sep" is the separator to append to the
+ result before any second (or subsequent) defined variable expansion.
+ The entry for "named" is a boolean for whether or not the expansion
+ includes the variable or key name when no explode modifier is given.
+ The entry for "ifemp" is a string to append to the name if its
+ corresponding value is empty. The entry for "allow" indicates what
+
+
+
+Gregorio, et al. Standards Track [Page 30]
+
+RFC 6570 URI Template March 2012
+
+
+ characters to allow unencoded within the value expansion: (U) means
+ any character not in the unreserved set will be encoded; (U+R) means
+ any character not in the union of (unreserved / reserved / pct-
+ encoding) will be encoded; and, for both cases, each disallowed
+ character is first encoded as its sequence of octets in UTF-8 and
+ then each such octet is encoded as a pct-encoded triplet.
+
+ .------------------------------------------------------------------.
+ | NUL + . / ; ? & # |
+ |------------------------------------------------------------------|
+ | first | "" "" "." "/" ";" "?" "&" "#" |
+ | sep | "," "," "." "/" ";" "&" "&" "," |
+ | named | false false false false true true true false |
+ | ifemp | "" "" "" "" "" "=" "=" "" |
+ | allow | U U+R U U U U U U+R |
+ `------------------------------------------------------------------'
+
+ With the above table in mind, process the variable-list as follows:
+
+ For each varspec, extract a variable name and optional modifier from
+ the expression by scanning the variable-list until a character not in
+ the varname set is found or the end of the expression is reached.
+
+ o If it is the end of the expression and the varname is empty, go
+ back to scan the remainder of the template.
+
+ o If it is not the end of the expression and the last character
+ found indicates a modifier ("*" or ":"), remember that modifier.
+ If it is an explode ("*"), scan the next character. If it is a
+ prefix (":"), continue scanning the next one to four characters
+ for the max-length represented as a decimal integer and then, if
+ it is still not the end of the expression, scan the next
+ character.
+
+ o If it is not the end of the expression and the last character
+ found is not a comma (","), append "{", the stored operator (if
+ any), the scanned varname and modifier, the remaining expression,
+ and "}" to the result string, remember that the result is in an
+ error state, and then go back to scan the remainder of the
+ template.
+
+ Lookup the value for the scanned variable name, and then
+
+ o If the varname is unknown or corresponds to a variable with an
+ undefined value (Section 2.3), then skip to the next varspec.
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 31]
+
+RFC 6570 URI Template March 2012
+
+
+ o If this is the first defined variable for this expression, append
+ the first string for this expression type to the result string and
+ remember that it has been done. Otherwise, append the sep string
+ to the result string.
+
+ o If this variable's value is a string, then
+
+ * if named is true, append the varname to the result string using
+ the same encoding process as for literals, and
+
+ + if the value is empty, append the ifemp string to the result
+ string and skip to the next varspec;
+
+ + otherwise, append "=" to the result string.
+
+ * if a prefix modifier is present and the prefix length is less
+ than the value string length in number of Unicode characters,
+ append that number of characters from the beginning of the
+ value string to the result string, after pct-encoding any
+ characters that are not in the allow set, while taking care not
+ to split multi-octet or pct-encoded triplet characters that
+ represent a single Unicode code point;
+
+ * otherwise, append the value to the result string after pct-
+ encoding any characters that are not in the allow set.
+
+ o else if no explode modifier is given, then
+
+ * if named is true, append the varname to the result string using
+ the same encoding process as for literals, and
+
+ + if the value is empty, append the ifemp string to the result
+ string and skip to the next varspec;
+
+ + otherwise, append "=" to the result string; and
+
+ * if this variable's value is a list, append each defined list
+ member to the result string, after pct-encoding any characters
+ that are not in the allow set, with a comma (",") appended to
+ the result between each defined list member;
+
+ * if this variable's value is an associative array or any other
+ form of paired (name, value) structure, append each pair with a
+ defined value to the result string as "name,value", after pct-
+ encoding any characters that are not in the allow set, with a
+ comma (",") appended to the result between each defined pair.
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 32]
+
+RFC 6570 URI Template March 2012
+
+
+ o else if an explode modifier is given, then
+
+ * if named is true, then for each defined list member or array
+ (name, value) pair with a defined value, do:
+
+ + if this is not the first defined member/value, append the
+ sep string to the result string;
+
+ + if this is a list, append the varname to the result string
+ using the same encoding process as for literals;
+
+ + if this is a pair, append the name to the result string
+ using the same encoding process as for literals;
+
+ + if the member/value is empty, append the ifemp string to the
+ result string; otherwise, append "=" and the member/value to
+ the result string, after pct-encoding any member/value
+ characters that are not in the allow set.
+
+ * else if named is false, then
+
+ + if this is a list, append each defined list member to the
+ result string, after pct-encoding any characters that are
+ not in the allow set, with the sep string appended to the
+ result between each defined list member.
+
+ + if this is an array of (name, value) pairs, append each pair
+ with a defined value to the result string as "name=value",
+ after pct-encoding any characters that are not in the allow
+ set, with the sep string appended to the result between each
+ defined pair.
+
+ When the variable-list for this expression is exhausted, go back to
+ scan the remainder of the template.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 33]
+
+RFC 6570 URI Template March 2012
+
+
+Authors' Addresses
+
+ Joe Gregorio
+ Google
+
+ EMail: joe@bitworking.org
+ URI: http://bitworking.org/
+
+
+ Roy T. Fielding
+ Adobe Systems Incorporated
+
+ EMail: fielding@gbiv.com
+ URI: http://roy.gbiv.com/
+
+
+ Marc Hadley
+ The MITRE Corporation
+
+ EMail: mhadley@mitre.org
+ URI: http://mitre.org/
+
+
+ Mark Nottingham
+ Rackspace
+
+ EMail: mnot@mnot.net
+ URI: http://www.mnot.net/
+
+
+ David Orchard
+ Salesforce.com
+
+ EMail: orchard@pacificspirit.com
+ URI: http://www.pacificspirit.com/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Gregorio, et al. Standards Track [Page 34]
+
diff --git a/specifications/auth/rfc7636.pdf b/specifications/auth/rfc7636.pdf
new file mode 100644
index 00000000..4acbd26f
Binary files /dev/null and b/specifications/auth/rfc7636.pdf differ
diff --git a/specifications/auth/rfc7636.txt b/specifications/auth/rfc7636.txt
new file mode 100644
index 00000000..653cb531
--- /dev/null
+++ b/specifications/auth/rfc7636.txt
@@ -0,0 +1,1123 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) N. Sakimura, Ed.
+Request for Comments: 7636 Nomura Research Institute
+Category: Standards Track J. Bradley
+ISSN: 2070-1721 Ping Identity
+ N. Agarwal
+ Google
+ September 2015
+
+
+ Proof Key for Code Exchange by OAuth Public Clients
+
+Abstract
+
+ OAuth 2.0 public clients utilizing the Authorization Code Grant are
+ susceptible to the authorization code interception attack. This
+ specification describes the attack as well as a technique to mitigate
+ against the threat through the use of Proof Key for Code Exchange
+ (PKCE, pronounced "pixy").
+
+Status of This Memo
+
+ This is an Internet Standards Track document.
+
+ This document is a product of the Internet Engineering Task Force
+ (IETF). It represents the consensus of the IETF community. It has
+ received public review and has been approved for publication by the
+ Internet Engineering Steering Group (IESG). Further information on
+ Internet Standards is available in Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc7636.
+
+Copyright Notice
+
+ Copyright (c) 2015 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) in effect on the date of
+ publication of this document. Please review these documents
+ carefully, as they describe your rights and restrictions with respect
+ to this document. Code Components extracted from this document must
+ include Simplified BSD License text as described in Section 4.e of
+ the Trust Legal Provisions and are provided without warranty as
+ described in the Simplified BSD License.
+
+
+
+
+Sakimura, et al. Standards Track [Page 1]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+Table of Contents
+
+ 1. Introduction ....................................................3
+ 1.1. Protocol Flow ..............................................5
+ 2. Notational Conventions ..........................................6
+ 3. Terminology .....................................................7
+ 3.1. Abbreviations ..............................................7
+ 4. Protocol ........................................................8
+ 4.1. Client Creates a Code Verifier .............................8
+ 4.2. Client Creates the Code Challenge ..........................8
+ 4.3. Client Sends the Code Challenge with the
+ Authorization Request ......................................9
+ 4.4. Server Returns the Code ....................................9
+ 4.4.1. Error Response ......................................9
+ 4.5. Client Sends the Authorization Code and the Code
+ Verifier to the Token Endpoint ............................10
+ 4.6. Server Verifies code_verifier before Returning the
+ Tokens ....................................................10
+ 5. Compatibility ..................................................11
+ 6. IANA Considerations ............................................11
+ 6.1. OAuth Parameters Registry .................................11
+ 6.2. PKCE Code Challenge Method Registry .......................11
+ 6.2.1. Registration Template ..............................12
+ 6.2.2. Initial Registry Contents ..........................13
+ 7. Security Considerations ........................................13
+ 7.1. Entropy of the code_verifier ..............................13
+ 7.2. Protection against Eavesdroppers ..........................13
+ 7.3. Salting the code_challenge ................................14
+ 7.4. OAuth Security Considerations .............................14
+ 7.5. TLS Security Considerations ...............................15
+ 8. References .....................................................15
+ 8.1. Normative References ......................................15
+ 8.2. Informative References ....................................16
+ Appendix A. Notes on Implementing Base64url Encoding without
+ Padding .............................................17
+ Appendix B. Example for the S256 code_challenge_method ...........17
+ Acknowledgements ..................................................19
+ Authors' Addresses ................................................20
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 2]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+1. Introduction
+
+ OAuth 2.0 [RFC6749] public clients are susceptible to the
+ authorization code interception attack.
+
+ In this attack, the attacker intercepts the authorization code
+ returned from the authorization endpoint within a communication path
+ not protected by Transport Layer Security (TLS), such as inter-
+ application communication within the client's operating system.
+
+ Once the attacker has gained access to the authorization code, it can
+ use it to obtain the access token.
+
+ Figure 1 shows the attack graphically. In step (1), the native
+ application running on the end device, such as a smartphone, issues
+ an OAuth 2.0 Authorization Request via the browser/operating system.
+ The Redirection Endpoint URI in this case typically uses a custom URI
+ scheme. Step (1) happens through a secure API that cannot be
+ intercepted, though it may potentially be observed in advanced attack
+ scenarios. The request then gets forwarded to the OAuth 2.0
+ authorization server in step (2). Because OAuth requires the use of
+ TLS, this communication is protected by TLS and cannot be
+ intercepted. The authorization server returns the authorization code
+ in step (3). In step (4), the Authorization Code is returned to the
+ requester via the Redirection Endpoint URI that was provided in step
+ (1).
+
+ Note that it is possible for a malicious app to register itself as a
+ handler for the custom scheme in addition to the legitimate OAuth 2.0
+ app. Once it does so, the malicious app is now able to intercept the
+ authorization code in step (4). This allows the attacker to request
+ and obtain an access token in steps (5) and (6), respectively.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 3]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+
+ | End Device (e.g., Smartphone) |
+ | |
+ | +-------------+ +----------+ | (6) Access Token +----------+
+ | |Legitimate | | Malicious|<--------------------| |
+ | |OAuth 2.0 App| | App |-------------------->| |
+ | +-------------+ +----------+ | (5) Authorization | |
+ | | ^ ^ | Grant | |
+ | | \ | | | |
+ | | \ (4) | | | |
+ | (1) | \ Authz| | | |
+ | Authz| \ Code | | | Authz |
+ | Request| \ | | | Server |
+ | | \ | | | |
+ | | \ | | | |
+ | v \ | | | |
+ | +----------------------------+ | | |
+ | | | | (3) Authz Code | |
+ | | Operating System/ |<--------------------| |
+ | | Browser |-------------------->| |
+ | | | | (2) Authz Request | |
+ | +----------------------------+ | +----------+
+ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+
+
+ Figure 1: Authorization Code Interception Attack
+
+ A number of pre-conditions need to hold for this attack to work:
+
+ 1. The attacker manages to register a malicious application on the
+ client device and registers a custom URI scheme that is also used
+ by another application. The operating systems must allow a custom
+ URI scheme to be registered by multiple applications.
+
+ 2. The OAuth 2.0 authorization code grant is used.
+
+ 3. The attacker has access to the OAuth 2.0 [RFC6749] "client_id" and
+ "client_secret" (if provisioned). All OAuth 2.0 native app
+ client-instances use the same "client_id". Secrets provisioned in
+ client binary applications cannot be considered confidential.
+
+ 4. Either one of the following condition is met:
+
+ 4a. The attacker (via the installed application) is able to
+ observe only the responses from the authorization endpoint.
+ When "code_challenge_method" value is "plain", only this
+ attack is mitigated.
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 4]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ 4b. A more sophisticated attack scenario allows the attacker to
+ observe requests (in addition to responses) to the
+ authorization endpoint. The attacker is, however, not able to
+ act as a man in the middle. This was caused by leaking http
+ log information in the OS. To mitigate this,
+ "code_challenge_method" value must be set either to "S256" or
+ a value defined by a cryptographically secure
+ "code_challenge_method" extension.
+
+ While this is a long list of pre-conditions, the described attack has
+ been observed in the wild and has to be considered in OAuth 2.0
+ deployments. While the OAuth 2.0 threat model (Section 4.4.1 of
+ [RFC6819]) describes mitigation techniques, they are, unfortunately,
+ not applicable since they rely on a per-client instance secret or a
+ per-client instance redirect URI.
+
+ To mitigate this attack, this extension utilizes a dynamically
+ created cryptographically random key called "code verifier". A
+ unique code verifier is created for every authorization request, and
+ its transformed value, called "code challenge", is sent to the
+ authorization server to obtain the authorization code. The
+ authorization code obtained is then sent to the token endpoint with
+ the "code verifier", and the server compares it with the previously
+ received request code so that it can perform the proof of possession
+ of the "code verifier" by the client. This works as the mitigation
+ since the attacker would not know this one-time key, since it is sent
+ over TLS and cannot be intercepted.
+
+1.1. Protocol Flow
+
+ +-------------------+
+ | Authz Server |
+ +--------+ | +---------------+ |
+ | |--(A)- Authorization Request ---->| | |
+ | | + t(code_verifier), t_m | | Authorization | |
+ | | | | Endpoint | |
+ | |<-(B)---- Authorization Code -----| | |
+ | | | +---------------+ |
+ | Client | | |
+ | | | +---------------+ |
+ | |--(C)-- Access Token Request ---->| | |
+ | | + code_verifier | | Token | |
+ | | | | Endpoint | |
+ | |<-(D)------ Access Token ---------| | |
+ +--------+ | +---------------+ |
+ +-------------------+
+
+ Figure 2: Abstract Protocol Flow
+
+
+
+Sakimura, et al. Standards Track [Page 5]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ This specification adds additional parameters to the OAuth 2.0
+ Authorization and Access Token Requests, shown in abstract form in
+ Figure 2.
+
+ A. The client creates and records a secret named the "code_verifier"
+ and derives a transformed version "t(code_verifier)" (referred to
+ as the "code_challenge"), which is sent in the OAuth 2.0
+ Authorization Request along with the transformation method "t_m".
+
+ B. The Authorization Endpoint responds as usual but records
+ "t(code_verifier)" and the transformation method.
+
+ C. The client then sends the authorization code in the Access Token
+ Request as usual but includes the "code_verifier" secret generated
+ at (A).
+
+ D. The authorization server transforms "code_verifier" and compares
+ it to "t(code_verifier)" from (B). Access is denied if they are
+ not equal.
+
+ An attacker who intercepts the authorization code at (B) is unable to
+ redeem it for an access token, as they are not in possession of the
+ "code_verifier" secret.
+
+2. Notational Conventions
+
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
+ "OPTIONAL" in this document are to be interpreted as described in
+ "Key words for use in RFCs to Indicate Requirement Levels" [RFC2119].
+ If these words are used without being spelled in uppercase, then they
+ are to be interpreted with their natural language meanings.
+
+ This specification uses the Augmented Backus-Naur Form (ABNF)
+ notation of [RFC5234].
+
+ STRING denotes a sequence of zero or more ASCII [RFC20] characters.
+
+ OCTETS denotes a sequence of zero or more octets.
+
+ ASCII(STRING) denotes the octets of the ASCII [RFC20] representation
+ of STRING where STRING is a sequence of zero or more ASCII
+ characters.
+
+ BASE64URL-ENCODE(OCTETS) denotes the base64url encoding of OCTETS,
+ per Appendix A, producing a STRING.
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 6]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ BASE64URL-DECODE(STRING) denotes the base64url decoding of STRING,
+ per Appendix A, producing a sequence of octets.
+
+ SHA256(OCTETS) denotes a SHA2 256-bit hash [RFC6234] of OCTETS.
+
+3. Terminology
+
+ In addition to the terms defined in OAuth 2.0 [RFC6749], this
+ specification defines the following terms:
+
+ code verifier
+ A cryptographically random string that is used to correlate the
+ authorization request to the token request.
+
+ code challenge
+ A challenge derived from the code verifier that is sent in the
+ authorization request, to be verified against later.
+
+ code challenge method
+ A method that was used to derive code challenge.
+
+ Base64url Encoding
+ Base64 encoding using the URL- and filename-safe character set
+ defined in Section 5 of [RFC4648], with all trailing '='
+ characters omitted (as permitted by Section 3.2 of [RFC4648]) and
+ without the inclusion of any line breaks, whitespace, or other
+ additional characters. (See Appendix A for notes on implementing
+ base64url encoding without padding.)
+
+3.1. Abbreviations
+
+ ABNF Augmented Backus-Naur Form
+
+ Authz Authorization
+
+ PKCE Proof Key for Code Exchange
+
+ MITM Man-in-the-middle
+
+ MTI Mandatory To Implement
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 7]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+4. Protocol
+
+4.1. Client Creates a Code Verifier
+
+ The client first creates a code verifier, "code_verifier", for each
+ OAuth 2.0 [RFC6749] Authorization Request, in the following manner:
+
+ code_verifier = high-entropy cryptographic random STRING using the
+ unreserved characters [A-Z] / [a-z] / [0-9] / "-" / "." / "_" / "~"
+ from Section 2.3 of [RFC3986], with a minimum length of 43 characters
+ and a maximum length of 128 characters.
+
+ ABNF for "code_verifier" is as follows.
+
+ code-verifier = 43*128unreserved
+ unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ ALPHA = %x41-5A / %x61-7A
+ DIGIT = %x30-39
+
+ NOTE: The code verifier SHOULD have enough entropy to make it
+ impractical to guess the value. It is RECOMMENDED that the output of
+ a suitable random number generator be used to create a 32-octet
+ sequence. The octet sequence is then base64url-encoded to produce a
+ 43-octet URL safe string to use as the code verifier.
+
+4.2. Client Creates the Code Challenge
+
+ The client then creates a code challenge derived from the code
+ verifier by using one of the following transformations on the code
+ verifier:
+
+ plain
+ code_challenge = code_verifier
+
+ S256
+ code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))
+
+ If the client is capable of using "S256", it MUST use "S256", as
+ "S256" is Mandatory To Implement (MTI) on the server. Clients are
+ permitted to use "plain" only if they cannot support "S256" for some
+ technical reason and know via out-of-band configuration that the
+ server supports "plain".
+
+ The plain transformation is for compatibility with existing
+ deployments and for constrained environments that can't use the S256
+ transformation.
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 8]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ ABNF for "code_challenge" is as follows.
+
+ code-challenge = 43*128unreserved
+ unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ ALPHA = %x41-5A / %x61-7A
+ DIGIT = %x30-39
+
+4.3. Client Sends the Code Challenge with the Authorization Request
+
+ The client sends the code challenge as part of the OAuth 2.0
+ Authorization Request (Section 4.1.1 of [RFC6749]) using the
+ following additional parameters:
+
+ code_challenge
+ REQUIRED. Code challenge.
+
+ code_challenge_method
+ OPTIONAL, defaults to "plain" if not present in the request. Code
+ verifier transformation method is "S256" or "plain".
+
+4.4. Server Returns the Code
+
+ When the server issues the authorization code in the authorization
+ response, it MUST associate the "code_challenge" and
+ "code_challenge_method" values with the authorization code so it can
+ be verified later.
+
+ Typically, the "code_challenge" and "code_challenge_method" values
+ are stored in encrypted form in the "code" itself but could
+ alternatively be stored on the server associated with the code. The
+ server MUST NOT include the "code_challenge" value in client requests
+ in a form that other entities can extract.
+
+ The exact method that the server uses to associate the
+ "code_challenge" with the issued "code" is out of scope for this
+ specification.
+
+4.4.1. Error Response
+
+ If the server requires Proof Key for Code Exchange (PKCE) by OAuth
+ public clients and the client does not send the "code_challenge" in
+ the request, the authorization endpoint MUST return the authorization
+ error response with the "error" value set to "invalid_request". The
+ "error_description" or the response of "error_uri" SHOULD explain the
+ nature of error, e.g., code challenge required.
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 9]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ If the server supporting PKCE does not support the requested
+ transformation, the authorization endpoint MUST return the
+ authorization error response with "error" value set to
+ "invalid_request". The "error_description" or the response of
+ "error_uri" SHOULD explain the nature of error, e.g., transform
+ algorithm not supported.
+
+4.5. Client Sends the Authorization Code and the Code Verifier to the
+ Token Endpoint
+
+ Upon receipt of the Authorization Code, the client sends the Access
+ Token Request to the token endpoint. In addition to the parameters
+ defined in the OAuth 2.0 Access Token Request (Section 4.1.3 of
+ [RFC6749]), it sends the following parameter:
+
+ code_verifier
+ REQUIRED. Code verifier
+
+ The "code_challenge_method" is bound to the Authorization Code when
+ the Authorization Code is issued. That is the method that the token
+ endpoint MUST use to verify the "code_verifier".
+
+4.6. Server Verifies code_verifier before Returning the Tokens
+
+ Upon receipt of the request at the token endpoint, the server
+ verifies it by calculating the code challenge from the received
+ "code_verifier" and comparing it with the previously associated
+ "code_challenge", after first transforming it according to the
+ "code_challenge_method" method specified by the client.
+
+ If the "code_challenge_method" from Section 4.3 was "S256", the
+ received "code_verifier" is hashed by SHA-256, base64url-encoded, and
+ then compared to the "code_challenge", i.e.:
+
+ BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) == code_challenge
+
+ If the "code_challenge_method" from Section 4.3 was "plain", they are
+ compared directly, i.e.:
+
+ code_verifier == code_challenge.
+
+ If the values are equal, the token endpoint MUST continue processing
+ as normal (as defined by OAuth 2.0 [RFC6749]). If the values are not
+ equal, an error response indicating "invalid_grant" as described in
+ Section 5.2 of [RFC6749] MUST be returned.
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 10]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+5. Compatibility
+
+ Server implementations of this specification MAY accept OAuth2.0
+ clients that do not implement this extension. If the "code_verifier"
+ is not received from the client in the Authorization Request, servers
+ supporting backwards compatibility revert to the OAuth 2.0 [RFC6749]
+ protocol without this extension.
+
+ As the OAuth 2.0 [RFC6749] server responses are unchanged by this
+ specification, client implementations of this specification do not
+ need to know if the server has implemented this specification or not
+ and SHOULD send the additional parameters as defined in Section 4 to
+ all servers.
+
+6. IANA Considerations
+
+ IANA has made the following registrations per this document.
+
+6.1. OAuth Parameters Registry
+
+ This specification registers the following parameters in the IANA
+ "OAuth Parameters" registry defined in OAuth 2.0 [RFC6749].
+
+ o Parameter name: code_verifier
+ o Parameter usage location: token request
+ o Change controller: IESG
+ o Specification document(s): RFC 7636 (this document)
+
+ o Parameter name: code_challenge
+ o Parameter usage location: authorization request
+ o Change controller: IESG
+ o Specification document(s): RFC 7636 (this document)
+
+ o Parameter name: code_challenge_method
+ o Parameter usage location: authorization request
+ o Change controller: IESG
+ o Specification document(s): RFC 7636 (this document)
+
+6.2. PKCE Code Challenge Method Registry
+
+ This specification establishes the "PKCE Code Challenge Methods"
+ registry. The new registry should be a sub-registry of the "OAuth
+ Parameters" registry.
+
+ Additional "code_challenge_method" types for use with the
+ authorization endpoint are registered using the Specification
+ Required policy [RFC5226], which includes review of the request by
+ one or more Designated Experts (DEs). The DEs will ensure that there
+
+
+
+Sakimura, et al. Standards Track [Page 11]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ is at least a two-week review of the request on the oauth-ext-
+ review@ietf.org mailing list and that any discussion on that list
+ converges before they respond to the request. To allow for the
+ allocation of values prior to publication, the Designated Expert(s)
+ may approve registration once they are satisfied that an acceptable
+ specification will be published.
+
+ Registration requests and discussion on the oauth-ext-review@ietf.org
+ mailing list should use an appropriate subject, such as "Request for
+ PKCE code_challenge_method: example").
+
+ The Designated Expert(s) should consider the discussion on the
+ mailing list, as well as the overall security properties of the
+ challenge method when evaluating registration requests. New methods
+ should not disclose the value of the code_verifier in the request to
+ the Authorization endpoint. Denials should include an explanation
+ and, if applicable, suggestions as to how to make the request
+ successful.
+
+6.2.1. Registration Template
+
+ Code Challenge Method Parameter Name:
+ The name requested (e.g., "example"). Because a core goal of this
+ specification is for the resulting representations to be compact,
+ it is RECOMMENDED that the name be short -- not to exceed 8
+ characters without a compelling reason to do so. This name is
+ case-sensitive. Names may not match other registered names in a
+ case-insensitive manner unless the Designated Expert(s) states
+ that there is a compelling reason to allow an exception in this
+ particular case.
+
+ Change Controller:
+ For Standards Track RFCs, state "IESG". For others, give the name
+ of the responsible party. Other details (e.g., postal address,
+ email address, and home page URI) may also be included.
+
+ Specification Document(s):
+ Reference to the document(s) that specifies the parameter,
+ preferably including URI(s) that can be used to retrieve copies of
+ the document(s). An indication of the relevant sections may also
+ be included but is not required.
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 12]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+6.2.2. Initial Registry Contents
+
+ Per this document, IANA has registered the Code Challenge Method
+ Parameter Names defined in Section 4.2 in this registry.
+
+ o Code Challenge Method Parameter Name: plain
+ o Change Controller: IESG
+ o Specification Document(s): Section 4.2 of RFC 7636 (this document)
+
+ o Code Challenge Method Parameter Name: S256
+ o Change Controller: IESG
+ o Specification Document(s): Section 4.2 of RFC 7636 (this document)
+
+7. Security Considerations
+
+7.1. Entropy of the code_verifier
+
+ The security model relies on the fact that the code verifier is not
+ learned or guessed by the attacker. It is vitally important to
+ adhere to this principle. As such, the code verifier has to be
+ created in such a manner that it is cryptographically random and has
+ high entropy that it is not practical for the attacker to guess.
+
+ The client SHOULD create a "code_verifier" with a minimum of 256 bits
+ of entropy. This can be done by having a suitable random number
+ generator create a 32-octet sequence. The octet sequence can then be
+ base64url-encoded to produce a 43-octet URL safe string to use as a
+ "code_challenge" that has the required entropy.
+
+7.2. Protection against Eavesdroppers
+
+ Clients MUST NOT downgrade to "plain" after trying the "S256" method.
+ Servers that support PKCE are required to support "S256", and servers
+ that do not support PKCE will simply ignore the unknown
+ "code_verifier". Because of this, an error when "S256" is presented
+ can only mean that the server is faulty or that a MITM attacker is
+ trying a downgrade attack.
+
+ The "S256" method protects against eavesdroppers observing or
+ intercepting the "code_challenge", because the challenge cannot be
+ used without the verifier. With the "plain" method, there is a
+ chance that "code_challenge" will be observed by the attacker on the
+ device or in the http request. Since the code challenge is the same
+ as the code verifier in this case, the "plain" method does not
+ protect against the eavesdropping of the initial request.
+
+ The use of "S256" protects against disclosure of the "code_verifier"
+ value to an attacker.
+
+
+
+Sakimura, et al. Standards Track [Page 13]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ Because of this, "plain" SHOULD NOT be used and exists only for
+ compatibility with deployed implementations where the request path is
+ already protected. The "plain" method SHOULD NOT be used in new
+ implementations, unless they cannot support "S256" for some technical
+ reason.
+
+ The "S256" code challenge method or other cryptographically secure
+ code challenge method extension SHOULD be used. The "plain" code
+ challenge method relies on the operating system and transport
+ security not to disclose the request to an attacker.
+
+ If the code challenge method is "plain" and the code challenge is to
+ be returned inside authorization "code" to achieve a stateless
+ server, it MUST be encrypted in such a manner that only the server
+ can decrypt and extract it.
+
+7.3. Salting the code_challenge
+
+ To reduce implementation complexity, salting is not used in the
+ production of the code challenge, as the code verifier contains
+ sufficient entropy to prevent brute-force attacks. Concatenating a
+ publicly known value to a code verifier (containing 256 bits of
+ entropy) and then hashing it with SHA256 to produce a code challenge
+ would not increase the number of attempts necessary to brute force a
+ valid value for code verifier.
+
+ While the "S256" transformation is like hashing a password, there are
+ important differences. Passwords tend to be relatively low-entropy
+ words that can be hashed offline and the hash looked up in a
+ dictionary. By concatenating a unique though public value to each
+ password prior to hashing, the dictionary space that an attacker
+ needs to search is greatly expanded.
+
+ Modern graphics processors now allow attackers to calculate hashes in
+ real time faster than they could be looked up from a disk. This
+ eliminates the value of the salt in increasing the complexity of a
+ brute-force attack for even low-entropy passwords.
+
+7.4. OAuth Security Considerations
+
+ All the OAuth security analysis presented in [RFC6819] applies, so
+ readers SHOULD carefully follow it.
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 14]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+7.5. TLS Security Considerations
+
+ Current security considerations can be found in "Recommendations for
+ Secure Use of Transport Layer Security (TLS) and Datagram Transport
+ Layer Security (DTLS)" [BCP195]. This supersedes the TLS version
+ recommendations in OAuth 2.0 [RFC6749].
+
+8. References
+
+8.1. Normative References
+
+ [BCP195] Sheffer, Y., Holz, R., and P. Saint-Andre,
+ "Recommendations for Secure Use of Transport Layer
+ Security (TLS) and Datagram Transport Layer Security
+ (DTLS)", BCP 195, RFC 7525, May 2015,
+ .
+
+ [RFC20] Cerf, V., "ASCII format for network interchange", STD 80,
+ RFC 20, DOI 10.17487/RFC0020, October 1969,
+ .
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119,
+ DOI 10.17487/RFC2119, March 1997,
+ .
+
+ [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
+ Resource Identifier (URI): Generic Syntax", STD 66, RFC
+ 3986, DOI 10.17487/RFC3986, January 2005,
+ .
+
+ [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
+ Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006,
+ .
+
+ [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
+ IANA Considerations Section in RFCs", BCP 26, RFC 5226,
+ DOI 10.17487/RFC5226, May 2008,
+ .
+
+ [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
+ Specifications: ABNF", STD 68, RFC 5234,
+ DOI 10.17487/RFC5234, January 2008,
+ .
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 15]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ [RFC6234] Eastlake 3rd, D. and T. Hansen, "US Secure Hash Algorithms
+ (SHA and SHA-based HMAC and HKDF)", RFC 6234,
+ DOI 10.17487/RFC6234, May 2011,
+ .
+
+ [RFC6749] Hardt, D., Ed., "The OAuth 2.0 Authorization Framework",
+ RFC 6749, DOI 10.17487/RFC6749, October 2012,
+ .
+
+8.2. Informative References
+
+ [RFC6819] Lodderstedt, T., Ed., McGloin, M., and P. Hunt, "OAuth 2.0
+ Threat Model and Security Considerations", RFC 6819,
+ DOI 10.17487/RFC6819, January 2013,
+ .
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 16]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+Appendix A. Notes on Implementing Base64url Encoding without Padding
+
+ This appendix describes how to implement a base64url-encoding
+ function without padding, based upon the standard base64-encoding
+ function that uses padding.
+
+ To be concrete, example C# code implementing these functions is shown
+ below. Similar code could be used in other languages.
+
+ static string base64urlencode(byte [] arg)
+ {
+ string s = Convert.ToBase64String(arg); // Regular base64 encoder
+ s = s.Split('=')[0]; // Remove any trailing '='s
+ s = s.Replace('+', '-'); // 62nd char of encoding
+ s = s.Replace('/', '_'); // 63rd char of encoding
+ return s;
+ }
+
+ An example correspondence between unencoded and encoded values
+ follows. The octet sequence below encodes into the string below,
+ which when decoded, reproduces the octet sequence.
+
+ 3 236 255 224 193
+
+ A-z_4ME
+
+Appendix B. Example for the S256 code_challenge_method
+
+ The client uses output of a suitable random number generator to
+ create a 32-octet sequence. The octets representing the value in
+ this example (using JSON array notation) are:
+
+ [116, 24, 223, 180, 151, 153, 224, 37, 79, 250, 96, 125, 216, 173,
+ 187, 186, 22, 212, 37, 77, 105, 214, 191, 240, 91, 88, 5, 88, 83,
+ 132, 141, 121]
+
+ Encoding this octet sequence as base64url provides the value of the
+ code_verifier:
+
+ dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
+
+ The code_verifier is then hashed via the SHA256 hash function to
+ produce:
+
+ [19, 211, 30, 150, 26, 26, 216, 236, 47, 22, 177, 12, 76, 152, 46,
+ 8, 118, 168, 120, 173, 109, 241, 68, 86, 110, 225, 137, 74, 203,
+ 112, 249, 195]
+
+
+
+
+Sakimura, et al. Standards Track [Page 17]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+ Encoding this octet sequence as base64url provides the value of the
+ code_challenge:
+
+ E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
+
+ The authorization request includes:
+
+ code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
+ &code_challenge_method=S256
+
+ The authorization server then records the code_challenge and
+ code_challenge_method along with the code that is granted to the
+ client.
+
+ In the request to the token_endpoint, the client includes the code
+ received in the authorization response as well as the additional
+ parameter:
+
+ code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
+
+ The authorization server retrieves the information for the code
+ grant. Based on the recorded code_challenge_method being S256, it
+ then hashes and base64url-encodes the value of code_verifier:
+
+ BASE64URL-ENCODE(SHA256(ASCII(code_verifier)))
+
+ The calculated value is then compared with the value of
+ "code_challenge":
+
+ BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) == code_challenge
+
+ If the two values are equal, then the authorization server can
+ provide the tokens as long as there are no other errors in the
+ request. If the values are not equal, then the request must be
+ rejected, and an error returned.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 18]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+Acknowledgements
+
+ The initial draft version of this specification was created by the
+ OpenID AB/Connect Working Group of the OpenID Foundation.
+
+ This specification is the work of the OAuth Working Group, which
+ includes dozens of active and dedicated participants. In particular,
+ the following individuals contributed ideas, feedback, and wording
+ that shaped and formed the final specification:
+
+ Anthony Nadalin, Microsoft
+ Axel Nenker, Deutsche Telekom
+ Breno de Medeiros, Google
+ Brian Campbell, Ping Identity
+ Chuck Mortimore, Salesforce
+ Dirk Balfanz, Google
+ Eduardo Gueiros, Jive Communications
+ Hannes Tschonfenig, ARM
+ James Manger, Telstra
+ Justin Richer, MIT Kerberos
+ Josh Mandel, Boston Children's Hospital
+ Lewis Adam, Motorola Solutions
+ Madjid Nakhjiri, Samsung
+ Michael B. Jones, Microsoft
+ Paul Madsen, Ping Identity
+ Phil Hunt, Oracle
+ Prateek Mishra, Oracle
+ Ryo Ito, mixi
+ Scott Tomilson, Ping Identity
+ Sergey Beryozkin
+ Takamichi Saito
+ Torsten Lodderstedt, Deutsche Telekom
+ William Denniss, Google
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 19]
+
+RFC 7636 OAUTH PKCE September 2015
+
+
+Authors' Addresses
+
+ Nat Sakimura (editor)
+ Nomura Research Institute
+ 1-6-5 Marunouchi, Marunouchi Kitaguchi Bldg.
+ Chiyoda-ku, Tokyo 100-0005
+ Japan
+
+ Phone: +81-3-5533-2111
+ Email: n-sakimura@nri.co.jp
+ URI: http://nat.sakimura.org/
+
+
+ John Bradley
+ Ping Identity
+ Casilla 177, Sucursal Talagante
+ Talagante, RM
+ Chile
+
+ Phone: +44 20 8133 3718
+ Email: ve7jtb@ve7jtb.com
+ URI: http://www.thread-safe.com/
+
+
+ Naveen Agarwal
+ Google
+ 1600 Amphitheatre Parkway
+ Mountain View, CA 94043
+ United States
+
+ Phone: +1 650-253-0000
+ Email: naa@google.com
+ URI: http://google.com/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sakimura, et al. Standards Track [Page 20]
+
diff --git a/specifications/calendar/rfc8984.pdf b/specifications/calendar/rfc8984.pdf
new file mode 100644
index 00000000..71318d7d
Binary files /dev/null and b/specifications/calendar/rfc8984.pdf differ
diff --git a/specifications/calendar/rfc8984.txt b/specifications/calendar/rfc8984.txt
new file mode 100644
index 00000000..565277cc
--- /dev/null
+++ b/specifications/calendar/rfc8984.txt
@@ -0,0 +1,3987 @@
+
+
+
+
+Internet Engineering Task Force (IETF) N. Jenkins
+Request for Comments: 8984 R. Stepanek
+Category: Standards Track Fastmail
+ISSN: 2070-1721 July 2021
+
+
+ JSCalendar: A JSON Representation of Calendar Data
+
+Abstract
+
+ This specification defines a data model and JSON representation of
+ calendar data that can be used for storage and data exchange in a
+ calendaring and scheduling environment. It aims to be an alternative
+ and, over time, successor to the widely deployed iCalendar data
+ format. It also aims to be unambiguous, extendable, and simple to
+ process. In contrast to the jCal format, which is also based on
+ JSON, JSCalendar is not a direct mapping from iCalendar but defines
+ the data model independently and expands semantics where appropriate.
+
+Status of This Memo
+
+ This is an Internet Standards Track document.
+
+ This document is a product of the Internet Engineering Task Force
+ (IETF). It represents the consensus of the IETF community. It has
+ received public review and has been approved for publication by the
+ Internet Engineering Steering Group (IESG). Further information on
+ Internet Standards is available in Section 2 of RFC 7841.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ https://www.rfc-editor.org/info/rfc8984.
+
+Copyright Notice
+
+ Copyright (c) 2021 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (https://trustee.ietf.org/license-info) in effect on the date of
+ publication of this document. Please review these documents
+ carefully, as they describe your rights and restrictions with respect
+ to this document. Code Components extracted from this document must
+ include Simplified BSD License text as described in Section 4.e of
+ the Trust Legal Provisions and are provided without warranty as
+ described in the Simplified BSD License.
+
+Table of Contents
+
+ 1. Introduction
+ 1.1. Motivation and Relation to iCalendar and jCal
+ 1.2. Notational Conventions
+ 1.3. Type Signatures
+ 1.4. Data Types
+ 1.4.1. Id
+ 1.4.2. Int
+ 1.4.3. UnsignedInt
+ 1.4.4. UTCDateTime
+ 1.4.5. LocalDateTime
+ 1.4.6. Duration
+ 1.4.7. SignedDuration
+ 1.4.8. TimeZoneId
+ 1.4.9. PatchObject
+ 1.4.10. Relation
+ 1.4.11. Link
+ 2. JSCalendar Objects
+ 2.1. Event
+ 2.2. Task
+ 2.3. Group
+ 3. Structure of JSCalendar Objects
+ 3.1. Object Type
+ 3.2. Normalization and Equivalence
+ 3.3. Vendor-Specific Property Extensions, Values, and Types
+ 4. Common JSCalendar Properties
+ 4.1. Metadata Properties
+ 4.1.1. @type
+ 4.1.2. uid
+ 4.1.3. relatedTo
+ 4.1.4. prodId
+ 4.1.5. created
+ 4.1.6. updated
+ 4.1.7. sequence
+ 4.1.8. method
+ 4.2. What and Where Properties
+ 4.2.1. title
+ 4.2.2. description
+ 4.2.3. descriptionContentType
+ 4.2.4. showWithoutTime
+ 4.2.5. locations
+ 4.2.6. virtualLocations
+ 4.2.7. links
+ 4.2.8. locale
+ 4.2.9. keywords
+ 4.2.10. categories
+ 4.2.11. color
+ 4.3. Recurrence Properties
+ 4.3.1. recurrenceId
+ 4.3.2. recurrenceIdTimeZone
+ 4.3.3. recurrenceRules
+ 4.3.4. excludedRecurrenceRules
+ 4.3.5. recurrenceOverrides
+ 4.3.6. excluded
+ 4.4. Sharing and Scheduling Properties
+ 4.4.1. priority
+ 4.4.2. freeBusyStatus
+ 4.4.3. privacy
+ 4.4.4. replyTo
+ 4.4.5. sentBy
+ 4.4.6. participants
+ 4.4.7. requestStatus
+ 4.5. Alerts Properties
+ 4.5.1. useDefaultAlerts
+ 4.5.2. alerts
+ 4.6. Multilingual Properties
+ 4.6.1. localizations
+ 4.7. Time Zone Properties
+ 4.7.1. timeZone
+ 4.7.2. timeZones
+ 5. Type-Specific JSCalendar Properties
+ 5.1. Event Properties
+ 5.1.1. start
+ 5.1.2. duration
+ 5.1.3. status
+ 5.2. Task Properties
+ 5.2.1. due
+ 5.2.2. start
+ 5.2.3. estimatedDuration
+ 5.2.4. percentComplete
+ 5.2.5. progress
+ 5.2.6. progressUpdated
+ 5.3. Group Properties
+ 5.3.1. entries
+ 5.3.2. source
+ 6. Examples
+ 6.1. Simple Event
+ 6.2. Simple Task
+ 6.3. Simple Group
+ 6.4. All-Day Event
+ 6.5. Task with a Due Date
+ 6.6. Event with End Time Zone
+ 6.7. Floating-Time Event (with Recurrence)
+ 6.8. Event with Multiple Locations and Localization
+ 6.9. Recurring Event with Overrides
+ 6.10. Recurring Event with Participants
+ 7. Security Considerations
+ 7.1. Expanding Recurrences
+ 7.2. JSON Parsing
+ 7.3. URI Values
+ 7.4. Spam
+ 7.5. Duplication
+ 7.6. Time Zones
+ 8. IANA Considerations
+ 8.1. Media Type Registration
+ 8.2. Creation of the "JSCalendar Properties" Registry
+ 8.2.1. Preliminary Community Review
+ 8.2.2. Submit Request to IANA
+ 8.2.3. Designated Expert Review
+ 8.2.4. Change Procedures
+ 8.2.5. "JSCalendar Properties" Registry Template
+ 8.2.6. Initial Contents for the "JSCalendar Properties"
+ Registry
+ 8.3. Creation of the "JSCalendar Types" Registry
+ 8.3.1. "JSCalendar Types" Registry Template
+ 8.3.2. Initial Contents for the "JSCalendar Types" Registry
+ 8.4. Creation of the "JSCalendar Enum Values" Registry
+ 8.4.1. "JSCalendar Enum Values" Registry Property Template
+ 8.4.2. "JSCalendar Enum Values" Registry Value Template
+ 8.4.3. Initial Contents for the "JSCalendar Enum Values"
+ Registry
+ 9. References
+ 9.1. Normative References
+ 9.2. Informative References
+ Acknowledgments
+ Authors' Addresses
+
+1. Introduction
+
+ This document defines a data model for calendar event and task
+ objects, or groups of such objects, in electronic calendar
+ applications and systems. The format aims to be unambiguous,
+ extendable, and simple to process.
+
+ The key design considerations for this data model are as follows:
+
+ * The attributes of the calendar entry represented must be described
+ as simple key-value pairs. Simple events are simple to represent;
+ complex events can be modeled accurately.
+
+ * Wherever possible, there should be only one way to express the
+ desired semantics, reducing complexity.
+
+ * The data model should avoid ambiguities, which often lead to
+ interoperability issues between implementations.
+
+ * The data model should be generally compatible with the iCalendar
+ data format [RFC5545] [RFC7986] and extensions, but the
+ specification should add new attributes where the iCalendar format
+ currently lacks expressivity, and drop seldom-used, obsolete, or
+ redundant properties. This means translation with no loss of
+ semantics should be easy with most common iCalendar files.
+
+ * Extensions, such as new properties and components, should not
+ require updates to this document.
+
+ The representation of this data model is defined in the Internet JSON
+ (I-JSON) format [RFC7493], which is a strict subset of the JSON data
+ interchange format [RFC8259]. Using JSON is mostly a pragmatic
+ choice: its widespread use makes JSCalendar easier to adopt and the
+ ready availability of production-ready JSON implementations
+ eliminates a whole category of parser-related interoperability
+ issues, which iCalendar has often suffered from.
+
+1.1. Motivation and Relation to iCalendar and jCal
+
+ The iCalendar data format [RFC5545], a widely deployed interchange
+ format for calendaring and scheduling data, has served calendaring
+ vendors for a long time but contains some ambiguities and pitfalls
+ that cannot be overcome without backward-incompatible changes.
+
+ Sources of implementation errors include the following:
+
+ * iCalendar defines various formats for local times, UTC, and dates.
+
+ * iCalendar requires custom time zone definitions within a single
+ calendar component.
+
+ * iCalendar's definition of recurrence rules is ambiguous and has
+ resulted in differing interpretations, even between experienced
+ calendar developers.
+
+ * The iCalendar format itself causes interoperability issues due to
+ misuse of CRLF-terminated strings, line continuations, and subtle
+ differences among iCalendar parsers.
+
+ In recent years, many new products and services have appeared that
+ wish to use a JSON representation of calendar data within their APIs.
+ The JSON format for iCalendar data, jCal [RFC7265], is a direct
+ mapping between iCalendar and JSON. In its effort to represent full
+ iCalendar semantics, it inherits all the same pitfalls and uses a
+ complicated JSON structure.
+
+ As a consequence, since the standardization of jCal, the majority of
+ implementations and service providers either kept using iCalendar or
+ came up with their own proprietary JSON representations, which are
+ incompatible with each other and often suffer from common pitfalls,
+ such as storing event start times in UTC (which become incorrect if
+ the time zone's rules change in the future). JSCalendar meets the
+ demand for JSON-formatted calendar data that is free of such known
+ problems and provides a standard representation as an alternative to
+ the proprietary formats.
+
+1.2. Notational Conventions
+
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
+ "OPTIONAL" in this document are to be interpreted as described in
+ BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
+ capitals, as shown here.
+
+ The underlying format used for this specification is JSON.
+ Consequently, the terms "object" and "array" as well as the four
+ primitive types (strings, numbers, booleans, and null) are to be
+ interpreted as described in Section 1 of [RFC8259].
+
+ Some examples in this document contain "partial" JSON documents used
+ for illustrative purposes. In these examples, an ellipsis "..." is
+ used to indicate a portion of the document that has been removed for
+ compactness.
+
+1.3. Type Signatures
+
+ Type signatures are given for all JSON values in this document. The
+ following conventions are used:
+
+ "*": The type is undefined (the value could be any type, although
+ permitted values may be constrained by the context of this value).
+
+ "String": This is the JSON string type.
+
+ "Number": This is the JSON number type.
+
+ "Boolean": This is the JSON boolean type.
+
+ "A[B]": The keys are all of type "A" and the values are all of type
+ "B" for a JSON object.
+
+ "A[]": There is an array of values of type "A"
+
+ "A|B": The value is either of type "A" or of type "B".
+
+ Other types may also be given; their representations are defined
+ elsewhere in this document.
+
+1.4. Data Types
+
+ In addition to the standard JSON data types, the following data types
+ are used in this specification:
+
+1.4.1. Id
+
+ Where "Id" is given as a data type, it means a "String" of at least 1
+ and a maximum of 255 octets in size, and it MUST only contain
+ characters from the "URL and Filename Safe" base64url alphabet, as
+ defined in Section 5 of [RFC4648], excluding the pad character ("=").
+ This means the allowed characters are the ASCII alphanumeric
+ characters ("A-Za-z0-9"), hyphen ("-"), and underscore ("_").
+
+ In many places in JSCalendar, a JSON map is used where the map keys
+ are of type Id and the map values are all the same type of object.
+ This construction represents an unordered set of objects, with the
+ added advantage that each entry has a name (the corresponding map
+ key). This allows for more concise patching of objects, and, when
+ applicable, for the objects in question to be referenced from other
+ objects within the JSCalendar object.
+
+ Unless otherwise specified for a particular property, there are no
+ uniqueness constraints on an Id value (other than, of course, the
+ requirement that you cannot have two values with the same key within
+ a single JSON map). For example, two Event objects might use the
+ same Ids in their respective "links" properties or, within the same
+ Event object, the same Id could appear in the "participants" and
+ "alerts" properties. These situations do not imply any semantic
+ connections among the objects.
+
+1.4.2. Int
+
+ Where "Int" is given as a data type, it means an integer in the range
+ -2^53+1 <= value <= 2^53-1, the safe range for integers stored in a
+ floating-point double, represented as a JSON "Number".
+
+1.4.3. UnsignedInt
+
+ Where "UnsignedInt" is given as a data type, it means an integer in
+ the range 0 <= value <= 2^53-1, represented as a JSON "Number".
+
+1.4.4. UTCDateTime
+
+ This is a string in the "date-time" [RFC3339] format, with the
+ further restrictions that any letters MUST be in uppercase, and the
+ time offset MUST be the character "Z". Fractional second values MUST
+ NOT be included unless non-zero and MUST NOT have trailing zeros, to
+ ensure there is only a single representation for each date-time.
+
+ For example, "2010-10-10T10:10:10.003Z" is conformant, but
+ "2010-10-10T10:10:10.000Z" is invalid and is correctly encoded as
+ "2010-10-10T10:10:10Z".
+
+1.4.5. LocalDateTime
+
+ This is a date-time string with no time zone/offset information. It
+ is otherwise in the same format as UTCDateTime, including fractional
+ seconds. For example, "2006-01-02T15:04:05" and
+ "2006-01-02T15:04:05.003" are both valid. The time zone to associate
+ with the LocalDateTime comes from the "timeZone" property of the
+ JSCalendar object (see Section 4.7.1). If no time zone is specified,
+ the LocalDateTime is "floating". Floating date-times are not tied to
+ any specific time zone. Instead, they occur in each time zone at the
+ given wall-clock time (as opposed to the same instant point in time).
+
+ A time zone may have a period of discontinuity, for example, a change
+ from standard time to daylight savings time. When converting local
+ date-times that fall in the discontinuity to UTC, the offset before
+ the transition MUST be used.
+
+ For example, in the America/Los_Angeles time zone, the date-time
+ 2020-11-01T01:30:00 occurs twice: before the daylight savings time
+ (DST) transition with a UTC offset of -07:00 and again after the
+ transition with an offset of -08:00. When converting to UTC, we
+ therefore use the offset before the transition (-07:00), so it
+ becomes 2020-11-01T08:30:00Z.
+
+ Similarly, in the Australia/Melbourne time zone, the date-time
+ 2020-10-04T02:30:00 does not exist; the clocks are moved forward one
+ hour for DST on that day at 02:00. However, such a value may appear
+ during calculations (see duration semantics in Section 1.4.6) or due
+ to a change in time zone rules (so it was valid when the event was
+ first created). Again, it is interpreted as though the offset before
+ the transition is in effect (+10:00); therefore, when converted to
+ UTC, we get 2020-10-03T16:30:00Z.
+
+1.4.6. Duration
+
+ Where Duration is given as a type, it means a length of time
+ represented by a subset of the ISO 8601 duration format, as specified
+ by the following ABNF [RFC5234]:
+
+ dur-secfrac = "." 1*DIGIT
+ dur-second = 1*DIGIT [dur-secfrac] "S"
+ dur-minute = 1*DIGIT "M" [dur-second]
+ dur-hour = 1*DIGIT "H" [dur-minute]
+ dur-time = "T" (dur-hour / dur-minute / dur-second)
+ dur-day = 1*DIGIT "D"
+ dur-week = 1*DIGIT "W"
+ dur-cal = (dur-week [dur-day] / dur-day)
+
+ duration = "P" (dur-cal [dur-time] / dur-time)
+
+ In addition, the duration MUST NOT include fractional second values
+ unless the fraction is non-zero. Fractional second values MUST NOT
+ have trailing zeros to ensure there is only a single representation
+ for each duration.
+
+ A duration specifies an abstract number of weeks, days, hours,
+ minutes, and/or seconds. A duration specified using weeks or days
+ does not always correspond to an exact multiple of 24 hours. The
+ number of hours/minutes/seconds may vary if it overlaps a period of
+ discontinuity in the event's time zone, for example, a change from
+ standard time to daylight savings time. Leap seconds MUST NOT be
+ considered when adding or subtracting a duration to/from a
+ LocalDateTime.
+
+ To add a duration to a LocalDateTime:
+
+ 1. Add any week or day components of the duration to the date. A
+ week is always the same as seven days.
+
+ 2. If a time zone applies to the LocalDateTime, convert it to a
+ UTCDateTime following the semantics in Section 1.4.5.
+
+ 3. Add any hour, minute, or second components of the duration (in
+ absolute time).
+
+ 4. Convert the resulting UTCDateTime back to a LocalDateTime in the
+ time zone that applies.
+
+ To subtract a duration from a LocalDateTime, the steps apply in
+ reverse:
+
+ 1. If a time zone applies to the LocalDateTime, convert it to UTC
+ following the semantics in Section 1.4.5.
+
+ 2. Subtract any hour, minute, or second components of the duration
+ (in absolute time).
+
+ 3. Convert the resulting UTCDateTime back to LocalDateTime in the
+ time zone that applies.
+
+ 4. Subtract any week or day components of the duration from the
+ date.
+
+ 5. If the resulting time does not exist on the date due to a
+ discontinuity in the time zone, use the semantics in
+ Section 1.4.5 to convert to UTC and back to get a valid
+ LocalDateTime.
+
+ These semantics match the iCalendar DURATION value type ([RFC5545],
+ Section 3.3.6).
+
+1.4.7. SignedDuration
+
+ A SignedDuration represents a length of time that may be positive or
+ negative and is typically used to express the offset of a point in
+ time relative to an associated time. It is represented as a
+ Duration, optionally preceded by a sign character. It is specified
+ by the following ABNF:
+
+ signed-duration = ["+" / "-"] duration
+
+ A negative sign indicates a point in time at or before the associated
+ time; a positive or no sign indicates a time at or after the
+ associated time.
+
+1.4.8. TimeZoneId
+
+ Where "TimeZoneId" is given as a data type, it means a "String" that
+ is either a time zone name in the IANA Time Zone Database [TZDB] or a
+ custom time zone identifier defined in the "timeZones" property (see
+ Section 4.7.2).
+
+ Where an IANA time zone is specified, the zone rules of the
+ respective zone records apply. Custom time zones are interpreted as
+ described in Section 4.7.2.
+
+1.4.9. PatchObject
+
+ A PatchObject is of type "String[*]" and represents an unordered set
+ of patches on a JSON object. Each key is a path represented in a
+ subset of the JSON Pointer format [RFC6901]. The paths have an
+ implicit leading "/", so each key is prefixed with "/" before
+ applying the JSON Pointer evaluation algorithm.
+
+ A patch within a PatchObject is only valid if all of the following
+ conditions apply:
+
+ 1. The pointer MUST NOT reference inside an array (i.e., you MUST
+ NOT insert/delete from an array; the array MUST be replaced in
+ its entirety instead).
+
+ 2. All parts prior to the last (i.e., the value after the final
+ slash) MUST already exist on the object being patched.
+
+ 3. There MUST NOT be two patches in the PatchObject where the
+ pointer of one is the prefix of the pointer of the other, e.g.,
+ "alerts/1/offset" and "alerts".
+
+ 4. The value for the patch MUST be valid for the property being set
+ (of the correct type and obeying any other applicable
+ restrictions), or, if null, the property MUST be optional.
+
+ The value associated with each pointer determines how to apply that
+ patch:
+
+ * If null, remove the property from the patched object. If the key
+ is not present in the parent, this a no-op.
+
+ * If non-null, set the value given as the value for this property
+ (this may be a replacement or addition to the object being
+ patched).
+
+ A PatchObject does not define its own "@type" property (see
+ Section 4.1.1). An "@type" property in a patch MUST be handled as
+ any other patched property value.
+
+ Implementations MUST reject a PatchObject in its entirety if any of
+ its patches are invalid. Implementations MUST NOT apply partial
+ patches.
+
+ The PatchObject format is used to significantly reduce file size and
+ duplicated content when specifying variations to a common object,
+ such as with recurring events or when translating the data into
+ multiple languages. It can also better preserve semantic intent if
+ only the properties that should differ between the two objects are
+ patched. For example, if one person is not going to a particular
+ instance of a regularly scheduled event, in iCalendar, you would have
+ to duplicate the entire event in the override. In JSCalendar, this
+ is a small patch to show the difference. As only this property is
+ patched, if the location of the event is changed, the occurrence will
+ automatically still inherit this.
+
+1.4.10. Relation
+
+ A Relation object defines the relation to other objects, using a
+ possibly empty set of relation types. The object that defines this
+ relation is the linking object, while the other object is the linked
+ object. A Relation object has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be "Relation".
+
+ relation: "String[Boolean]" (optional, default: empty Object)
+ This describes how the linked object is related to the linking
+ object. The relation is defined as a set of relation types. If
+ empty, the relationship between the two objects is unspecified.
+
+ Keys in the set MUST be one of the following values, specified in
+ the property definition where the Relation object is used, a value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3):
+
+ "first": The linked object is the first in a series the linking
+ object is part of.
+
+ "next": The linked object is next in a series the linking object
+ is part of.
+
+ "child": The linked object is a subpart of the linking object.
+
+ "parent": The linking object is a subpart of the linked object.
+
+ The value for each key in the map MUST be true.
+
+1.4.11. Link
+
+ A Link object represents an external resource associated with the
+ linking object. It has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be "Link".
+
+ href: "String" (mandatory)
+ This is a URI [RFC3986] from which the resource may be fetched.
+
+ This MAY be a "data:" URL [RFC2397], but it is recommended that
+ the file be hosted on a server to avoid embedding arbitrarily
+ large data in JSCalendar object instances.
+
+ cid: "String" (optional)
+ This MUST be a valid "content-id" value according to the
+ definition of Section 2 of [RFC2392]. The value MUST be unique
+ within this Link object but has no meaning beyond that. It MAY be
+ different from the link id for this Link object.
+
+ contentType: "String" (optional)
+ This is the media type [RFC6838] of the resource, if known.
+
+ size: "UnsignedInt" (optional)
+ This is the size, in octets, of the resource when fully decoded
+ (i.e., the number of octets in the file the user would download),
+ if known. Note that this is an informational estimate, and
+ implementations must be prepared to handle the actual size being
+ quite different when the resource is fetched.
+
+ rel: "String" (optional)
+ This identifies the relation of the linked resource to the object.
+ If set, the value MUST be a relation type from the IANA "Link
+ Relations" registry [LINKRELS], as established in [RFC8288].
+
+ display: "String" (optional)
+ This describes the intended purpose of a link to an image. If
+ set, the "rel" property MUST be set to "icon". The value MUST be
+ one of the following values, another value registered in the IANA
+ "JSCalendar Enum Values" registry, or a vendor-specific value (see
+ Section 3.3):
+
+ "badge": an image meant to be displayed alongside the title of
+ the object
+
+ "graphic": a full image replacement for the object itself
+
+ "fullsize": an image that is used to enhance the object
+
+ "thumbnail": a smaller variant of "fullsize" to be used when
+ space for the image is constrained
+
+ title: "String" (optional)
+ This is a human-readable, plain-text description of the resource.
+
+2. JSCalendar Objects
+
+ This section describes the calendar object types specified by
+ JSCalendar.
+
+2.1. Event
+
+ Media type: "application/jscalendar+json;type=event"
+
+ An Event represents a scheduled amount of time on a calendar,
+ typically a meeting, appointment, reminder, or anniversary. It is
+ required to start at a certain point in time and typically has a non-
+ zero duration. Multiple participants may partake in the event at
+ multiple locations.
+
+ The @type (Section 4.1.1) property value MUST be "Event".
+
+2.2. Task
+
+ Media type: "application/jscalendar+json;type=task"
+
+ A Task represents an action item, assignment, to-do item, or work
+ item. It may start and be due at certain points in time, take some
+ estimated time to complete, and recur, none of which is required.
+
+ The @type (Section 4.1.1) property value MUST be "Task".
+
+2.3. Group
+
+ Media type: "application/jscalendar+json;type=group"
+
+ A Group is a collection of Event (Section 2.1) and/or Task
+ (Section 2.2) objects. Typically, objects are grouped by topic
+ (e.g., by keywords) or calendar membership.
+
+ The @type (Section 4.1.1) property value MUST be "Group".
+
+3. Structure of JSCalendar Objects
+
+ A JSCalendar object is a JSON object [RFC8259], which MUST be valid
+ I-JSON (a stricter subset of JSON) [RFC7493]. Property names and
+ values are case sensitive.
+
+ The object has a collection of properties, as specified in the
+ following sections. Properties are specified as being either
+ mandatory or optional. Optional properties may have a default value
+ if explicitly specified in the property definition.
+
+3.1. Object Type
+
+ JSCalendar objects MUST name their type in the "@type" property if
+ not explicitly specified otherwise for the respective object type. A
+ notable exception to this rule is the PatchObject (Section 1.4.9).
+
+3.2. Normalization and Equivalence
+
+ JSCalendar aims to provide unambiguous definitions for value types
+ and properties but does not define a general normalization or
+ equivalence method for JSCalendar objects and types. This is because
+ the notion of equivalence might range from byte-level equivalence to
+ semantic equivalence, depending on the respective use case.
+ Normalization of JSCalendar objects is hindered because of the
+ following reasons:
+
+ * Custom JSCalendar properties may contain arbitrary JSON values,
+ including arrays. However, equivalence of arrays might or might
+ not depend on the order of elements, depending on the respective
+ property definition.
+
+ * Several JSCalendar property values are defined as URIs and media
+ types, but normalization of these types is inherently protocol and
+ scheme specific, depending on the use case of the equivalence
+ definition (see Section 6 of [RFC3986]).
+
+ Considering this, the definition of equivalence and normalization is
+ left to client and server implementations and to be negotiated by a
+ calendar exchange protocol or defined elsewhere.
+
+3.3. Vendor-Specific Property Extensions, Values, and Types
+
+ Vendors MAY add additional properties to the calendar object to
+ support their custom features. To avoid conflict, the names of these
+ properties MUST be prefixed by a domain name controlled by the vendor
+ followed by a colon, e.g., "example.com:customprop". If the value is
+ a new JSCalendar object, it either MUST include an "@type" property,
+ or it MUST explicitly be specified to not require a type designator.
+ The type name MUST be prefixed with a domain name controlled by the
+ vendor.
+
+ Some JSCalendar properties allow vendor-specific value extensions.
+ Such vendor-specific values MUST be prefixed by a domain name
+ controlled by the vendor followed by a colon, e.g.,
+ "example.com:customrel".
+
+ Vendors are strongly encouraged to register any new property values
+ or extensions that are useful to other systems as well, rather than
+ use a vendor-specific prefix.
+
+4. Common JSCalendar Properties
+
+ This section describes the properties that are common to the various
+ JSCalendar object types. Specific JSCalendar object types may only
+ support a subset of these properties. The object type definitions in
+ Section 5 describe the set of supported properties per type.
+
+4.1. Metadata Properties
+
+4.1.1. @type
+
+ Type: "String" (mandatory)
+
+ This specifies the type that this object represents. The allowed
+ value differs by object type and is defined in Sections 2.1, 2.2, and
+ 2.3.
+
+4.1.2. uid
+
+ Type: "String" (mandatory)
+
+ This is a globally unique identifier used to associate objects
+ representing the same event, task, group, or other object across
+ different systems, calendars, and views. For recurring events and
+ tasks, the UID is associated with the base object and therefore is
+ the same for all occurrences; the combination of the UID with a
+ "recurrenceId" identifies a particular instance.
+
+ The generator of the identifier MUST guarantee that the identifier is
+ unique. [RFC4122] describes a range of established algorithms to
+ generate universally unique identifiers (UUIDs). UUID version 4,
+ described in Section 4.4 of [RFC4122], is RECOMMENDED.
+
+ For compatibility with UIDs [RFC5545], implementations MUST be able
+ to receive and persist values of at least 255 octets for this
+ property, but they MUST NOT truncate values in the middle of a UTF-8
+ multi-octet sequence.
+
+4.1.3. relatedTo
+
+ Type: "String[Relation]" (optional)
+
+ This relates the object to other JSCalendar objects. This is
+ represented as a map of the UIDs of the related objects to
+ information about the relation.
+
+ If an object is split to make a "this and future" change to a
+ recurrence, the original object MUST be truncated to end at the
+ previous occurrence before this split, and a new object is created to
+ represent all the occurrences after the split. A "next" relation
+ MUST be set on the original object's "relatedTo" property for the UID
+ of the new object. A "first" relation for the UID of the first
+ object in the series MUST be set on the new object. Clients can then
+ follow these UIDs to get the complete set of objects if the user
+ wishes to modify them all at once.
+
+4.1.4. prodId
+
+ Type: "String" (optional)
+
+ This is the identifier for the product that last updated the
+ JSCalendar object. This should be set whenever the data in the
+ object is modified (i.e., whenever the "updated" property is set).
+
+ The vendor of the implementation MUST ensure that this is a globally
+ unique identifier, using some technique such as a Formal Public
+ Identifier (FPI) value, as defined in [ISO.9070.1991].
+
+ This property SHOULD NOT be used to alter the interpretation of a
+ JSCalendar object beyond the semantics specified in this document.
+ For example, it is not to be used to further the understanding of
+ nonstandard properties, a practice that is known to cause long-term
+ interoperability problems.
+
+4.1.5. created
+
+ Type: "UTCDateTime" (optional)
+
+ This is the date and time this object was initially created.
+
+4.1.6. updated
+
+ Type: "UTCDateTime" (mandatory)
+
+ This is the date and time the data in this object was last modified
+ (or its creation date/time if not modified since).
+
+4.1.7. sequence
+
+ Type: "UnsignedInt" (optional, default: 0)
+
+ Initially zero, this MUST be incremented by one every time a change
+ is made to the object, except if the change only modifies the
+ "participants" property (see Section 4.4.6).
+
+ This is used as part of the iCalendar Transport-independent
+ Interoperability Protocol (iTIP) [RFC5546] to know which version of
+ the object a scheduling message relates to.
+
+4.1.8. method
+
+ Type: "String" (optional)
+
+ This is the iTIP [RFC5546] method, in lowercase. This MUST only be
+ present if the JSCalendar object represents an iTIP scheduling
+ message.
+
+4.2. What and Where Properties
+
+4.2.1. title
+
+ Type: "String" (optional, default: empty String)
+
+ This is a short summary of the object.
+
+4.2.2. description
+
+ Type: "String" (optional, default: empty String)
+
+ This is a longer-form text description of the object. The content is
+ formatted according to the "descriptionContentType" property.
+
+4.2.3. descriptionContentType
+
+ Type: "String" (optional, default: "text/plain")
+
+ This describes the media type [RFC6838] of the contents of the
+ "description" property. Media types MUST be subtypes of type "text"
+ and SHOULD be "text/plain" or "text/html" [MEDIATYPES]. They MAY
+ include parameters, and the "charset" parameter value MUST be "utf-
+ 8", if specified. Descriptions of type "text/html" MAY contain "cid"
+ URLs [RFC2392] to reference links in the calendar object by use of
+ the "cid" property of the Link object.
+
+4.2.4. showWithoutTime
+
+ Type: "Boolean" (optional, default: false)
+
+ This indicates that the time is not important to display to the user
+ when rendering this calendar object. An example of this is an event
+ that conceptually occurs all day or across multiple days, such as
+ "New Year's Day" or "Italy Vacation". While the time component is
+ important for free-busy calculations and checking for scheduling
+ clashes, calendars may choose to omit displaying it and/or display
+ the object separately to other objects to enhance the user's view of
+ their schedule.
+
+ Such events are also commonly known as "all-day" events.
+
+4.2.5. locations
+
+ Type: "Id[Location]" (optional)
+
+ This is a map of location ids to Location objects, representing
+ locations associated with the object.
+
+ A Location object has the following properties. It MUST have at
+ least one property other than the "relativeTo" property.
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be "Location".
+
+ name: "String" (optional)
+ This is the human-readable name of the location.
+
+ description: "String" (optional)
+ This is the human-readable, plain-text instructions for accessing
+ this location. This may be an address, set of directions, door
+ access code, etc.
+
+ locationTypes: "String[Boolean]" (optional)
+ This is a set of one or more location types that describe this
+ location. All types MUST be from the "Location Types Registry"
+ [LOCATIONTYPES], as defined in [RFC4589]. The set is represented
+ as a map, with the keys being the location types. The value for
+ each key in the map MUST be true.
+
+ relativeTo: "String" (optional)
+ This specifies the relation between this location and the time of
+ the JSCalendar object. This is primarily to allow events
+ representing travel to specify the location of departure (at the
+ start of the event) and location of arrival (at the end); this is
+ particularly important if these locations are in different time
+ zones, as a client may wish to highlight this information for the
+ user.
+
+ This MUST be one of the following values, another value registered
+ in the IANA "JSCalendar Enum Values" registry, or a vendor-
+ specific value (see Section 3.3). Any value the client or server
+ doesn't understand should be treated the same as if this property
+ is omitted.
+
+ "start": The event/task described by this JSCalendar object
+ occurs at this location at the time the event/task starts.
+
+ "end": The event/task described by this JSCalendar object occurs
+ at this location at the time the event/task ends.
+
+ timeZone: "TimeZoneId" (optional)
+ This is a time zone for this location.
+
+ coordinates: "String" (optional)
+ This is a "geo:" URI [RFC5870] for the location.
+
+ links: "Id[Link]" (optional)
+ This is a map of link ids to Link objects, representing external
+ resources associated with this location, for example, a vCard or
+ image. If there are no links, this MUST be omitted (rather than
+ specified as an empty set).
+
+4.2.6. virtualLocations
+
+ Type: "Id[VirtualLocation]" (optional)
+
+ This is a map of virtual location ids to VirtualLocation objects,
+ representing virtual locations, such as video conferences or chat
+ rooms, associated with the object.
+
+ A VirtualLocation object has the following properties.
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be
+ "VirtualLocation".
+
+ name: "String" (optional, default: empty String)
+ This is the human-readable name of the virtual location.
+
+ description: "String" (optional)
+ These are human-readable plain-text instructions for accessing
+ this virtual location. This may be a conference access code, etc.
+
+ uri: "String" (mandatory)
+ This is a URI [RFC3986] that represents how to connect to this
+ virtual location.
+
+ This may be a telephone number (represented using the "tel:"
+ scheme, e.g., "tel:+1-555-555-5555") for a teleconference, a web
+ address for online chat, or any custom URI.
+
+ features: "String[Boolean]" (optional)
+ A set of features supported by this virtual location. The set is
+ represented as a map, with the keys being the feature. The value
+ for each key in the map MUST be true.
+
+ The feature MUST be one of the following values, another value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3). Any value the client or
+ server doesn't understand should be treated the same as if this
+ feature is omitted.
+
+ audio: Audio conferencing
+
+ chat: Chat or instant messaging
+
+ feed: Blog or atom feed
+
+ moderator: Provides moderator-specific features
+
+ phone: Phone conferencing
+
+ screen: Screen sharing
+
+ video: Video conferencing
+
+4.2.7. links
+
+ Type: "Id[Link]" (optional)
+
+ This is a map of link ids to Link objects, representing external
+ resources associated with the object.
+
+ Links with a rel of "enclosure" MUST be considered by the client to
+ be attachments for download.
+
+ Links with a rel of "describedby" MUST be considered by the client to
+ be alternative representations of the description.
+
+ Links with a rel of "icon" MUST be considered by the client to be
+ images that it may use when presenting the calendar data to a user.
+ The "display" property may be set to indicate the purpose of this
+ image.
+
+4.2.8. locale
+
+ Type: "String" (optional)
+
+ This is the language tag, as defined in [RFC5646], that best
+ describes the locale used for the text in the calendar object, if
+ known.
+
+4.2.9. keywords
+
+ Type: "String[Boolean]" (optional)
+
+ This is a set of keywords or tags that relate to the object. The set
+ is represented as a map, with the keys being the keywords. The value
+ for each key in the map MUST be true.
+
+4.2.10. categories
+
+ Type: "String[Boolean]" (optional)
+
+ This is a set of categories that relate to the calendar object. The
+ set is represented as a map, with the keys being the categories
+ specified as URIs. The value for each key in the map MUST be true.
+
+ In contrast to keywords, categories are typically structured. For
+ example, a vendor owning the domain "example.com" might define the
+ categories "http://example.com/categories/sports/american-football"
+ and "http://example.com/categories/music/r-b".
+
+4.2.11. color
+
+ Type: "String" (optional)
+
+ This is a color clients MAY use when displaying this calendar object.
+ The value is a color name taken from the set of names defined in
+ Section 4.3 of CSS Color Module Level 3 [COLORS] or an RGB value in
+ hexadecimal notation, as defined in Section 4.2.1 of CSS Color Module
+ Level 3.
+
+4.3. Recurrence Properties
+
+ Some events and tasks occur at regular or irregular intervals.
+ Rather than having to copy the data for every occurrence, there can
+ be a base event with rules to generate recurrences and/or overrides
+ that add extra dates or exceptions to the rules.
+
+ The recurrence set is the complete set of instances for an object.
+ It is generated by considering the following properties in order, all
+ of which are optional:
+
+ 1. The "recurrenceRules" property (Section 4.3.3) generates a set of
+ extra date-times on which the object occurs.
+
+ 2. The "excludedRecurrenceRules" property (Section 4.3.4) generates
+ a set of date-times that are to be removed from the previously
+ generated set of date-times on which the object occurs.
+
+ 3. The "recurrenceOverrides" property (Section 4.3.5) defines date-
+ times that are added or excluded to form the final set. (This
+ property may also contain changes to the object to apply to
+ particular instances.)
+
+4.3.1. recurrenceId
+
+ Type: "LocalDateTime" (optional)
+
+ If present, this JSCalendar object represents one occurrence of a
+ recurring JSCalendar object. If present, the "recurrenceRules" and
+ "recurrenceOverrides" properties MUST NOT be present.
+
+ The value is a date-time either produced by the "recurrenceRules" of
+ the base event or added as a key to the "recurrenceOverrides"
+ property of the base event.
+
+4.3.2. recurrenceIdTimeZone
+
+ Type: "TimeZoneId|null" (optional, default: null)
+
+ Identifies the time zone of the main JSCalendar object, of which this
+ JSCalendar object is a recurrence instance. This property MUST be
+ set if the "recurrenceId" property is set. It MUST NOT be set if the
+ "recurrenceId" property is not set.
+
+4.3.3. recurrenceRules
+
+ Type: "RecurrenceRule[]" (optional)
+
+ This defines a set of recurrence rules (repeating patterns) for
+ recurring calendar objects.
+
+ An Event recurs by applying the recurrence rules to the "start" date-
+ time.
+
+ A Task recurs by applying the recurrence rules to the "start" date-
+ time, if defined; otherwise, it recurs by the "due" date-time, if
+ defined. If the task defines neither a "start" nor "due" date-time,
+ it MUST NOT define a "recurrenceRules" property.
+
+ If multiple recurrence rules are given, each rule is to be applied,
+ and then the union of the results are used, ignoring any duplicates.
+
+ A RecurrenceRule object is a JSON object mapping of a RECUR value
+ type in iCalendar [RFC5545] [RFC7529] and has the same semantics. It
+ has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be
+ "RecurrenceRule".
+
+ frequency: "String" (mandatory)
+ This is the time span covered by each iteration of this recurrence
+ rule (see Section 4.3.3.1 for full semantics). This MUST be one
+ of the following values:
+
+ * "yearly"
+
+ * "monthly"
+
+ * "weekly"
+
+ * "daily"
+
+ * "hourly"
+
+ * "minutely"
+
+ * "secondly"
+
+ This is the FREQ part from iCalendar, converted to lowercase.
+
+ interval: "UnsignedInt" (optional, default: 1)
+ This is the interval of iteration periods at which the recurrence
+ repeats. If included, it MUST be an integer >= 1.
+
+ This is the INTERVAL part from iCalendar.
+
+ rscale: "String" (optional, default: "gregorian")
+ This is the calendar system in which this recurrence rule
+ operates, in lowercase. This MUST be either a CLDR-registered
+ calendar system name [CLDR] or a vendor-specific value (see
+ Section 3.3).
+
+ This is the RSCALE part from iCalendar RSCALE [RFC7529], converted
+ to lowercase.
+
+ skip: "String" (optional, default: "omit")
+ This is the behavior to use when the expansion of the recurrence
+ produces invalid dates. This property only has an effect if the
+ frequency is "yearly" or "monthly". It MUST be one of the
+ following values:
+
+ * "omit"
+
+ * "backward"
+
+ * "forward"
+
+ This is the SKIP part from iCalendar RSCALE [RFC7529], converted
+ to lowercase.
+
+ firstDayOfWeek: "String" (optional, default: "mo")
+ This is the day on which the week is considered to start,
+ represented as a lowercase, abbreviated, and two-letter English
+ day of the week. If included, it MUST be one of the following
+ values:
+
+ * "mo"
+
+ * "tu"
+
+ * "we"
+
+ * "th"
+
+ * "fr"
+
+ * "sa"
+
+ * "su"
+
+ This is the WKST part from iCalendar.
+
+ byDay: "NDay[]" (optional)
+ These are days of the week on which to repeat. An "NDay" object
+ has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be "NDay".
+
+ day: "String" (mandatory)
+ This is a day of the week on which to repeat; the allowed
+ values are the same as for the "firstDayOfWeek" recurrenceRule
+ property.
+
+ This is the day of the week of the BYDAY part in iCalendar,
+ converted to lowercase.
+
+ nthOfPeriod: "Int" (optional)
+ If present, rather than representing every occurrence of the
+ weekday defined in the "day" property, it represents only a
+ specific instance within the recurrence period. The value can
+ be positive or negative but MUST NOT be zero. A negative
+ integer means the nth-last occurrence within that period (i.e.,
+ -1 is the last occurrence, -2 the one before that, etc.).
+
+ This is the ordinal part of the BYDAY value in iCalendar (e.g.,
+ 1 or -3).
+
+ byMonthDay: "Int[]" (optional)
+ These are the days of the month on which to repeat. Valid values
+ are between 1 and the maximum number of days any month may have in
+ the calendar given by the "rscale" property and the negative
+ values of these numbers. For example, in the Gregorian calendar,
+ valid values are 1 to 31 and -31 to -1. Negative values offset
+ from the end of the month. The array MUST have at least one entry
+ if included.
+
+ This is the BYMONTHDAY part in iCalendar.
+
+ byMonth: "String[]" (optional)
+ These are the months in which to repeat. Each entry is a string
+ representation of a number, starting from "1" for the first month
+ in the calendar (e.g., "1" means January with the Gregorian
+ calendar), with an optional "L" suffix (see [RFC7529]) for leap
+ months (this MUST be uppercase, e.g., "3L"). The array MUST have
+ at least one entry if included.
+
+ This is the BYMONTH part from iCalendar.
+
+ byYearDay: "Int[]" (optional)
+ These are the days of the year on which to repeat. Valid values
+ are between 1 and the maximum number of days any year may have in
+ the calendar given by the "rscale" property and the negative
+ values of these numbers. For example, in the Gregorian calendar,
+ valid values are 1 to 366 and -366 to -1. Negative values offset
+ from the end of the year. The array MUST have at least one entry
+ if included.
+
+ This is the BYYEARDAY part from iCalendar.
+
+ byWeekNo: "Int[]" (optional)
+ These are the weeks of the year in which to repeat. Valid values
+ are between 1 and the maximum number of weeks any year may have in
+ the calendar given by the "rscale" property and the negative
+ values of these numbers. For example, in the Gregorian calendar,
+ valid values are 1 to 53 and -53 to -1. The array MUST have at
+ least one entry if included.
+
+ This is the BYWEEKNO part from iCalendar.
+
+ byHour: "UnsignedInt[]" (optional)
+ These are the hours of the day in which to repeat. Valid values
+ are 0 to 23. The array MUST have at least one entry if included.
+ This is the BYHOUR part from iCalendar.
+
+ byMinute: "UnsignedInt[]" (optional)
+ These are the minutes of the hour in which to repeat. Valid
+ values are 0 to 59. The array MUST have at least one entry if
+ included.
+
+ This is the BYMINUTE part from iCalendar.
+
+ bySecond: "UnsignedInt[]" (optional)
+ These are the seconds of the minute in which to repeat. Valid
+ values are 0 to 60. The array MUST have at least one entry if
+ included.
+
+ This is the BYSECOND part from iCalendar.
+
+ bySetPosition: "Int[]" (optional)
+ These are the occurrences within the recurrence interval to
+ include in the final results. Negative values offset from the end
+ of the list of occurrences. The array MUST have at least one
+ entry if included. This is the BYSETPOS part from iCalendar.
+
+ count: "UnsignedInt" (optional)
+ These are the number of occurrences at which to range-bound the
+ recurrence. This MUST NOT be included if an "until" property is
+ specified.
+
+ This is the COUNT part from iCalendar.
+
+ until: "LocalDateTime" (optional)
+ These are the date-time at which to finish recurring. The last
+ occurrence is on or before this date-time. This MUST NOT be
+ included if a "count" property is specified. Note that if not
+ specified otherwise for a specific JSCalendar object, this date is
+ to be interpreted in the time zone specified in the JSCalendar
+ object's "timeZone" property.
+
+ This is the UNTIL part from iCalendar.
+
+4.3.3.1. Interpreting Recurrence Rules
+
+ A recurrence rule specifies a set of date-times for recurring
+ calendar objects. A recurrence rule has the following semantics.
+ Note that wherever "year", "month", or "day of month" is used, this
+ is within the calendar system given by the "rscale" property, which
+ defaults to "gregorian" if omitted.
+
+ 1. A set of candidates is generated. This is every second within a
+ period defined by the "frequency" property value:
+
+ "yearly": every second from midnight on the first day of a year
+ (inclusive) to midnight the first day of the following year
+ (exclusive).
+
+ If skip is not "omit", the calendar system has leap months,
+ and there is a "byMonth" property, generate candidates for the
+ leap months, even if they don't occur in this year.
+
+ If skip is not "omit" and there is a "byMonthDay" property,
+ presume each month has the maximum number of days any month
+ may have in this calendar system when generating candidates,
+ even if it's more than this month actually has.
+
+ "monthly": every second from midnight on the first day of a
+ month (inclusive) to midnight on the first of the following
+ month (exclusive).
+
+ If skip is not "omit" and there is a "byMonthDay" property,
+ presume the month has the maximum number of days any month may
+ have in this calendar system when generating candidates, even
+ if it's more than this month actually has.
+
+ "weekly": every second from midnight (inclusive) on the first
+ day of the week (as defined by the "firstDayOfWeek" property
+ or Monday if omitted) to midnight seven days later
+ (exclusive).
+
+ "daily": every second from midnight at the start of the day
+ (inclusive) to midnight at the end of the day (exclusive).
+
+ "hourly": every second from the beginning of the hour
+ (inclusive) to the beginning of the next hour (exclusive).
+
+ "minutely": every second from the beginning of the minute
+ (inclusive) to the beginning of the next minute (exclusive).
+
+ "secondly": only the second itself.
+
+ 2. Each date-time candidate is compared against all of the byX
+ properties of the rule except bySetPosition. If any property in
+ the rule does not match the date-time, the date-time is
+ eliminated. Each byX property is an array; the date-time matches
+ the property if it matches any of the values in the array. The
+ properties have the following semantics:
+
+ byMonth: The date-time is in the given month.
+
+ byWeekNo: The date-time is in the nth week of the year.
+ Negative numbers mean the nth last week of the year. This
+ corresponds to weeks according to week numbering, as defined
+ in ISO.8601.2004, with a week defined as a seven-day period,
+ starting on the "firstDayOfWeek" property value or Monday if
+ omitted. Week number one of the calendar year is the first
+ week that contains at least four days in that calendar year.
+
+ If the date-time is not valid (this may happen when generating
+ candidates with a "skip" property in effect), it is always
+ eliminated by this property.
+
+ byYearDay: The date-time is on the nth day of year. Negative
+ numbers mean the nth last day of the year.
+
+ If the date-time is not valid (this may happen when generating
+ candidates with a "skip" property in effect), it is always
+ eliminated by this property.
+
+ byMonthDay: The date-time is on the given day of the month.
+ Negative numbers mean the nth last day of the month.
+
+ byDay: The date-time is on the given day of the week. If the
+ day is prefixed by a number, it is the nth occurrence of that
+ day of the week within the month (if frequency is monthly) or
+ year (if frequency is yearly). Negative numbers mean the nth
+ last occurrence within that period.
+
+ byHour: The date-time has the given hour value.
+
+ byMinute: The date-time has the given minute value.
+
+ bySecond: The date-time has the given second value.
+
+ If a "skip" property is defined and is not "omit", there may be
+ candidates that do not correspond to valid dates (e.g., February
+ 31st in the Gregorian calendar). In this case, the properties
+ MUST be considered in the order above, and:
+
+ 1. After applying the byMonth filter, if the candidate's month
+ is invalid for the given year, increment it (if skip is
+ "forward") or decrement it (if skip is "backward") until a
+ valid month is found, incrementing/decrementing the year as
+ well if passing through the beginning/end of the year. This
+ only applies to calendar systems with leap months.
+
+ 2. After applying the byMonthDay filter, if the day of the month
+ is invalid for the given month and year, change the date to
+ the first day of the next month (if skip is "forward") or the
+ last day of the current month (if skip is "backward").
+
+ 3. If any valid date produced after applying the skip is already
+ a candidate, eliminate the duplicate. (For example, after
+ adjusting, February 30th and February 31st would both become
+ the same "real" date, so one is eliminated as a duplicate.)
+
+ 3. If a "bySetPosition" property is included, this is now applied to
+ the ordered list of remaining dates. This property specifies the
+ indexes of date-times to keep; all others should be eliminated.
+ Negative numbers are indexed from the end of the list, with -1
+ being the last item, -2 the second from last, etc.
+
+ 4. Any date-times before the start date of the event are eliminated
+ (see below for why this might be needed).
+
+ 5. If a "skip" property is included and is not "omit", eliminate any
+ date-times that have already been produced by previous iterations
+ of the algorithm. (This is not possible if skip is "omit".)
+
+ 6. If further dates are required (we have not reached the until date
+ or count limit), skip the next (interval - 1) sets of candidates,
+ then continue from step 1.
+
+ When determining the set of occurrence dates for an event or task,
+ the following extra rules must be applied:
+
+ 1. The initial date-time to which the rule is applied (the "start"
+ date-time for events or the "start" or "due" date-time for tasks)
+ is always the first occurrence in the expansion (and is counted
+ if the recurrence is limited by a "count" property), even if it
+ would normally not match the rule.
+
+ 2. The first set of candidates to consider is that which would
+ contain the initial date-time. This means the first set may
+ include candidates before the initial date-time; such candidates
+ are eliminated from the results in step 4 of the list above.
+
+ 3. The following properties MUST be implicitly added to the rule
+ under the given conditions:
+
+ * If frequency is not "secondly" and there is no "bySecond"
+ property, add a "bySecond" property with the sole value being
+ the seconds value of the initial date-time.
+
+ * If frequency is not "secondly" or "minutely" and there is no
+ "byMinute" property, add a "byMinute" property with the sole
+ value being the minutes value of the initial date-time.
+
+ * If frequency is not "secondly", "minutely", or "hourly" and
+ there is no "byHour" property, add a "byHour" property with
+ the sole value being the hours value of the initial date-time.
+
+ * If frequency is "weekly" and there is no "byDay" property, add
+ a "byDay" property with the sole value being the day of the
+ week of the initial date-time.
+
+ * If frequency is "monthly" and there is no "byDay" property and
+ no "byMonthDay" property, add a "byMonthDay" property with the
+ sole value being the day of the month of the initial date-
+ time.
+
+ * If frequency is "yearly" and there is no "byYearDay" property:
+
+ - If there are no "byMonth" or "byWeekNo" properties, and
+ either there is a "byMonthDay" property or there is no
+ "byDay" property, add a "byMonth" property with the sole
+ value being the month of the initial date-time.
+
+ - If there are no "byMonthDay", "byWeekNo", or "byDay"
+ properties, add a "byMonthDay" property with the sole value
+ being the day of the month of the initial date-time.
+
+ - If there is a "byWeekNo" property and no "byMonthDay" or
+ "byDay" properties, add a "byDay" property with the sole
+ value being the day of the week of the initial date-time.
+
+4.3.4. excludedRecurrenceRules
+
+ Type: "RecurrenceRule[]" (optional)
+
+ This defines a set of recurrence rules (repeating patterns) for date-
+ times on which the object will not occur. The rules are interpreted
+ the same as for the "recurrenceRules" property (see Section 4.3.3),
+ with the exception that the initial date-time to which the rule is
+ applied (the "start" date-time for events or the "start" or "due"
+ date-time for tasks) is only considered part of the expansion if it
+ matches the rule. The resulting set of date-times is then removed
+ from those generated by the "recurrenceRules" property, as described
+ in Section 4.3.
+
+4.3.5. recurrenceOverrides
+
+ Type: "LocalDateTime[PatchObject]" (optional)
+
+ Maps recurrence ids (the date-time produced by the recurrence rule)
+ to the overridden properties of the recurrence instance.
+
+ If the recurrence id does not match a date-time from the recurrence
+ rule (or no rule is specified), it is to be treated as an additional
+ occurrence (like an RDATE from iCalendar). The patch object may
+ often be empty in this case.
+
+ If the patch object defines the "excluded" property of an occurrence
+ to be true, this occurrence is omitted from the final set of
+ recurrences for the calendar object (like an EXDATE from iCalendar).
+ Such a patch object MUST NOT patch any other property.
+
+ By default, an occurrence inherits all properties from the main
+ object except the start (or due) date-time, which is shifted to match
+ the recurrence id LocalDateTime. However, individual properties of
+ the occurrence can be modified by a patch or multiple patches. It is
+ valid to patch the "start" property value, and this patch takes
+ precedence over the value generated from the recurrence id. Both the
+ recurrence id as well as the patched "start" date-time may occur
+ before the original JSCalendar object's "start" or "due" date.
+
+ A pointer in the PatchObject MUST be ignored if it starts with one of
+ the following prefixes:
+
+ * @type
+
+ * excludedRecurrenceRules
+
+ * method
+
+ * privacy
+
+ * prodId
+
+ * recurrenceId
+
+ * recurrenceIdTimeZone
+
+ * recurrenceOverrides
+
+ * recurrenceRules
+
+ * relatedTo
+
+ * replyTo
+
+ * sentBy
+
+ * timeZones
+
+ * uid
+
+4.3.6. excluded
+
+ Type: "Boolean" (optional, default: false)
+
+ This defines if this object is an overridden, excluded instance of a
+ recurring JSCalendar object (see Section 4.3.5). If this property
+ value is true, this calendar object instance MUST be removed from the
+ occurrence expansion. The absence of this property, or the presence
+ of its default value as false, indicates that this instance MUST be
+ included in the occurrence expansion.
+
+4.4. Sharing and Scheduling Properties
+
+4.4.1. priority
+
+ Type: "Int" (optional, default: 0)
+
+ This specifies a priority for the calendar object. This may be used
+ as part of scheduling systems to help resolve conflicts for a time
+ period.
+
+ The priority is specified as an integer in the range 0 to 9. A value
+ of 0 specifies an undefined priority, for which the treatment will
+ vary by situation. A value of 1 is the highest priority. A value of
+ 2 is the second highest priority. Subsequent numbers specify a
+ decreasing ordinal priority. A value of 9 is the lowest priority.
+ Other integer values are reserved for future use.
+
+4.4.2. freeBusyStatus
+
+ Type: "String" (optional, default: "busy")
+
+ This specifies how this calendar object should be treated when
+ calculating free-busy state. This MUST be one of the following
+ values, another value registered in the IANA "JSCalendar Enum Values"
+ registry, or a vendor-specific value (see Section 3.3):
+
+ "free": The object should be ignored when calculating whether the
+ user is busy.
+
+ "busy": The object should be included when calculating whether the
+ user is busy.
+
+4.4.3. privacy
+
+ Type: "String" (optional, default: "public")
+
+ Calendar objects are normally collected together and may be shared
+ with other users. The privacy property allows the object owner to
+ indicate that it should not be shared or should only have the time
+ information shared but the details withheld. Enforcement of the
+ restrictions indicated by this property is up to the API via which
+ this object is accessed.
+
+ This property MUST NOT affect the information sent to scheduled
+ participants; it is only interpreted by protocols that share the
+ calendar objects belonging to one user with other users.
+
+ The value MUST be one of the following values, another value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3). Any value the client or
+ server doesn't understand should be preserved but treated as
+ equivalent to "private".
+
+ "public": The full details of the object are visible to those whom
+ the object's calendar is shared with.
+
+ "private": The details of the object are hidden; only the basic time
+ and metadata are shared. The following properties MAY be shared;
+ any other properties MUST NOT be shared:
+
+ * @type
+
+ * created
+
+ * due
+
+ * duration
+
+ * estimatedDuration
+
+ * freeBusyStatus
+
+ * privacy
+
+ * recurrenceOverrides (Only patches that apply to another
+ permissible property are allowed to be shared.)
+
+ * sequence
+
+ * showWithoutTime
+
+ * start
+
+ * timeZone
+
+ * timeZones
+
+ * uid
+
+ * updated
+
+ "secret": The object is hidden completely (as though it did not
+ exist) when the calendar this object is in is shared.
+
+4.4.4. replyTo
+
+ Type: "String[String]" (optional)
+
+ This represents methods by which participants may submit their
+ response to the organizer of the calendar object. The keys in the
+ property value are the available methods and MUST only contain ASCII
+ alphanumeric characters (A-Za-z0-9). The value is a URI for the
+ method specified in the key. Future methods may be defined in future
+ specifications and registered with IANA; a calendar client MUST
+ ignore any method it does not understand but MUST preserve the method
+ key and URI. This property MUST be omitted if no method is defined
+ (rather than being specified as an empty object).
+
+ The following methods are defined:
+
+ "imip": The organizer accepts an iCalendar Message-Based
+ Interoperability Protocol (iMIP) [RFC6047] response at this email
+ address. The value MUST be a "mailto:" URI.
+
+ "web": Opening this URI in a web browser will provide the user with
+ a page where they can submit a reply to the organizer. The value
+ MUST be a URL using the "https:" scheme.
+
+ "other": The organizer is identified by this URI, but the method for
+ submitting the response is undefined.
+
+4.4.5. sentBy
+
+ Type: "String" (optional)
+
+ This is the email address in the "From" header of the email in which
+ this calendar object was received. This is only relevant if the
+ calendar object is received via iMIP or as an attachment to a
+ message. If set, the value MUST be a valid "addr-spec" value as
+ defined in Section 3.4.1 of [RFC5322].
+
+4.4.6. participants
+
+ Type: "Id[Participant]" (optional)
+
+ This is a map of participant ids to participants, describing their
+ participation in the calendar object.
+
+ If this property is set and any participant has a "sendTo" property,
+ then the "replyTo" property of this calendar object MUST define at
+ least one reply method.
+
+ A Participant object has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be
+ "Participant".
+
+ name: "String" (optional)
+ This is the display name of the participant (e.g., "Joe Bloggs").
+
+ email: "String" (optional)
+ This is the email address to use to contact the participant or,
+ for example, match with an address book entry. If set, the value
+ MUST be a valid "addr-spec" value as defined in Section 3.4.1 of
+ [RFC5322].
+
+ description: "String" (optional)
+ This is a plain-text description of this participant. For
+ example, this may include more information about their role in the
+ event or how best to contact them.
+
+ sendTo: "String[String]" (optional)
+ This represents methods by which the participant may receive the
+ invitation and updates to the calendar object.
+
+ The keys in the property value are the available methods and MUST
+ only contain ASCII alphanumeric characters (A-Za-z0-9). The value
+ is a URI for the method specified in the key. Future methods may
+ be defined in future specifications and registered with IANA; a
+ calendar client MUST ignore any method it does not understand but
+ MUST preserve the method key and URI. This property MUST be
+ omitted if no method is defined (rather than being specified as an
+ empty object).
+
+ The following methods are defined:
+
+ "imip": The participant accepts an iMIP [RFC6047] request at this
+ email address. The value MUST be a "mailto:" URI. It MAY be
+ different from the value of the participant's "email" property.
+
+ "other": The participant is identified by this URI, but the
+ method for submitting the invitation is undefined.
+
+ kind: "String" (optional)
+ This is what kind of entity this participant is, if known.
+
+ This MUST be one of the following values, another value registered
+ in the IANA "JSCalendar Enum Values" registry, or a vendor-
+ specific value (see Section 3.3). Any value the client or server
+ doesn't understand should be treated the same as if this property
+ is omitted.
+
+ "individual": a single person
+
+ "group": a collection of people invited as a whole
+
+ "location": a physical location that needs to be scheduled, e.g.,
+ a conference room
+
+ "resource": a non-human resource other than a location, such as a
+ projector
+
+ roles: "String[Boolean]" (mandatory)
+ This is a set of roles that this participant fulfills.
+
+ At least one role MUST be specified for the participant. The keys
+ in the set MUST be one of the following values, another value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3):
+
+ "owner": The participant is an owner of the object. This
+ signifies they have permission to make changes to it that
+ affect the other participants. Nonowner participants may only
+ change properties that affect only themselves (for example,
+ setting their own alerts or changing their RSVP status).
+
+ "attendee": The participant is expected to be present at the
+ event.
+
+ "optional": The participant's involvement with the event is
+ optional. This is expected to be primarily combined with the
+ "attendee" role.
+
+ "informational": The participant is copied for informational
+ reasons and is not expected to attend.
+
+ "chair": The participant is in charge of the event/task when it
+ occurs.
+
+ "contact": The participant is someone that may be contacted for
+ information about the event.
+
+ The value for each key in the map MUST be true. It is expected
+ that no more than one of the roles "attendee" and "informational"
+ be present; if more than one are given, "attendee" takes
+ precedence over "informational". Roles that are unknown to the
+ implementation MUST be preserved.
+
+ locationId: "Id" (optional)
+ This is the location at which this participant is expected to be
+ attending.
+
+ If the value does not correspond to any location id in the
+ "locations" property of the JSCalendar object, this MUST be
+ treated the same as if the participant's locationId were omitted.
+
+ language: "String" (optional)
+ This is the language tag, as defined in [RFC5646], that best
+ describes the participant's preferred language, if known.
+
+ participationStatus: "String" (optional, default: "needs-action")
+ This is the participation status, if any, of this participant.
+
+ The value MUST be one of the following values, another value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3):
+
+ "needs-action": No status has yet been set by the participant.
+
+ "accepted": The invited participant will participate.
+
+ "declined": The invited participant will not participate.
+
+ "tentative": The invited participant may participate.
+
+ "delegated": The invited participant has delegated their
+ attendance to another participant, as specified in the
+ "delegatedTo" property.
+
+ participationComment: "String" (optional)
+ This is a note from the participant to explain their participation
+ status.
+
+ expectReply: "Boolean" (optional, default: false)
+ If true, the organizer is expecting the participant to notify them
+ of their participation status.
+
+ scheduleAgent: "String" (optional, default: "server")
+ This is who is responsible for sending scheduling messages with
+ this calendar object to the participant.
+
+ The value MUST be one of the following values, another value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3):
+
+ "server": The calendar server will send the scheduling messages.
+
+ "client": The calendar client will send the scheduling messages.
+
+ "none": No scheduling messages are to be sent to this
+ participant.
+
+ scheduleForceSend: "Boolean" (optional, default: false)
+ A client may set the property on a participant to true to request
+ that the server send a scheduling message to the participant when
+ it would not normally do so (e.g., if no significant change is
+ made the object or the scheduleAgent is set to client). The
+ property MUST NOT be stored in the JSCalendar object on the server
+ or appear in a scheduling message.
+
+ scheduleSequence: "UnsignedInt" (optional, default: 0)
+ This is the sequence number of the last response from the
+ participant. If defined, this MUST be a nonnegative integer.
+
+ This can be used to determine whether the participant has sent a
+ new response following significant changes to the calendar object
+ and to determine if future responses are responding to a current
+ or older view of the data.
+
+ scheduleStatus: "String[]" (optional)
+ This is a list of status codes, returned from the processing of
+ the most recent scheduling message sent to this participant. The
+ status codes MUST be valid "statcode" values as defined in the
+ ABNF in Section 3.8.8.3 of [RFC5545].
+
+ Servers MUST only add or change this property when they send a
+ scheduling message to the participant. Clients SHOULD NOT change
+ or remove this property if it was provided by the server. Clients
+ MAY add, change, or remove the property for participants where the
+ client is handling the scheduling.
+
+ This property MUST NOT be included in scheduling messages.
+
+ scheduleUpdated: "UTCDateTime" (optional)
+ This is the timestamp for the most recent response from this
+ participant.
+
+ This is the "updated" property of the last response when using
+ iTIP. It can be compared to the "updated" property in future
+ responses to detect and discard older responses delivered out of
+ order.
+
+ sentBy: "String" (optional)
+ This is the email address in the "From" header of the email that
+ last updated this participant via iMIP. This SHOULD only be set
+ if the email address is different to that in the mailto URI of
+ this participant's "imip" method in the "sendTo" property (i.e.,
+ the response was received from a different address to that which
+ the invitation was sent to). If set, the value MUST be a valid
+ "addr-spec" value as defined in Section 3.4.1 of [RFC5322].
+
+ invitedBy: "Id" (optional)
+ This is the id of the participant who added this participant to
+ the event/task, if known.
+
+ delegatedTo: "Id[Boolean]" (optional)
+ This is set of participant ids that this participant has delegated
+ their participation to. Each key in the set MUST be the id of a
+ participant. The value for each key in the map MUST be true. If
+ there are no delegates, this MUST be omitted (rather than
+ specified as an empty set).
+
+ delegatedFrom: "Id[Boolean]" (optional)
+ This is a set of participant ids that this participant is acting
+ as a delegate for. Each key in the set MUST be the id of a
+ participant. The value for each key in the map MUST be true. If
+ there are no delegators, this MUST be omitted (rather than
+ specified as an empty set).
+
+ memberOf: "Id[Boolean]" (optional)
+ This is a set of group participants that were invited to this
+ calendar object, which caused this participant to be invited due
+ to their membership in the group(s). Each key in the set MUST be
+ the id of a participant. The value for each key in the map MUST
+ be true. If there are no groups, this MUST be omitted (rather
+ than specified as an empty set).
+
+ links: "Id[Link]" (optional)
+ This is a map of link ids to Link objects, representing external
+ resources associated with this participant, for example, a vCard
+ or image. If there are no links, this MUST be omitted (rather
+ than specified as an empty set).
+
+ progress: "String" (optional; only allowed for participants of a
+ Task)
+ This represents the progress of the participant for this task. It
+ MUST NOT be set if the "participationStatus" of this participant
+ is any value other than "accepted". See Section 5.2.5 for allowed
+ values and semantics.
+
+ progressUpdated: "UTCDateTime" (optional; only allowed for
+ participants of a Task)
+ This specifies the date-time the "progress" property was last set
+ on this participant. See Section 5.2.6 for allowed values and
+ semantics.
+
+ percentComplete: "UnsignedInt" (optional; only allowed for
+ participants of a Task)
+ This represents the percent completion of the participant for this
+ task. The property value MUST be a positive integer between 0 and
+ 100.
+
+4.4.7. requestStatus
+
+ Type: "String" (optional)
+
+ A request status as returned from processing the most recent
+ scheduling request for this JSCalendar object. The allowed values
+ are defined by the ABNF definitions of "statcode", "statdesc" and
+ "extdata" in Section 3.8.8.3 of [RFC5545] and the following ABNF
+ [RFC5234]:
+
+ reqstatus = statcode ";" statdesc [";" extdata]
+
+ Servers MUST only add or change this property when they performe a
+ scheduling action. Clients SHOULD NOT change or remove this property
+ if it was provided by the server. Clients MAY add, change, or remove
+ the property when the client is handling the scheduling.
+
+ This property MUST only be included in scheduling messages according
+ to the rules defined for the REQUEST-STATUS iCalendar property in
+ [RFC5546].
+
+4.5. Alerts Properties
+
+4.5.1. useDefaultAlerts
+
+ Type: "Boolean" (optional, default: false)
+
+ If true, use the user's default alerts and ignore the value of the
+ "alerts" property. Fetching user defaults is dependent on the API
+ from which this JSCalendar object is being fetched and is not defined
+ in this specification. If an implementation cannot determine the
+ user's default alerts, or none are set, it MUST process the "alerts"
+ property as if "useDefaultAlerts" is set to false.
+
+4.5.2. alerts
+
+ Type: "Id[Alert]" (optional)
+
+ This is a map of alert ids to Alert objects, representing alerts/
+ reminders to display or send to the user for this calendar object.
+
+ An Alert object has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be "Alert".
+
+ trigger: "OffsetTrigger|AbsoluteTrigger|UnknownTrigger"
+ (mandatory)
+ This defines when to trigger the alert. New types may be defined
+ in future documents.
+
+ An "OffsetTrigger" object has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be
+ "OffsetTrigger".
+
+ offset: "SignedDuration" (mandatory)
+ This defines the offset at which to trigger the alert relative
+ to the time property defined in the "relativeTo" property of
+ the alert. Negative durations signify alerts before the time
+ property; positive durations signify alerts after the time
+ property.
+
+ relativeTo: "String" (optional, default: "start")
+ This specifies the time property that the alert offset is
+ relative to. The value MUST be one of the following:
+
+ "start": triggers the alert relative to the start of the
+ calendar object
+
+ "end": triggers the alert relative to the end/due time of the
+ calendar object
+
+ An "AbsoluteTrigger" object has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be
+ "AbsoluteTrigger".
+
+ when: "UTCDateTime" (mandatory)
+ This defines a specific UTC date-time when the alert is
+ triggered.
+
+ An "UnknownTrigger" object is an object that contains an "@type"
+ property whose value is not recognized (i.e., not "OffsetTrigger"
+ or "AbsoluteTrigger") plus zero or more other properties. This is
+ for compatibility with client extensions and future
+ specifications. Implementations SHOULD NOT trigger for trigger
+ types they do not understand but MUST preserve them.
+
+ acknowledged: "UTCDateTime" (optional)
+ This records when an alert was last acknowledged. This is set
+ when the user has dismissed the alert; other clients that sync
+ this property SHOULD automatically dismiss or suppress duplicate
+ alerts (alerts with the same alert id that triggered on or before
+ this date-time).
+
+ For a recurring calendar object, setting the "acknowledged"
+ property MUST NOT add a new override to the "recurrenceOverrides"
+ property. If the alert is not already overridden, the
+ "acknowledged" property MUST be set on the alert in the base
+ event/task.
+
+ Certain kinds of alert action may not provide feedback as to when
+ the user sees them, for example, email-based alerts. For those
+ kinds of alerts, this property MUST be set immediately when the
+ alert is triggered and the action is successfully carried out.
+
+ relatedTo: "String[Relation]" (optional)
+ This relates this alert to other alerts in the same JSCalendar
+ object. If the user wishes to snooze an alert, the application
+ MUST create an alert to trigger after snoozing. This new snooze
+ alert MUST set a parent relation to the identifier of the original
+ alert.
+
+ action: "String" (optional, default: "display")
+ This describes how to alert the user.
+
+ The value MUST be at most one of the following values, a value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3):
+
+ "display": The alert should be displayed as appropriate for the
+ current device and user context.
+
+ "email": The alert should trigger an email sent out to the user,
+ notifying them of the alert. This action is typically only
+ appropriate for server implementations.
+
+4.6. Multilingual Properties
+
+4.6.1. localizations
+
+ Type: "String[PatchObject]" (optional)
+
+ A map where each key is a language tag [RFC5646], and the
+ corresponding value is a set of patches to apply to the calendar
+ object in order to localize it into that locale.
+
+ See the description of PatchObject (Section 1.4.9) for the structure
+ of the PatchObject. The patches are applied to the top-level
+ calendar object. In addition, the "locale" property of the patched
+ object is set to the language tag. All pointers for patches MUST end
+ with one of the following suffixes; any patch that does not follow
+ this MUST be ignored unless otherwise specified in a future RFC:
+
+ * title
+
+ * description
+
+ * name
+
+ A patch MUST NOT have the prefix "recurrenceOverrides"; any
+ localization of the override MUST be a patch to the "localizations"
+ property inside the override instead. For example, a patch to
+ "locations/abcd1234/title" is permissible, but a patch to "uid" or
+ "recurrenceOverrides/2020-01-05T14:00:00/title" is not.
+
+ Note that this specification does not define how to maintain validity
+ of localized content. For example, a client application changing a
+ JSCalendar object's "title" property might also need to update any
+ localizations of this property. Client implementations SHOULD
+ provide the means to manage localizations, but how to achieve this is
+ specific to the application's workflow and requirements.
+
+4.7. Time Zone Properties
+
+4.7.1. timeZone
+
+ Type: "TimeZoneId|null" (optional, default: null)
+
+ This identifies the time zone the object is scheduled in or is null
+ for floating time. This is either a name from the IANA Time Zone
+ Database [TZDB] or the TimeZoneId of a custom time zone from the
+ "timeZones" property (Section 4.7.2). If omitted, this MUST be
+ presumed to be null (i.e., floating time).
+
+4.7.2. timeZones
+
+ Type: "TimeZoneId[TimeZone]" (optional)
+
+ This maps identifiers of custom time zones to their time zone
+ definitions. The following restrictions apply for each key in the
+ map:
+
+ * To avoid conflict with names in the IANA Time Zone Database
+ [TZDB], it MUST start with the "/" character.
+
+ * It MUST be a valid "paramtext" value, as specified in Section 3.1
+ of [RFC5545].
+
+ * At least one other property in the same JSCalendar object MUST
+ reference a time zone using this identifier (i.e., orphaned time
+ zones are not allowed).
+
+ An identifier need only be unique to this JSCalendar object. It MAY
+ differ from the "tzId" property value of the TimeZone object it maps
+ to.
+
+ A JSCalendar object may be part of a hierarchy of other JSCalendar
+ objects (say, an Event is an entry in a Group). In this case, the
+ set of time zones is the sum of the time zone definitions of this
+ object and its parent objects. If multiple time zones with the same
+ identifier exist, then the definition closest to the calendar object
+ in relation to its parents MUST be used. (In context of Event, a
+ time zone definition in its "timeZones" property has precedence over
+ a definition of the same id in the Group). Time zone definitions in
+ any children of the calendar object MUST be ignored.
+
+ A TimeZone object maps a VTIMEZONE component from iCalendar, and the
+ semantics are as defined in [RFC5545]. A valid time zone MUST define
+ at least one transition rule in the "standard" or "daylight"
+ property. Its properties are:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be "TimeZone".
+
+ tzId: "String" (mandatory)
+ This is the TZID property from iCalendar. Note that this implies
+ that the value MUST be a valid "paramtext" value as specified in
+ Section 3.1. of [RFC5545].
+
+ updated: "UTCDateTime" (optional)
+ This is the LAST-MODIFIED property from iCalendar.
+
+ url: "String" (optional)
+ This is the TZURL property from iCalendar.
+
+ validUntil: "UTCDateTime" (optional)
+ This is the TZUNTIL property from iCalendar, specified in
+ [RFC7808].
+
+ aliases: "String[Boolean]" (optional)
+ This maps the TZID-ALIAS-OF properties from iCalendar, specified
+ in [RFC7808], to a JSON set of aliases. The set is represented as
+ an object, with the keys being the aliases. The value for each
+ key in the map MUST be true.
+
+ standard: "TimeZoneRule[]" (optional)
+ This the STANDARD sub-components from iCalendar. The order MUST
+ be preserved during conversion.
+
+ daylight: "TimeZoneRule[]" (optional)
+ This the DAYLIGHT sub-components from iCalendar. The order MUST
+ be preserved during conversion.
+
+ A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component from
+ iCalendar, with the restriction that, at most, one recurrence rule is
+ allowed per rule. It has the following properties:
+
+ @type: "String" (mandatory)
+ This specifies the type of this object. This MUST be
+ "TimeZoneRule".
+
+ start: "LocalDateTime" (mandatory)
+ This is the DTSTART property from iCalendar.
+
+ offsetFrom: "String" (mandatory)
+ This is the TZOFFSETFROM property from iCalendar.
+
+ offsetTo: "String" (mandatory)
+ This is the TZOFFSETTO property from iCalendar.
+
+ recurrenceRules: "RecurrenceRule[]" (optional)
+ This is the RRULE property mapped, as specified in Section 4.3.3.
+ During recurrence rule evaluation, the "until" property value MUST
+ be interpreted as a local time in the UTC time zone.
+
+ recurrenceOverrides: "LocalDateTime[PatchObject]" (optional)
+ This maps the RDATE properties from iCalendar. The set is
+ represented as an object, with the keys being the recurrence
+ dates. The patch object MUST be the empty JSON object ({}).
+
+ names: "String[Boolean]" optional)
+ This maps the TZNAME properties from iCalendar to a JSON set. The
+ set is represented as an object, with the keys being the names,
+ excluding any "tznparam" component from iCalendar. The value for
+ each key in the map MUST be true.
+
+ comments: "String[]" (optional)
+ This maps the COMMENT properties from iCalendar. The order MUST
+ be preserved during conversion.
+
+5. Type-Specific JSCalendar Properties
+
+5.1. Event Properties
+
+ In addition to the common JSCalendar object properties (Section 4),
+ an Event has the following properties:
+
+5.1.1. start
+
+ Type: "LocalDateTime" (mandatory)
+
+ This is the date/time the event starts in the event's time zone (as
+ specified in the "timeZone" property, see Section 4.7.1).
+
+5.1.2. duration
+
+ Type: "Duration" (optional, default: "PT0S")
+
+ This is the zero or positive duration of the event in the event's
+ start time zone. The end time of an event can be found by adding the
+ duration to the event's start time.
+
+ An Event MAY involve start and end locations that are in different
+ time zones (e.g., a transcontinental flight). This can be expressed
+ using the "relativeTo" and "timeZone" properties of the Event's
+ Location objects (see Section 4.2.5).
+
+5.1.3. status
+
+ Type: "String" (optional, default: "confirmed")
+
+ This is the scheduling status (Section 4.4) of an Event. If set, it
+ MUST be one of the following values, another value registered in the
+ IANA "JSCalendar Enum Values" registry, or a vendor-specific value
+ (see Section 3.3):
+
+ "confirmed": indicates the event is definitely happening
+
+ "cancelled": indicates the event has been cancelled
+
+ "tentative": indicates the event may happen
+
+5.2. Task Properties
+
+ In addition to the common JSCalendar object properties (Section 4), a
+ Task has the following properties:
+
+5.2.1. due
+
+ Type: "LocalDateTime" (optional)
+
+ This is the date/time the task is due in the task's time zone.
+
+5.2.2. start
+
+ Type: "LocalDateTime" (optional)
+
+ This the date/time the task should start in the task's time zone.
+
+5.2.3. estimatedDuration
+
+ Type: "Duration" (optional)
+
+ This specifies the estimated positive duration of time the task takes
+ to complete.
+
+5.2.4. percentComplete
+
+ Type: "UnsignedInt" (optional)
+
+ This represents the percent completion of the task overall. The
+ property value MUST be a positive integer between 0 and 100.
+
+5.2.5. progress
+
+ Type: "String" (optional)
+
+ This defines the progress of this task. If omitted, the default
+ progress (Section 4.4) of a Task is defined as follows (in order of
+ evaluation):
+
+ "completed": if the "progress" property value of all participants is
+ "completed"
+
+ "failed": if at least one "progress" property value of a participant
+ is "failed"
+
+ "in-process": if at least one "progress" property value of a
+ participant is "in-process"
+
+ "needs-action": if none of the other criteria match
+
+ If set, it MUST be one of the following values, another value
+ registered in the IANA "JSCalendar Enum Values" registry, or a
+ vendor-specific value (see Section 3.3):
+
+ "needs-action": indicates the task needs action
+
+ "in-process": indicates the task is in process
+
+ "completed": indicates the task is completed
+
+ "failed": indicates the task failed
+
+ "cancelled": indicates the task was cancelled
+
+5.2.6. progressUpdated
+
+ Type: "UTCDateTime" (optional)
+
+ This specifies the date/time the "progress" property of either the
+ task overall (Section 5.2.5) or a specific participant
+ (Section 4.4.6) was last updated.
+
+ If the task is recurring and has future instances, a client may want
+ to keep track of the last progress update timestamp of a specific
+ task recurrence but leave other instances unchanged. One way to
+ achieve this is by overriding the "progressUpdated" property in the
+ task "recurrenceOverrides" property. However, this could produce a
+ long list of timestamps for regularly recurring tasks. An
+ alternative approach is to split the Task into a current, single
+ instance of Task with this instance progress update time and a future
+ recurring instance. See also Section 4.1.3 on splitting.
+
+5.3. Group Properties
+
+ Group supports the following common JSCalendar properties
+ (Section 4):
+
+ * @type
+
+ * uid
+
+ * prodId
+
+ * created
+
+ * updated
+
+ * title
+
+ * description
+
+ * descriptionContentType
+
+ * links
+
+ * locale
+
+ * keywords
+
+ * categories
+
+ * color
+
+ * timeZones
+
+ In addition, the following Group-specific properties are supported:
+
+5.3.1. entries
+
+ Type: "(Task|Event)[]" (mandatory)
+
+ This is a collection of group members. Implementations MUST ignore
+ entries of unknown type.
+
+5.3.2. source
+
+ Type: "String" (optional)
+
+ This is the source from which updated versions of this group may be
+ retrieved. The value MUST be a URI.
+
+6. Examples
+
+ The following examples illustrate several aspects of the JSCalendar
+ data model and format. The examples may omit mandatory or additional
+ properties, which is indicated by a placeholder property with key
+ "...". While most of the examples use calendar event objects, they
+ are also illustrative for tasks.
+
+6.1. Simple Event
+
+ This example illustrates a simple one-time event. It specifies a
+ one-time event that begins on January 15, 2020 at 1 pm New York local
+ time and ends after 1 hour.
+
+ {
+ "@type": "Event",
+ "uid": "a8df6573-0474-496d-8496-033ad45d7fea",
+ "updated": "2020-01-02T18:23:04Z",
+ "title": "Some event",
+ "start": "2020-01-15T13:00:00",
+ "timeZone": "America/New_York",
+ "duration": "PT1H"
+ }
+
+6.2. Simple Task
+
+ This example illustrates a simple task for a plain to-do item.
+
+ {
+ "@type": "Task",
+ "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2",
+ "updated": "2020-01-09T14:32:01Z",
+ "title": "Do something"
+ }
+
+6.3. Simple Group
+
+ This example illustrates a simple calendar object group that contains
+ an event and a task.
+
+ {
+ "@type": "Group",
+ "uid": "bf0ac22b-4989-4caf-9ebd-54301b4ee51a",
+ "updated": "2020-01-15T18:00:00Z",
+ "name": "A simple group",
+ "entries": [{
+ "@type": "Event",
+ "uid": "a8df6573-0474-496d-8496-033ad45d7fea",
+ "updated": "2020-01-02T18:23:04Z",
+ "title": "Some event",
+ "start": "2020-01-15T13:00:00",
+ "timeZone": "America/New_York",
+ "duration": "PT1H"
+ },
+ {
+ "@type": "Task",
+ "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2",
+ "updated": "2020-01-09T14:32:01Z",
+ "title": "Do something"
+ }]
+ }
+
+6.4. All-Day Event
+
+ This example illustrates an event for an international holiday. It
+ specifies an all-day event on April 1 that occurs every year since
+ the year 1900.
+
+ {
+ "...": "",
+ "title": "April Fool's Day",
+ "showWithoutTime": true,
+ "start": "1900-04-01T00:00:00",
+ "duration": "P1D",
+ "recurrenceRules": [{
+ "@type": "RecurrenceRule",
+ "frequency": "yearly"
+ }]
+ }
+
+6.5. Task with a Due Date
+
+ This example illustrates a task with a due date. It is a reminder to
+ buy groceries before 6 pm Vienna local time on January 19, 2020. The
+ calendar user expects to need 1 hour for shopping.
+
+ {
+ "...": "",
+ "title": "Buy groceries",
+ "due": "2020-01-19T18:00:00",
+ "timeZone": "Europe/Vienna",
+ "estimatedDuration": "PT1H"
+ }
+
+6.6. Event with End Time Zone
+
+ This example illustrates the use of end time zones by use of an
+ international flight. The flight starts on April 1, 2020 at 9 am in
+ Berlin local time. The duration of the flight is scheduled at 10
+ hours 30 minutes. The time at the flight's destination is in the
+ same time zone as Tokyo. Calendar clients could use the end time
+ zone to display the arrival time in Tokyo local time and highlight
+ the time zone difference of the flight. The location names can serve
+ as input for navigation systems.
+
+ {
+ "...": "",
+ "title": "Flight XY51 to Tokyo",
+ "start": "2020-04-01T09:00:00",
+ "timeZone": "Europe/Berlin",
+ "duration": "PT10H30M",
+ "locations": {
+ "1": {
+ "@type": "Location",
+ "rel": "start",
+ "name": "Frankfurt Airport (FRA)"
+ },
+ "2": {
+ "@type": "Location",
+ "rel": "end",
+ "name": "Narita International Airport (NRT)",
+ "timeZone": "Asia/Tokyo"
+ }
+ }
+ }
+
+6.7. Floating-Time Event (with Recurrence)
+
+ This example illustrates the use of floating time. Since January 1,
+ 2020, a calendar user blocks 30 minutes every day to practice yoga at
+ 7 am local time in whatever time zone the user is located on that
+ date.
+
+ {
+ "...": "",
+ "title": "Yoga",
+ "start": "2020-01-01T07:00:00",
+ "duration": "PT30M",
+ "recurrenceRules": [{
+ "@type": "RecurrenceRule",
+ "frequency": "daily"
+ }]
+ }
+
+6.8. Event with Multiple Locations and Localization
+
+ This example illustrates an event that happens at both a physical and
+ a virtual location. Fans can see a live concert on premises or
+ online. The event title and descriptions are localized.
+
+ {
+ "...": "",
+ "title": "Live from Music Bowl: The Band",
+ "description": "Go see the biggest music event ever!",
+ "locale": "en",
+ "start": "2020-07-04T17:00:00",
+ "timeZone": "America/New_York",
+ "duration": "PT3H",
+ "locations": {
+ "c0503d30-8c50-4372-87b5-7657e8e0fedd": {
+ "@type": "Location",
+ "name": "The Music Bowl",
+ "description": "Music Bowl, Central Park, New York",
+ "coordinates": "geo:40.7829,-73.9654"
+ }
+ },
+ "virtualLocations": {
+ "vloc1": {
+ "@type": "VirtualLocation",
+ "name": "Free live Stream from Music Bowl",
+ "uri": "https://stream.example.com/the_band_2020"
+ }
+ },
+ "localizations": {
+ "de": {
+ "title": "Live von der Music Bowl: The Band!",
+ "description": "Schau dir das größte Musikereignis an!",
+ "virtualLocations/vloc1/name":
+ "Gratis Live-Stream aus der Music Bowl"
+ }
+ }
+ }
+
+6.9. Recurring Event with Overrides
+
+ This example illustrates the use of recurrence overrides. A math
+ course at a university is held for the first time on January 8, 2020
+ at 9 am London time and occurs every week until June 24, 2020. Each
+ lecture lasts for one hour and 30 minutes and is located at the
+ Mathematics department. This event has exceptional occurrences: at
+ the last occurrence of the course is an exam, which lasts for 2 hours
+ and starts at 10 am. Also, the location of the exam differs from the
+ usual location. On April 1, no course is held. On January 7 at 2
+ pm, there is an optional introduction course, which occurs before the
+ first regular lecture.
+
+ {
+ "...": "",
+ "title": "Calculus I",
+ "start": "2020-01-08T09:00:00",
+ "timeZone": "Europe/London",
+ "duration": "PT1H30M",
+ "locations": {
+ "mlab": {
+ "@type": "Location",
+ "title": "Math lab room 1",
+ "description": "Math Lab I, Department of Mathematics"
+ }
+ },
+ "recurrenceRules": [{
+ "@type": "RecurrenceRule",
+ "frequency": "weekly",
+ "until": "2020-06-24T09:00:00"
+ }],
+ "recurrenceOverrides": {
+ "2020-01-07T14:00:00": {
+ "title": "Introduction to Calculus I (optional)"
+ },
+ "2020-04-01T09:00:00": {
+ "excluded": true
+ },
+ "2020-06-25T09:00:00": {
+ "title": "Calculus I Exam",
+ "start": "2020-06-25T10:00:00",
+ "duration": "PT2H",
+ "locations": {
+ "auditorium": {
+ "@type": "Location",
+ "title": "Big Auditorium",
+ "description": "Big Auditorium, Other Road"
+ }
+ }
+ }
+ }
+ }
+
+6.10. Recurring Event with Participants
+
+ This example illustrates scheduled events. A team meeting occurs
+ every week since January 8, 2020 at 9 am Johannesburg time. The
+ event owner also chairs the event. Participants meet in a virtual
+ meeting room. An attendee has accepted the invitation, but, on March
+ 4, 2020, he is unavailable and declined participation for this
+ occurrence.
+
+ {
+ "...": "",
+ "title": "FooBar team meeting",
+ "start": "2020-01-08T09:00:00",
+ "timeZone": "Africa/Johannesburg",
+ "duration": "PT1H",
+ "virtualLocations": {
+ "0": {
+ "@type": "VirtualLocation",
+ "name": "ChatMe meeting room",
+ "uri": "https://chatme.example.com?id=1234567&pw=a8a24627b63d"
+ }
+ },
+ "recurrenceRules": [{
+ "@type": "RecurrenceRule",
+ "frequency": "weekly"
+ }],
+ "replyTo": {
+ "imip": "mailto:f245f875-7f63-4a5e-a2c8@schedule.example.com"
+ },
+ "participants": {
+ "dG9tQGZvb2Jhci5xlLmNvbQ": {
+ "@type": "Participant",
+ "name": "Tom Tool",
+ "email": "tom@foobar.example.com",
+ "sendTo": {
+ "imip": "mailto:tom@calendar.example.com"
+ },
+ "participationStatus": "accepted",
+ "roles": {
+ "attendee": true
+ }
+ },
+ "em9lQGZvb2GFtcGxlLmNvbQ": {
+ "@type": "Participant",
+ "name": "Zoe Zelda",
+ "email": "zoe@foobar.example.com",
+ "sendTo": {
+ "imip": "mailto:zoe@foobar.example.com"
+ },
+ "participationStatus": "accepted",
+ "roles": {
+ "owner": true,
+ "attendee": true,
+ "chair": true
+ }
+ }
+ },
+ "recurrenceOverrides": {
+ "2020-03-04T09:00:00": {
+ "participants/dG9tQGZvb2Jhci5xlLmNvbQ/participationStatus":
+ "declined"
+ }
+ }
+ }
+
+7. Security Considerations
+
+ Calendaring and scheduling information is very privacy sensitive. It
+ can reveal the social network of a user, location information of this
+ user and those in their social network, identity and credentials
+ information, and patterns of behavior of the user in both the
+ physical and cyber realm. Additionally, calendar events and tasks
+ can influence the physical location of a user or their cyber behavior
+ within a known time window. Its transmission and storage must be
+ done carefully to protect it from possible threats, such as
+ eavesdropping, replay, message insertion, deletion, modification, and
+ on-path attacks.
+
+ The data being stored and transmitted may be used in systems with
+ real-world consequences. For example, a home automation system may
+ turn an alarm on and off or a coworking space may charge money to the
+ organizer of an event that books one of their meeting rooms. Such
+ systems must be careful to authenticate all data they receive to
+ prevent them from being subverted and ensure the change comes from an
+ authorized entity.
+
+ This document only defines the data format; such considerations are
+ primarily the concern of the API or method of storage and
+ transmission of such files.
+
+7.1. Expanding Recurrences
+
+ A recurrence rule may produce infinite occurrences of an event.
+ Implementations MUST handle expansions carefully to prevent
+ accidental or deliberate resource exhaustion.
+
+ Conversely, a recurrence rule may be specified that does not expand
+ to anything. It is not always possible to tell this through static
+ analysis of the rule, so implementations MUST be careful to avoid
+ getting stuck in infinite loops or otherwise exhausting resources
+ while searching for the next occurrence.
+
+ Events recur in the event's time zone. If the user is in a different
+ time zone, daylight saving transitions may cause an event that
+ normally occurs at, for example, 9 am to suddenly shift an hour
+ earlier. This may be used in an attempt to cause a participant to
+ miss an important meeting. User agents must be careful to translate
+ date-times correctly between time zones and may wish to call out
+ unexpected changes in the time of a recurring event.
+
+7.2. JSON Parsing
+
+ The security considerations of [RFC8259] apply to the use of JSON as
+ the data interchange format.
+
+ As for any serialization format, parsers need to thoroughly check the
+ syntax of the supplied data. JSON uses opening and closing tags for
+ several types and structures, and it is possible that the end of the
+ supplied data will be reached when scanning for a matching closing
+ tag; this is an error condition, and implementations need to stop
+ scanning at the end of the supplied data.
+
+ JSON also uses a string encoding with some escape sequences to encode
+ special characters within a string. Care is needed when processing
+ these escape sequences to ensure that they are fully formed before
+ the special processing is triggered, with special care taken when the
+ escape sequences appear adjacent to other (non-escaped) special
+ characters or adjacent to the end of data (as in the previous
+ paragraph).
+
+ If parsing JSON into a non-textual structured data format,
+ implementations may need to allocate storage to hold JSON string
+ elements. Since JSON does not use explicit string lengths, the risk
+ of denial of service due to resource exhaustion is small, but
+ implementations may still wish to place limits on the size of
+ allocations they are willing to make in any given context, to avoid
+ untrusted data causing excessive memory allocation.
+
+7.3. URI Values
+
+ Several JSCalendar properties contain URIs as values, and processing
+ these properties requires extra care. Section 7 of [RFC3986]
+ discusses security risks related to URIs.
+
+ Fetching remote resources carries inherent risks. Connections must
+ only be allowed on well-known ports, using allowed protocols
+ (generally, just HTTP/HTTPS on their default ports). The URL must be
+ resolved externally and not allowed to access internal resources.
+ Connecting to an external source reveals IP (and therefore often
+ location) information.
+
+ A maliciously constructed JSCalendar object may contain a very large
+ number of URIs. In the case of published calendars with a large
+ number of subscribers, such objects could be widely distributed.
+ Implementations should be careful to limit the automatic fetching of
+ linked resources to reduce the risk of this being an amplification
+ vector for a denial-of-service attack.
+
+7.4. Spam
+
+ Calendar systems may receive JSCalendar files from untrusted sources,
+ in particular, as attachments to emails. This can be a vector for an
+ attacker to inject spam into a user's calendar. This may confuse,
+ annoy, and mislead users or overwhelm their calendar with bogus
+ events, preventing them from seeing legitimate ones.
+
+ Heuristic, statistical, or machine-learning-based filters can be
+ effective in filtering out spam. Authentication mechanisms, such as
+ DomainKeys Identified Mail (DKIM) [RFC6376], can help establish the
+ source of messages and associate the data with existing relationships
+ (such as an address book contact). However, misclassifications are
+ always possible and providing a mechanism for users to quickly
+ correct this is advised.
+
+ Confusable unicode characters may be used to trick a user into
+ trusting a JSCalendar file that appears to come from a known contact
+ but is actually from a similar-looking source controlled by an
+ attacker.
+
+7.5. Duplication
+
+ It is important for calendar systems to maintain the UID of an event
+ when updating it to avoid an unexpected duplication of events.
+ Consumers of the data may not remove the previous version of the
+ event if it has a different UID. This can lead to a confusing
+ situation for the user, with many variations of the event and no
+ indication of which one is correct. Care must be taken by consumers
+ of the data to remove old events where possible to avoid an
+ accidental denial-of-service attack due to the volume of data.
+
+7.6. Time Zones
+
+ Events recur in a particular time zone. When this differs from the
+ user's current time zone, it may unexpectedly cause an occurrence to
+ shift in time for that user due to a daylight savings change in the
+ event's time zone. A maliciously crafted event could attempt to
+ confuse users with such an event to ensure a meeting is missed.
+
+8. IANA Considerations
+
+8.1. Media Type Registration
+
+ This document defines a media type for use with JSCalendar data
+ formatted in JSON.
+
+ Type name: application
+
+ Subtype name: jscalendar+json
+
+ Required parameters: type
+
+ The "type" parameter conveys the type of the JSCalendar data in
+ the body part. The allowed parameter values correspond to the
+ "@type" property of the JSON-formatted JSCalendar object in the
+ body:
+
+ "event": The "@type" property value MUST be "Event".
+
+ "task": The "@type" property value MUST be "Task".
+
+ "group": The "@type" property value MUST be "Group".
+
+ No other parameter values are allowed. The parameter MUST NOT
+ occur more than once.
+
+ Optional parameters: none
+
+ Encoding considerations: This is the same as the encoding
+ considerations of application/json, as specified in Section 11 of
+ [RFC8259].
+
+ Security considerations: See Section 7 of this document.
+
+ Interoperability considerations: While JSCalendar is designed to
+ avoid ambiguities as much as possible, when converting objects
+ from other calendar formats to/from JSCalendar, it is possible
+ that differing representations for the same logical data or
+ ambiguities in interpretation might arise. The semantic
+ equivalence of two JSCalendar objects may be determined
+ differently by different applications, for example, where URL
+ values differ in case between the two objects.
+
+ Published specification: RFC 8984
+
+ Applications that use this media type: Applications that currently
+ make use of the text/calendar and application/calendar+json media
+ types can use this as an alternative. Similarly, applications
+ that use the application/json media type to transfer calendaring
+ data can use this to further specify the content.
+
+ Fragment identifier considerations: A JSON Pointer fragment
+ identifier may be used, as defined in [RFC6901], Section 6.
+
+ Additional information: Magic number(s): N/A
+
+ File extensions(s): N/A
+
+ Macintosh file type code(s): N/A
+
+ Person & email address to contact for further information:
+ calsify@ietf.org
+
+ Intended usage: COMMON
+
+ Restrictions on usage: N/A
+
+ Author: See the "Author's Address" section of this document.
+
+ Change controller: IETF
+
+8.2. Creation of the "JSCalendar Properties" Registry
+
+ IANA has created the "JSCalendar Properties" registry to allow
+ interoperability of extensions to JSCalendar objects.
+
+ This registry follows the Expert Review process ([RFC8126],
+ Section 4.5). If the "Intended Usage" field is "common", sufficient
+ documentation is required to enable interoperability. Preliminary
+ community review for this registry is optional but strongly
+ encouraged.
+
+ A registration can have an intended usage of "common", "reserved", or
+ "obsolete". IANA will list registrations with a common usage
+ designation prominently and separately from those with other intended
+ usage values.
+
+ A "reserved" registration reserves a property name without assigning
+ semantics to avoid name collisions with future extensions or protocol
+ use.
+
+ An "obsolete" registration denotes a property that is no longer
+ expected to be added by up-to-date systems. A new property has
+ probably been defined covering the obsolete property's semantics.
+
+ The JSCalendar property registration procedure is not a formal
+ standards process but rather an administrative procedure intended to
+ allow community comment and check it is coherent without excessive
+ time delay. It is designed to encourage vendors to document and
+ register new properties they add for use cases not covered by the
+ original specification, leading to increased interoperability.
+
+8.2.1. Preliminary Community Review
+
+ Notice of a potential new registration SHOULD be sent to the Calext
+ mailing list for review. This mailing list is
+ appropriate to solicit community feedback on a proposed new property.
+
+ Property registrations must be marked with their intended use:
+ "common", "reserved", or "obsolete".
+
+ The intent of the public posting to this list is to solicit comments
+ and feedback on the choice of the property name, the unambiguity of
+ the specification document, and a review of any interoperability or
+ security considerations. The submitter may submit a revised
+ registration proposal or abandon the registration completely at any
+ time.
+
+8.2.2. Submit Request to IANA
+
+ Registration requests can be sent to .
+
+8.2.3. Designated Expert Review
+
+ The primary concern of the designated expert (DE) is preventing name
+ collisions and encouraging the submitter to document security and
+ privacy considerations. For a common-use registration, the DE is
+ expected to confirm that suitable documentation, as described in
+ Section 4.6 of [RFC8126], is available to ensure interoperability.
+ That documentation will usually be in an RFC, but simple definitions
+ are likely to use a web/wiki page, and if a sentence or two is deemed
+ sufficient, it could be described in the registry itself. The DE
+ should also verify that the property name does not conflict with work
+ that is active or already published within the IETF. A published
+ specification is not required for reserved or obsolete registrations.
+
+ The DE will either approve or deny the registration request and
+ publish a notice of the decision to the Calext WG mailing list or its
+ successor, as well as inform IANA. A denial notice must be justified
+ by an explanation, and, in the cases where it is possible, concrete
+ suggestions on how the request can be modified so as to become
+ acceptable should be provided.
+
+8.2.4. Change Procedures
+
+ Once a JSCalendar property has been published by IANA, the change
+ controller may request a change to its definition. The same
+ procedure that would be appropriate for the original registration
+ request is used to process a change request.
+
+ JSCalendar property registrations may not be deleted; properties that
+ are no longer believed appropriate for use can be declared obsolete
+ by a change to their "intended usage" field; such properties will be
+ clearly marked in the IANA registry.
+
+ Significant changes to a JSCalendar property's definition should be
+ requested only when there are serious omissions or errors in the
+ published specification, as such changes may cause interoperability
+ issues. When review is required, a change request may be denied if
+ it renders entities that were valid under the previous definition
+ invalid under the new definition.
+
+ The owner of a JSCalendar property may pass responsibility to another
+ person or agency by informing IANA; this can be done without
+ discussion or review.
+
+8.2.5. "JSCalendar Properties" Registry Template
+
+ Property Name: This is the name of the property. The property name
+ MUST NOT already be registered for any of the object types listed
+ in the "Property Context" field of this registration. Other
+ object types MAY already have registered a different property with
+ the same name; however, the same name SHOULD only be used when the
+ semantics are analogous.
+
+ Property Type: This is the type of this property, using type
+ signatures, as specified in Section 1.3. The property type MUST
+ be registered in the "JSCalendar Types" registry.
+
+ Property Context: This is a comma-separated list of JSCalendar
+ object types this property is allowed on.
+
+ Reference or Description: This is a brief description or RFC number
+ and section reference where the property is specified (omitted for
+ "reserved" property names).
+
+ Intended Usage: This may be "common", "reserved", or "obsolete".
+
+ Change Controller: This is who may request a change to this entry's
+ definition ("IETF" for RFCs from the IETF stream).
+
+8.2.6. Initial Contents for the "JSCalendar Properties" Registry
+
+ The following table lists the initial entries of the "JSCalendar
+ Properties" registry. All properties are for common use. All RFC
+ section references are for this document. The change controller for
+ all these properties is "IETF".
+
+ +====================+=================+================+===========+
+ |Property Name |Property Type |Property Context|Reference |
+ | | | |or |
+ | | | |Description|
+ +====================+=================+================+===========+
+ |@type |String |Event, Task, |Section |
+ | | |Group, |4.1.1, |
+ | | |AbsoluteTrigger,|Section |
+ | | |Alert, Link, |4.5.2, |
+ | | |Location, NDay, |Section |
+ | | |OffsetTrigger, |1.4.11, |
+ | | |Participant, |Section |
+ | | |RecurrenceRule, |4.2.5, |
+ | | |Relation, |Section |
+ | | |TimeZone, |4.4.6, |
+ | | |TimeZoneRule, |Section |
+ | | |VirtualLocation |4.3.3, |
+ | | | |Section |
+ | | | |1.4.10, |
+ | | | |Section |
+ | | | |4.7.2, |
+ | | | |Section |
+ | | | |4.2.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |acknowledged |UTCDateTime |Alert |Section |
+ | | | |4.5.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |action |String |Alert |Section |
+ | | | |4.5.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |alerts |Id[Alert] |Event, Task |Section |
+ | | | |4.5.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |aliases |String[Boolean] |TimeZone |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |byDay |NDay[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |byHour |UnsignedInt[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |byMinute |UnsignedInt[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |byMonth |String[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |byMonthDay |Int[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |bySecond |UnsignedInt[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |bySetPosition |Int[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |byWeekNo |Int[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |byYearDay |Int[] |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |categories |String[Boolean] |Event, Task, |Section |
+ | | |Group |4.2.10 |
+ +--------------------+-----------------+----------------+-----------+
+ |cid |String |Link |Section |
+ | | | |1.4.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |color |String |Event, Task, |Section |
+ | | |Group |4.2.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |comments |String[] |TimeZoneRule |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |contentType |String |Link |Section |
+ | | | |1.4.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |coordinates |String |Location |Section |
+ | | | |4.2.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |count |UnsignedInt |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |created |UTCDateTime |Event, Task, |Section |
+ | | |Group |4.1.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |day |String |NDay |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |daylight |TimeZoneRule[] |TimeZone |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |delegatedFrom |Id[Boolean] |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |delegatedTo |Id[Boolean] |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |description |String |Event, Task, |Section |
+ | | |Location, |4.2.2, |
+ | | |Participant, |Section |
+ | | |VirtualLocation |4.2.5, |
+ | | | |Section |
+ | | | |4.4.6, |
+ | | | |Section |
+ | | | |4.2.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |description |String |Event, Task |Section |
+ |ContentType | | |4.2.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |display |String |Link |Section |
+ | | | |1.4.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |due |LocalDateTime |Task |Section |
+ | | | |5.2.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |duration |Duration |Event |Section |
+ | | | |5.1.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |email |String |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |entries |(Task|Event)[] |Group |Section |
+ | | | |5.3.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |estimatedDuration |Duration |Task |Section |
+ | | | |5.2.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |excluded |Boolean |Event, Task |Section |
+ | | | |4.3.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |excluded |RecurrenceRule[] |Event, Task |Section |
+ |RecurrenceRules | | |4.3.4 |
+ +--------------------+-----------------+----------------+-----------+
+ |expectReply |Boolean |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |features |String[Boolean] |VirtualLocation |Section |
+ | | | |4.2.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |firstDayOfWeek |String |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |freeBusyStatus |String |Event, Task |Section |
+ | | | |4.4.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |frequency |String |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |href |String |Link |Section |
+ | | | |1.4.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |interval |UnsignedInt |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |invitedBy |Id |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |keywords |String[Boolean] |Event, Task, |Section |
+ | | |Group |4.2.9 |
+ +--------------------+-----------------+----------------+-----------+
+ |kind |String |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |language |String |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |links |Id[Link] |Group, Event, |Section |
+ | | |Task, Location, |4.2.7, |
+ | | |Participant |Section |
+ | | | |4.2.5, |
+ | | | |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |locale |String |Group, Event, |Section |
+ | | |Task |4.2.8 |
+ +--------------------+-----------------+----------------+-----------+
+ |localizations |String |Event, Task |Section |
+ | |[PatchObject] | |4.6.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |locationId |Id |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |locations |Id[Location] |Event, Task |Section |
+ | | | |4.2.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |locationTypes |String[Boolean] |Location |Section |
+ | | | |4.2.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |memberOf |Id[Boolean] |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |method |String |Event, Task |Section |
+ | | | |4.1.8 |
+ +--------------------+-----------------+----------------+-----------+
+ |name |String |Location, |Section |
+ | | |VirtualLocation,|4.2.5, |
+ | | |Participant |Section |
+ | | | |4.2.6, |
+ | | | |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |names |String[Boolean] |TimeZoneRule |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |nthOfPeriod |Int |NDay |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |offset |SignedDuration |OffsetTrigger |Section |
+ | | | |4.5.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |offsetFrom |UTCDateTime |TimeZoneRule |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |offsetTo |UTCDateTime |TimeZoneRule |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |participants |Id[Participant] |Event, Task |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |participationComment|String |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |participationStatus |String |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |percentComplete |UnsignedInt |Task, |Section |
+ | | |Participant |5.2.4 |
+ +--------------------+-----------------+----------------+-----------+
+ |priority |Int |Event, Task |Section |
+ | | | |4.4.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |privacy |String |Event, Task |Section |
+ | | | |4.4.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |prodId |String |Event, Task, |Section |
+ | | |Group |4.1.4 |
+ +--------------------+-----------------+----------------+-----------+
+ |progress |String |Task, |Section |
+ | | |Participant |5.2.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |progressUpdated |UTCDateTime |Task, |Section |
+ | | |Participant |5.2.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |recurrenceId |LocalDateTime |Event, Task |Section |
+ | | | |4.3.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |recurrenceIdTimeZone|TimeZoneId|null |Event, Task |Section |
+ | | | |4.3.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |recurrenceOverrides |LocalDateTime |Event, Task, |Section |
+ | |[PatchObject] |TimeZoneRule |4.3.5, |
+ | | | |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |recurrenceRules |RecurrenceRule[] |Event, Task, |Section |
+ | | |TimeZoneRule |4.3.3, |
+ | | | |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |rel |String |Link |Section |
+ | | | |1.4.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |relatedTo |String[Relation] |Event, Task, |Section |
+ | | |Alert |4.1.3, |
+ | | | |Section |
+ | | | |4.5.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |relation |String[Boolean] |Relation |Section |
+ | | | |1.4.10 |
+ +--------------------+-----------------+----------------+-----------+
+ |relativeTo |String |OffsetTrigger, |Section |
+ | | |Location |4.5.2, |
+ | | | |Section |
+ | | | |4.2.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |replyTo |String[String] |Event, Task |Section |
+ | | | |4.4.4 |
+ +--------------------+-----------------+----------------+-----------+
+ |requestStatus |String |Event, Task |Section |
+ | | | |4.4.7 |
+ +--------------------+-----------------+----------------+-----------+
+ |roles |String[Boolean] |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |rscale |String |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |sentBy |String |Event, Task, |Section |
+ | | |Participant |4.4.5, |
+ | | | |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |standard |TimeZoneRule[] |TimeZone |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |start |LocalDateTime |TimeZoneRule |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |scheduleAgent |String |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |scheduleForceSend |Boolean |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |scheduleSequence |UnsignedInt |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |scheduleStatus |String[] |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |scheduleUpdated |UTCDateTime |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |sendTo |String[String] |Participant |Section |
+ | | | |4.4.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |sequence |UnsignedInt |Event, Task |Section |
+ | | | |4.1.7 |
+ +--------------------+-----------------+----------------+-----------+
+ |showWithoutTime |Boolean |Event, Task |Section |
+ | | | |4.2.4 |
+ +--------------------+-----------------+----------------+-----------+
+ |size |UnsignedInt |Link |Section |
+ | | | |1.4.11 |
+ +--------------------+-----------------+----------------+-----------+
+ |skip |String |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |source |String |Group |Section |
+ | | | |5.3.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |start |LocalDateTime |Event, Task |Section |
+ | | | |5.1.1, |
+ | | | |Section |
+ | | | |5.2.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |status |String |Event |Section |
+ | | | |5.1.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |timeZone |TimeZoneId|null |Event, Task, |Section |
+ | | |Location |4.7.1, |
+ | | | |Section |
+ | | | |4.2.5 |
+ +--------------------+-----------------+----------------+-----------+
+ |timeZones |TimeZoneId |Event, Task |Section |
+ | |[TimeZone] | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |title |String |Event, Task, |Section |
+ | | |Group, Link |4.2.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |trigger |OffsetTrigger| |Alert |Section |
+ | |AbsoluteTrigger| | |4.5.2 |
+ | |UnknownTrigger | | |
+ +--------------------+-----------------+----------------+-----------+
+ |tzId |String |TimeZone |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |uid |String |Event, Task, |Section |
+ | | |Group |4.1.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |until |LocalDateTime |RecurrenceRule |Section |
+ | | | |4.3.3 |
+ +--------------------+-----------------+----------------+-----------+
+ |updated |UTCDateTime |Event, Task, |Section |
+ | | |Group |4.1.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |uri |String |VirtualLocation |Section |
+ | | | |4.2.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |url |String |TimeZone |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |useDefaultAlerts |Boolean |Event, Task |Section |
+ | | | |4.5.1 |
+ +--------------------+-----------------+----------------+-----------+
+ |validUntil |UTCDateTime |TimeZone |Section |
+ | | | |4.7.2 |
+ +--------------------+-----------------+----------------+-----------+
+ |virtualLocations |Id |Event, Task |Section |
+ | |[VirtualLocation]| |4.2.6 |
+ +--------------------+-----------------+----------------+-----------+
+ |when |UTCDateTime |AbsoluteTrigger |Section |
+ | | | |4.5.2 |
+ +--------------------+-----------------+----------------+-----------+
+
+ Table 1: Initial Contents of the "JSCalendar Properties" Registry
+
+8.3. Creation of the "JSCalendar Types" Registry
+
+ IANA has created the "JSCalendar Types" registry to avoid name
+ collisions and provide a complete reference for all data types used
+ for JSCalendar property values. The registration process is the same
+ as for the "JSCalendar Properties" registry, as defined in
+ Section 8.2.
+
+8.3.1. "JSCalendar Types" Registry Template
+
+ Type Name: the name of the type
+
+ Reference or Description: a brief description or RFC number and
+ section reference where the Type is specified (may be omitted for
+ "reserved" type names)
+
+ Intended Use: common, reserved, or obsolete
+
+ Change Controller: who may request a change to this entry's
+ definition ("IETF" for RFCs from the IETF stream)
+
+8.3.2. Initial Contents for the "JSCalendar Types" Registry
+
+ The following table lists the initial entries of the JSCalendar Types
+ registry. All properties are for common use. All RFC section
+ references are for this document. The change controller for all
+ these properties is "IETF".
+
+ +=================+==========================+
+ | Type Name | Reference or Description |
+ +=================+==========================+
+ | Alert | Section 4.5.2 |
+ +-----------------+--------------------------+
+ | Boolean | Section 1.3 |
+ +-----------------+--------------------------+
+ | Duration | Section 1.4.6 |
+ +-----------------+--------------------------+
+ | Id | Section 1.4.1 |
+ +-----------------+--------------------------+
+ | Int | Section 1.4.2 |
+ +-----------------+--------------------------+
+ | LocalDateTime | Section 1.4.5 |
+ +-----------------+--------------------------+
+ | Link | Section 1.4.11 |
+ +-----------------+--------------------------+
+ | Location | Section 4.2.5 |
+ +-----------------+--------------------------+
+ | NDay | Section 4.3.3 |
+ +-----------------+--------------------------+
+ | Number | Section 1.3 |
+ +-----------------+--------------------------+
+ | Participant | Section 4.4.6 |
+ +-----------------+--------------------------+
+ | PatchObject | Section 1.4.9 |
+ +-----------------+--------------------------+
+ | RecurrenceRule | Section 4.3.3 |
+ +-----------------+--------------------------+
+ | Relation | Section 1.4.10 |
+ +-----------------+--------------------------+
+ | SignedDuration | Section 1.4.7 |
+ +-----------------+--------------------------+
+ | String | Section 1.3 |
+ +-----------------+--------------------------+
+ | TimeZone | Section 4.7.2 |
+ +-----------------+--------------------------+
+ | TimeZoneId | Section 1.4.8 |
+ +-----------------+--------------------------+
+ | TimeZoneRule | Section 4.7.2 |
+ +-----------------+--------------------------+
+ | UnsignedInt | Section 1.4.3 |
+ +-----------------+--------------------------+
+ | UTCDateTime | Section 1.4.4 |
+ +-----------------+--------------------------+
+ | VirtualLocation | Section 4.2.6 |
+ +-----------------+--------------------------+
+
+ Table 2: Initial Contents of the
+ "JSCalendar Types" Registry
+
+8.4. Creation of the "JSCalendar Enum Values" Registry
+
+ IANA has created the "JSCalendar Enum Values" registry to allow
+ interoperable extension of semantics for properties with enumerable
+ values. Each such property will have a subregistry of allowed
+ values. The registration process for a new enum value or adding a
+ new enumerable property is the same as for the "JSCalendar
+ Properties" registry, as defined in Section 8.2.
+
+8.4.1. "JSCalendar Enum Values" Registry Property Template
+
+ This template is for adding a subregistry for a new enumerable
+ property to the "JSCalendar Enum" registry.
+
+ Property Name: These are the name(s) of the property or properties
+ where these values may be used. This MUST be registered in the
+ "JSCalendar Properties" registry.
+
+ Context: This is the list of allowed object types where the property
+ or properties may appear, as registered in the "JSCalendar
+ Properties" registry. This disambiguates where there may be two
+ distinct properties with the same name in different contexts.
+
+ Change Controller: ("IETF" for properties defined in RFCs from the
+ IETF stream).
+
+ Initial Contents: This is the initial list of defined values for
+ this enum, using the template defined in Section 8.4.2. A
+ subregistry will be created with these values for this property
+ name/context tuple.
+
+8.4.2. "JSCalendar Enum Values" Registry Value Template
+
+ This template is for adding a new enum value to a subregistry in the
+ JSCalendar Enum registry.
+
+ Enum Value: the verbatim value of the enum
+
+ Reference or Description: a brief description or RFC number and
+ section reference for the semantics of this value
+
+8.4.3. Initial Contents for the "JSCalendar Enum Values" Registry
+
+ For each subregistry created in this section, all RFC section
+ references are for this document.
+
+ Property Name: action
+ Context: Alert
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | display | Section 4.5.2 |
+ +------------+--------------------------+
+ | email | Section 4.5.2 |
+ +------------+--------------------------+
+
+ Table 3: JSCalendar Enum Values for
+ action (Context: Alert)
+
+ Property Name: display
+ Context: Link
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | badge | Section 1.4.11 |
+ +------------+--------------------------+
+ | graphic | Section 1.4.11 |
+ +------------+--------------------------+
+ | fullsize | Section 1.4.11 |
+ +------------+--------------------------+
+ | thumbnail | Section 1.4.11 |
+ +------------+--------------------------+
+
+ Table 4: JSCalendar Enum Values for
+ display (Context: Link)
+
+ Property Name: features
+ Context: VirtualLocation
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | audio | Section 4.2.6 |
+ +------------+--------------------------+
+ | chat | Section 4.2.6 |
+ +------------+--------------------------+
+ | feed | Section 4.2.6 |
+ +------------+--------------------------+
+ | moderator | Section 4.2.6 |
+ +------------+--------------------------+
+ | phone | Section 4.2.6 |
+ +------------+--------------------------+
+ | screen | Section 4.2.6 |
+ +------------+--------------------------+
+ | video | Section 4.2.6 |
+ +------------+--------------------------+
+
+ Table 5: JSCalendar Enum Values for
+ features (Context: VirtualLocation)
+
+ Property Name: freeBusyStatus
+ Context: Event, Task
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | free | Section 4.4.2 |
+ +------------+--------------------------+
+ | busy | Section 4.4.2 |
+ +------------+--------------------------+
+
+ Table 6: JSCalendar Enum Values for
+ freeBusyStatus (Context: Event, Task)
+
+ Property Name: kind
+ Context: Participant
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | individual | Section 4.4.6 |
+ +------------+--------------------------+
+ | group | Section 4.4.6 |
+ +------------+--------------------------+
+ | resource | Section 4.4.6 |
+ +------------+--------------------------+
+ | location | Section 4.4.6 |
+ +------------+--------------------------+
+
+ Table 7: JSCalendar Enum Values for
+ kind (Context: Participant)
+
+ Property Name: participationStatus
+ Context: Participant
+ Change Controller: IETF
+ Initial Contents:
+ +==============+==========================+
+ | Enum Value | Reference or Description |
+ +==============+==========================+
+ | needs-action | Section 4.4.6 |
+ +--------------+--------------------------+
+ | accepted | Section 4.4.6 |
+ +--------------+--------------------------+
+ | declined | Section 4.4.6 |
+ +--------------+--------------------------+
+ | tentative | Section 4.4.6 |
+ +--------------+--------------------------+
+ | delegated | Section 4.4.6 |
+ +--------------+--------------------------+
+
+ Table 8: JSCalendar Enum Values for
+ participationStatus (Context:
+ Participant)
+
+ Property Name: privacy
+ Context: Event, Task
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | public | Section 4.4.3 |
+ +------------+--------------------------+
+ | private | Section 4.4.3 |
+ +------------+--------------------------+
+ | secret | Section 4.4.3 |
+ +------------+--------------------------+
+
+ Table 9: JSCalendar Enum Values for
+ privacy (Context: Event, Task)
+
+ Property Name: progress
+ Context: Task, Participant
+ Change Controller: IETF
+ Initial Contents:
+ +==============+==========================+
+ | Enum Value | Reference or Description |
+ +==============+==========================+
+ | needs-action | Section 5.2.5 |
+ +--------------+--------------------------+
+ | in-process | Section 5.2.5 |
+ +--------------+--------------------------+
+ | completed | Section 5.2.5 |
+ +--------------+--------------------------+
+ | failed | Section 5.2.5 |
+ +--------------+--------------------------+
+ | cancelled | Section 5.2.5 |
+ +--------------+--------------------------+
+
+ Table 10: JSCalendar Enum Values for
+ progress (Context: Task, Participant)
+
+ Property Name: relation
+ Context: Relation
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | first | Section 1.4.10 |
+ +------------+--------------------------+
+ | next | Section 1.4.10 |
+ +------------+--------------------------+
+ | child | Section 1.4.10 |
+ +------------+--------------------------+
+ | parent | Section 1.4.10 |
+ +------------+--------------------------+
+
+ Table 11: JSCalendar Enum Values for
+ relation (Context: Relation)
+
+ Property Name: relativeTo
+ Context: OffsetTrigger, Location
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | start | Section 4.5.2 |
+ +------------+--------------------------+
+ | end | Section 4.5.2 |
+ +------------+--------------------------+
+
+ Table 12: JSCalendar Enum Values for
+ relativeTo (Context: OffsetTrigger,
+ Location)
+
+ Property Name: roles
+ Context: Participant
+ Change Controller: IETF
+ Initial Contents:
+ +===============+==========================+
+ | Enum Value | Reference or Description |
+ +===============+==========================+
+ | owner | Section 4.4.6 |
+ +---------------+--------------------------+
+ | attendee | Section 4.4.6 |
+ +---------------+--------------------------+
+ | optional | Section 4.4.6 |
+ +---------------+--------------------------+
+ | informational | Section 4.4.6 |
+ +---------------+--------------------------+
+ | chair | Section 4.4.6 |
+ +---------------+--------------------------+
+ | contact | Section 4.4.6 |
+ +---------------+--------------------------+
+
+ Table 13: JSCalendar Enum Values for
+ roles (Context: Participant)
+
+ Property Name: scheduleAgent
+ Context: Participant
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | server | Section 4.4.6 |
+ +------------+--------------------------+
+ | client | Section 4.4.6 |
+ +------------+--------------------------+
+ | none | Section 4.4.6 |
+ +------------+--------------------------+
+
+ Table 14: JSCalendar Enum Values for
+ scheduleAgent (Context: Participant)
+
+ Property Name: status
+ Context: Event
+ Change Controller: IETF
+ Initial Contents:
+ +============+==========================+
+ | Enum Value | Reference or Description |
+ +============+==========================+
+ | confirmed | Section 5.1.3 |
+ +------------+--------------------------+
+ | cancelled | Section 5.1.3 |
+ +------------+--------------------------+
+ | tentative | Section 5.1.3 |
+ +------------+--------------------------+
+
+ Table 15: JSCalendar Enum Values for
+ status (Context: Event)
+
+9. References
+
+9.1. Normative References
+
+ [CLDR] "Unicode Common Locale Data Repository",
+ .
+
+ [COLORS] Çelik, T., Lilley, C., and L. Baron, "CSS Color Module
+ Level 3", W3C Recommendation, June 2018,
+ .
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119,
+ DOI 10.17487/RFC2119, March 1997,
+ .
+
+ [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource
+ Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998,
+ .
+
+ [RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
+ DOI 10.17487/RFC2397, August 1998,
+ .
+
+ [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet:
+ Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002,
+ .
+
+ [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
+ Resource Identifier (URI): Generic Syntax", STD 66,
+ RFC 3986, DOI 10.17487/RFC3986, January 2005,
+ .
+
+ [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
+ Unique IDentifier (UUID) URN Namespace", RFC 4122,
+ DOI 10.17487/RFC4122, July 2005,
+ .
+
+ [RFC4589] Schulzrinne, H. and H. Tschofenig, "Location Types
+ Registry", RFC 4589, DOI 10.17487/RFC4589, July 2006,
+ .
+
+ [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
+ Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006,
+ .
+
+ [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
+ Specifications: ABNF", STD 68, RFC 5234,
+ DOI 10.17487/RFC5234, January 2008,
+ .
+
+ [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
+ DOI 10.17487/RFC5322, October 2008,
+ .
+
+ [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and
+ Scheduling Core Object Specification (iCalendar)",
+ RFC 5545, DOI 10.17487/RFC5545, September 2009,
+ .
+
+ [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent
+ Interoperability Protocol (iTIP)", RFC 5546,
+ DOI 10.17487/RFC5546, December 2009,
+ .
+
+ [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
+ Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646,
+ September 2009, .
+
+ [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource
+ Identifier for Geographic Locations ('geo' URI)",
+ RFC 5870, DOI 10.17487/RFC5870, June 2010,
+ .
+
+ [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based
+ Interoperability Protocol (iMIP)", RFC 6047,
+ DOI 10.17487/RFC6047, December 2010,
+ .
+
+ [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type
+ Specifications and Registration Procedures", BCP 13,
+ RFC 6838, DOI 10.17487/RFC6838, January 2013,
+ .
+
+ [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed.,
+ "JavaScript Object Notation (JSON) Pointer", RFC 6901,
+ DOI 10.17487/RFC6901, April 2013,
+ .
+
+ [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493,
+ DOI 10.17487/RFC7493, March 2015,
+ .
+
+ [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules
+ in the Internet Calendaring and Scheduling Core Object
+ Specification (iCalendar)", RFC 7529,
+ DOI 10.17487/RFC7529, May 2015,
+ .
+
+ [RFC7808] Douglass, M. and C. Daboo, "Time Zone Data Distribution
+ Service", RFC 7808, DOI 10.17487/RFC7808, March 2016,
+ .
+
+ [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
+ Writing an IANA Considerations Section in RFCs", BCP 26,
+ RFC 8126, DOI 10.17487/RFC8126, June 2017,
+ .
+
+ [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
+ 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
+ May 2017, .
+
+ [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
+ Interchange Format", STD 90, RFC 8259,
+ DOI 10.17487/RFC8259, December 2017,
+ .
+
+ [RFC8288] Nottingham, M., "Web Linking", RFC 8288,
+ DOI 10.17487/RFC8288, October 2017,
+ .
+
+ [TZDB] IANA, "Time Zone Database",
+ .
+
+9.2. Informative References
+
+ [ISO.9070.1991]
+ ISO/IEC, "Information technology -- SGML support
+ facilities -- Registration procedures for public text
+ owner identifiers", Edition 2, ISO/IEC 9070:1991, April
+ 1991, .
+
+ [LINKRELS] IANA, "Link Relations: Link Relation Types",
+ .
+
+ [LOCATIONTYPES]
+ IANA, "Location Types Registry",
+ .
+
+ [MEDIATYPES]
+ IANA, "Media Types",
+ .
+
+ [RFC6376] Crocker, D., Ed., Hansen, T., Ed., and M. Kucherawy, Ed.,
+ "DomainKeys Identified Mail (DKIM) Signatures", STD 76,
+ RFC 6376, DOI 10.17487/RFC6376, September 2011,
+ .
+
+ [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON
+ Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May
+ 2014, .
+
+ [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986,
+ DOI 10.17487/RFC7986, October 2016,
+ .
+
+Acknowledgments
+
+ The authors would like to thank the members of CalConnect for their
+ valuable contributions. This specification originated from the work
+ of the API technical committee of CalConnect: The Calendaring and
+ Scheduling Consortium.
+
+Authors' Addresses
+
+ Neil Jenkins
+ Fastmail
+ Collins St. West
+ P.O. Box 234
+ Melbourne VIC 8007
+ Australia
+
+ Email: neilj@fastmailteam.com
+ URI: https://www.fastmail.com
+
+
+ Robert Stepanek
+ Fastmail
+ Collins St. West
+ P.O. Box 234
+ Melbourne VIC 8007
+ Australia
+
+ Email: rsto@fastmailteam.com
+ URI: https://www.fastmail.com
diff --git a/specifications/calendar/rfc9670.pdf b/specifications/calendar/rfc9670.pdf
new file mode 100644
index 00000000..d63d9fd5
Binary files /dev/null and b/specifications/calendar/rfc9670.pdf differ
diff --git a/specifications/calendar/rfc9670.txt b/specifications/calendar/rfc9670.txt
new file mode 100644
index 00000000..13dd6891
--- /dev/null
+++ b/specifications/calendar/rfc9670.txt
@@ -0,0 +1,857 @@
+
+
+
+
+Internet Engineering Task Force (IETF) N. Jenkins, Ed.
+Request for Comments: 9670 Fastmail
+Updates: 8620 November 2024
+Category: Standards Track
+ISSN: 2070-1721
+
+
+ JSON Meta Application Protocol (JMAP) Sharing
+
+Abstract
+
+ This document specifies a data model for sharing data between users
+ using the JSON Meta Application Protocol (JMAP). Future documents
+ can reference this document when defining data types to support a
+ consistent model of sharing.
+
+Status of This Memo
+
+ This is an Internet Standards Track document.
+
+ This document is a product of the Internet Engineering Task Force
+ (IETF). It represents the consensus of the IETF community. It has
+ received public review and has been approved for publication by the
+ Internet Engineering Steering Group (IESG). Further information on
+ Internet Standards is available in Section 2 of RFC 7841.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ https://www.rfc-editor.org/info/rfc9670.
+
+Copyright Notice
+
+ Copyright (c) 2024 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (https://trustee.ietf.org/license-info) in effect on the date of
+ publication of this document. Please review these documents
+ carefully, as they describe your rights and restrictions with respect
+ to this document. Code Components extracted from this document must
+ include Revised BSD License text as described in Section 4.e of the
+ Trust Legal Provisions and are provided without warranty as described
+ in the Revised BSD License.
+
+Table of Contents
+
+ 1. Introduction
+ 1.1. Notational Conventions
+ 1.2. Terminology
+ 1.3. Data Model Overview
+ 1.4. Subscribing to Shared Data
+ 1.5. Addition to the Capabilities Object
+ 1.5.1. urn:ietf:params:jmap:principals
+ 1.5.2. urn:ietf:params:jmap:principals:owner
+ 2. Principals
+ 2.1. Principal/get
+ 2.2. Principal/changes
+ 2.3. Principal/set
+ 2.4. Principal/query
+ 2.4.1. Filtering
+ 2.5. Principal/queryChanges
+ 3. ShareNotifications
+ 3.1. ShareNotification/get
+ 3.2. ShareNotification/changes
+ 3.3. ShareNotification/set
+ 3.4. ShareNotification/query
+ 3.4.1. Filtering
+ 3.4.2. Sorting
+ 3.5. ShareNotification/queryChanges
+ 4. Framework for Shared Data
+ 4.1. Example
+ 5. Internationalization Considerations
+ 6. Security Considerations
+ 6.1. Spoofing
+ 6.2. Unnoticed Sharing
+ 6.3. Denial of Service
+ 6.4. Unauthorized Principals
+ 7. IANA Considerations
+ 7.1. JMAP Capability Registration for "principals"
+ 7.2. JMAP Capability Registration for "principals:owner"
+ 7.3. JMAP Data Type Registration for "Principal"
+ 7.4. JMAP Data Type Registration for "ShareNotification"
+ 8. References
+ 8.1. Normative References
+ 8.2. Informative References
+ Author's Address
+
+1. Introduction
+
+ The JSON Meta Application Protocol (JMAP) [RFC8620] is a generic
+ protocol for synchronizing data, such as mail, calendars, or
+ contacts, between a client and a server. It is optimized for mobile
+ and web environments and provides a consistent interface to query,
+ read, and modify different data types, including comprehensive error
+ handling.
+
+ This specification defines a data model to represent entities in a
+ collaborative environment and a framework for sharing data between
+ them that can be used to provide a consistent sharing model for
+ different data types. It does not define _what_ may be shared or the
+ granularity of permissions, as this will depend on the data in
+ question.
+
+1.1. Notational Conventions
+
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
+ "OPTIONAL" in this document are to be interpreted as described in
+ BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
+ capitals, as shown here.
+
+ Type signatures, examples, and property descriptions in this document
+ follow the conventions established in Section 1.1 of [RFC8620]. Data
+ types defined in the core specification are also used in this
+ document.
+
+ Examples of API exchanges only show the methodCalls array of the
+ Request object or the methodResponses array of the Response object.
+ For compactness, the rest of the Request/Response object is omitted.
+
+1.2. Terminology
+
+ The same terminology is used in this document as in the core JMAP
+ specification. See [RFC8620], Section 1.6.
+
+ The terms "Principal" and "ShareNotification" (with this specific
+ capitalization) are used to refer to the data types defined in this
+ document and instances of those data types.
+
+1.3. Data Model Overview
+
+ A Principal (see Section 2) represents an individual, team, or
+ resource (e.g., a room or projector). The object contains
+ information about the entity being represented, such as a name,
+ description, and time zone. It may also hold domain-specific
+ information. A Principal may be associated with zero or more
+ Accounts (see [RFC8620], Section 1.6.2) containing data belonging to
+ the Principal. Managing the set of Principals within a system is out
+ of scope for this specification, as it is highly domain specific. It
+ is likely to map directly from a directory service or other user
+ management system.
+
+ Data types may allow users to share data with others by assigning
+ permissions to Principals. When a user's permissions are changed, a
+ ShareNotification object is created for them so a client can inform
+ the user of the changes.
+
+1.4. Subscribing to Shared Data
+
+ Permissions determine whether a user _may_ access data but not
+ whether they _want_ to. Some shared data is of equal importance as
+ the user's own, while other data is just there should the user wish
+ to explicitly go find it. Clients will often want to differentiate
+ the two. For example, a company may share mailing list archives for
+ all departments with all employees, but a user may only generally be
+ interested in the few they belong to. They would have _permission_
+ to access many mailboxes but can _subscribe_ to just the ones they
+ care about. The client would provide separate interfaces for reading
+ mail in subscribed mailboxes and browsing all mailboxes they have
+ permission to access in order to manage those that they are
+ subscribed to.
+
+ The JMAP Session object (see [RFC8620], Section 2) is defined to
+ include an object in the "accounts" property for every Account that
+ the user has access to. Collaborative systems may share data between
+ a very large number of Principals, most of which the user does not
+ care about day to day. For servers implementing this specification,
+ the Session object MUST only include Accounts where either the user
+ is subscribed to at least one record (see [RFC8620], Section 1.6.3)
+ in the Account or the Account belongs to the user. StateChange
+ events ([RFC8620], Section 7.1) for changes to data SHOULD only be
+ sent for data the user has subscribed to and MUST NOT be sent for any
+ Account where the user is not subscribed to any records in the
+ Account, except where that Account belongs to the user.
+
+ The server MAY reject the user's attempt to subscribe to some
+ resources even if they have permission to access them (e.g., a
+ calendar representing a location).
+
+ A user can query the set of Principals they have access to with
+ "Principal/query" (see Section 2.4). The Principal object will
+ contain an Account object for all Accounts where the user has
+ permission to access data for that Principal, even if they are not
+ yet subscribed.
+
+1.5. Addition to the Capabilities Object
+
+ The capabilities object is returned as part of the JMAP Session
+ object; see [RFC8620], Section 2. This document defines two
+ additional capability URIs.
+
+1.5.1. urn:ietf:params:jmap:principals
+
+ The urn:ietf:params:jmap:principals capability represents support for
+ the Principal and ShareNotification data types and associated API
+ methods.
+
+ The value of this property in the JMAP Session "capabilities"
+ property is an empty object.
+
+ The value of this property in an Account's "accountCapabilities"
+ property is an object that MUST contain the following information on
+ server capabilities and permissions for that Account:
+
+ *currentUserPrincipalId*: Id|null
+ The id of the Principal in this Account that corresponds to the
+ user fetching this object, if any.
+
+1.5.2. urn:ietf:params:jmap:principals:owner
+
+ The URI urn:ietf:params:jmap:principals:owner is solely used as a key
+ in an Account's "accountCapabilities" property. It does not appear
+ in the JMAP Session capabilities -- support is indicated by the
+ urn:ietf:params:jmap:principals URI being present in the session
+ capabilities.
+
+ If urn:ietf:params:jmap:principals:owner is a key in an Account's
+ "accountCapabilities" property, that Account (and the data therein)
+ is owned by a Principal. Some Accounts may not be owned by a
+ Principal (e.g., the Account that contains the data for the
+ Principals themselves), in which case this property is omitted.
+
+ The value of this property is an object with the following
+ properties:
+
+ *accountIdForPrincipal*: Id
+ The id of an Account with the urn:ietf:params:jmap:principals
+ capability that contains the corresponding Principal object.
+
+ *principalId*:Id
+ The id of the Principal that owns this Account.
+
+2. Principals
+
+ A Principal represents an individual, a group, a location (e.g., a
+ room), a resource (e.g., a projector), or another entity in a
+ collaborative environment. Sharing in JMAP is generally configured
+ by assigning rights to certain data within an Account to other
+ Principals. For example, a user may assign permission to read their
+ calendar to a Principal representing another user or their team.
+
+ In a shared environment, such as a workplace, a user may have access
+ to a large number of Principals.
+
+ In most systems, the user will have access to a single Account
+ containing Principal objects. In some situations, for example, when
+ aggregating data from different places, there may be multiple
+ Accounts containing Principal objects.
+
+ A *Principal* object has the following properties:
+
+ *id*: Id (immutable; server-set)
+ The id of the Principal.
+
+ *type*: String
+ This MUST be one of the following values:
+
+ * "individual": This represents a single person.
+ * "group": This represents a group of other Principals.
+ * "resource": This represents some resource, e.g., a projector.
+ * "location": This represents a location.
+ * "other": This represents some other undefined Principal.
+
+ *name*: String
+ The name of the Principal, e.g., "Jane Doe" or "Room 4B".
+
+ *description*: String|null
+ A longer description of the Principal, for example, details about
+ the facilities of a resource, or null if no description is
+ available.
+
+ *email*: String|null
+ An email address for the Principal, or null if no email is
+ available. If given, the value MUST conform to the "addr-spec"
+ syntax, as defined in [RFC5322], Section 3.4.1.
+
+ *timeZone*: String|null
+ The time zone for this Principal, if known. If not null, the
+ value MUST be a time zone name from the IANA Time Zone Database
+ [IANA-TZDB].
+
+ *capabilities*: String[Object] (server-set)
+ A map of JMAP capability URIs to domain-specific information about
+ the Principal in relation to that capability, as defined in the
+ document that registered the capability.
+
+ *accounts*: Id[Account]|null (server-set)
+ A map of Account id to Account object for each JMAP Account
+ containing data for this Principal that the user has access to, or
+ null if none.
+
+2.1. Principal/get
+
+ This is a standard "/get" method as described in [RFC8620],
+ Section 5.1.
+
+2.2. Principal/changes
+
+ This is a standard "/changes" method as described in [RFC8620],
+ Section 5.2.
+
+ | Note: Implementations backed by an external directory may be
+ | unable to calculate changes. In this case, they will always
+ | return a "cannotCalculateChanges" error as described in the
+ | core JMAP specification.
+
+2.3. Principal/set
+
+ This is a standard "/set" method as described in [RFC8620],
+ Section 5.3.
+
+ Managing Principals is likely tied to a directory service or some
+ other vendor-specific solution. This management may occur out of
+ band or via an additional capability defined elsewhere. Allowing
+ direct user modification of properties has security considerations,
+ as noted in Section 6. A server MUST reject any change it doesn't
+ allow with a "forbidden" SetError.
+
+ Where a server does support changes via this API, it SHOULD allow an
+ update to the "name", "description", and "timeZone" properties of the
+ Principal with the same id as the "currentUserPrincipalId" in the
+ Account capabilities. This allows the user to update their own
+ details.
+
+2.4. Principal/query
+
+ This is a standard "/query" method as described in [RFC8620],
+ Section 5.5.
+
+2.4.1. Filtering
+
+ A *FilterCondition* object has the following properties, all of which
+ are optional:
+
+ *accountIds*: String[]
+ A list of Account ids. The Principal matches if any of the ids in
+ this list are keys in the Principal's "accounts" property (i.e.,
+ if any of the Account ids belong to the Principal).
+
+ *email*: String
+ The email property of the Principal contains the given string.
+
+ *name*: String
+ The name property of the Principal contains the given string.
+
+ *text*: String
+ The name, email, or description property of the Principal contains
+ the given string.
+
+ *type*: String
+ The type must be exactly as given to match the condition.
+
+ *timeZone*: String
+ The timeZone must be exactly as given to match the condition.
+
+ All given conditions in the FilterCondition object must match for the
+ Principal to match.
+
+ Text matches for "contains" SHOULD be simple substring matches.
+
+2.5. Principal/queryChanges
+
+ This is a standard "/queryChanges" method as described in [RFC8620],
+ Section 5.6.
+
+ | Note: Implementations backed by an external directory may be
+ | unable to calculate changes. In this case, they will always
+ | return a "cannotCalculateChanges" error as described in the
+ | core JMAP specification.
+
+3. ShareNotifications
+
+ The ShareNotification data type records when the user's permissions
+ to access a shared object changes. ShareNotifications are only
+ created by the server; users cannot create them explicitly. They are
+ stored in the same Account as the Principals.
+
+ Clients may present the list of notifications to the user and allow
+ the user to dismiss them. To dismiss a notification, use a standard
+ "/set" call to destroy it.
+
+ The server SHOULD create a ShareNotification whenever the user's
+ permissions change on an object. It MAY choose not to create a
+ notification for permission changes to a group Principal, even if the
+ user is in the group, if this is more likely to be overwhelming than
+ helpful, or if it would create excessive notifications within the
+ system.
+
+ The server MAY limit the maximum number of notifications it will
+ store for a user. When the limit is reached, any new notification
+ will cause the previously oldest notification to be automatically
+ deleted.
+
+ The server MAY coalesce notifications if appropriate or remove
+ notifications after a certain period of time or that it deems are no
+ longer relevant.
+
+ A *ShareNotification* object has the following properties:
+
+ *id*: String (immutable; server-set)
+ The id of the ShareNotification.
+
+ *created*: UTCDate (immutable; server-set)
+ The time this notification was created.
+
+ *changedBy*: Entity (immutable; server-set)
+ Who made the change. An *Entity* object has the following
+ properties:
+
+ *name*: String
+ The name of the entity who made the change.
+ *email*: String|null
+ The email of the entity who made the change, or null if no
+ email is available.
+ *principalId*: Id|null
+ The id of the Principal corresponding to the entity who made
+ the change, or null if no associated Principal.
+
+ *objectType*: String (immutable; server-set)
+ The name of the data type for the object whose permissions have
+ changed, as registered in the IANA "JMAP Data Types" registry
+ [IANA-JMAP], e.g., "Calendar" or "Mailbox".
+
+ *objectAccountId*: Id (immutable; server-set)
+ The id of the Account where this object exists.
+
+ *objectId*: Id (immutable; server-set)
+ The id of the object that this notification is about.
+
+ *oldRights*: String[Boolean]|null (immutable; server-set)
+ The "myRights" property of the object for the user before the
+ change.
+
+ *newRights*: String[Boolean]|null (immutable; server-set)
+ The "myRights" property of the object for the user after the
+ change.
+
+ *name*: String (immutable; server-set)
+ The name of the object at the time the notification was made.
+ Determining the name will depend on the data type in question.
+ For example, it might be the "title" property of a CalendarEvent
+ or the "name" of a Mailbox. The name is to show users who have
+ had their access rights to the object removed what it is that they
+ can no longer access.
+
+3.1. ShareNotification/get
+
+ This is a standard "/get" method as described in [RFC8620],
+ Section 5.1.
+
+3.2. ShareNotification/changes
+
+ This is a standard "/changes" method as described in [RFC8620],
+ Section 5.2.
+
+3.3. ShareNotification/set
+
+ This is a standard "/set" method as described in [RFC8620],
+ Section 5.3.
+
+ Only destroy is supported; any attempt to create/update MUST be
+ rejected with a "forbidden" SetError.
+
+3.4. ShareNotification/query
+
+ This is a standard "/query" method as described in [RFC8620],
+ Section 5.5.
+
+3.4.1. Filtering
+
+ A *FilterCondition* object has the following properties, all of which
+ are optional:
+
+ *after*: UTCDate|null
+ The creation date must be on or after this date to match the
+ condition.
+
+ *before*: UTCDate|null
+ The creation date must be before this date to match the condition.
+
+ *objectType*: String
+ The objectType value must be identical to the given value to match
+ the condition.
+
+ *objectAccountId*: Id
+ The objectAccountId value must be identical to the given value to
+ match the condition.
+
+ All given conditions in the FilterCondition object must match for the
+ ShareNotification to match.
+
+3.4.2. Sorting
+
+ The "created" property MUST be supported for sorting.
+
+3.5. ShareNotification/queryChanges
+
+ This is a standard "/queryChanges" method as described in [RFC8620],
+ Section 5.6.
+
+4. Framework for Shared Data
+
+ Shareable data types MUST define the following three properties:
+
+ *isSubscribed*: Boolean
+ The value true indicates that the user wishes to subscribe to see
+ this data. The value false indicates that the user does not wish
+ to subscribe to see this data. The initial value for this
+ property when data is shared by another user is implementation
+ dependent, although data types may give advice on appropriate
+ defaults.
+
+ *myRights*: String[Boolean]
+ The set of permissions the user currently has. Appropriate
+ permissions are domain specific and must be defined per data type.
+ Each key is the name of a permission defined for that data type.
+ The value for the key is true if the user has the permission or
+ false if they do not.
+
+ *shareWith*: Id[String[Boolean]]|null
+ The value of this property is null if the data is not shared with
+ anyone. Otherwise, it is a map where each key is the id of a
+ Principal with which this data is shared, and the value associated
+ with that key is the rights to give that Principal, in the same
+ format as the "myRights" property. The Account id for the
+ Principal id can be found in the capabilities of the Account this
+ object is in (see Section 1.5.2).
+
+ Users with appropriate permission may set this property to modify
+ who the data is shared with. The Principal that owns the Account
+ that this data is in MUST NOT be in the map, since the owner's
+ rights are implicit.
+
+4.1. Example
+
+ Suppose we are designing a data model for a very simple to-do list.
+ There is a Todo data type representing a single item to do, each of
+ which belongs to a single TodoList. The specification makes the
+ TodoLists shareable by referencing this document and defining the
+ common properties.
+
+ First, it would define a set of domain-specific rights. For example,
+ a TodoListRights object may have the following properties:
+
+ *mayRead*: Boolean
+ The user may fetch this TodoList and any Todos that belong to this
+ TodoList.
+
+ *mayWrite*: Boolean
+ The user may create, update, or destroy Todos that belong to this
+ TodoList and may change the "name" property of this TodoList.
+
+ *mayAdmin*: Boolean
+ The user may see and modify the "myRights" property of this
+ TodoList and may destroy this TodoList.
+
+ Then in the TodoList data type, we would include the three common
+ properties described in Section 4, in addition to any type-specific
+ properties (like "name" in this case):
+
+ *id*: Id (immutable; server-set)
+ The id of the object.
+
+ *name*: String
+ A name for this list of Todos.
+
+ *isSubscribed*: Boolean
+ True if the user has indicated they wish to see this list. If
+ false, clients should not display this TodoList with the user's
+ other TodoLists but should provide a means for users to see and
+ subscribe to all TodoLists that have been shared with them.
+
+ *myRights*: TodoListRights
+ The set of permissions the user currently has for this TodoList.
+
+ *shareWith*: Id[TodoListRights]|null
+ If not shared with anyone, the value is null. Otherwise, it's a
+ map where the keys are Principal ids and the values are the rights
+ given to those Principals. Users with the "mayAdmin" right may
+ set this property to modify who the data is shared with. The
+ Principal that owns the Account that this data is in MUST NOT be
+ in the map; their rights are implicit.
+
+ We would also define a new Principal capability with two properties:
+
+ *accountId*: Id|null
+ The accountId containing the Todo data for this Principal, if it
+ has been shared with the requesting user.
+
+ *mayShareWith*: Boolean
+ The user may give this Principal permission to access a TodoList.
+
+ A client wishing to let the user configure sharing would look at the
+ "capabilities" for the Account containing the user's Todo data and
+ find the "urn:ietf:params:jmap:principals:owner" property, as per
+ Section 1.5.2. For example, the JMAP Session object might contain:
+
+ {
+ "accounts": {
+ "u12345678": {
+ "name": "jane.doe@example.com",
+ "isPersonal": true,
+ "isReadOnly": false,
+ "accountCapabilities": {
+ "urn:com.example:jmap:todo": {},
+ "urn:ietf:params:jmap:principals:owner": {
+ "accountIdForPrincipal": "u33084183",
+ "principalId": "P105aga511jaa"
+ }
+ }
+ },
+ ...
+ },
+ ...
+ }
+
+ Figure 1: Part of a JMAP Session Object
+
+ From this, the client now knows which Account has the Principal data,
+ and it can fetch the list of Principals and offer to share it with
+ the user by making an API request like this:
+
+ [[ "Principal/get", {
+ "accountId": "u33084183",
+ "ids": null
+ }, "0" ]]
+
+ Figure 2: "methodCalls" Property of a JMAP Request
+
+ Here's an example response (where "Joe Bloggs" is another user that
+ this user could share their TodoList with; Joe has not shared any of
+ their own data with this user, so the "accounts" property is null):
+
+ [[ "Principal/get", {
+ "accountId": "u33084183",
+ "state": "7b8eff5zz",
+ "list": [{
+ "id": "P2342fnddd20",
+ "type": "individual",
+ "name": "Joe Bloggs",
+ "description": null,
+ "email": "joe.bloggs@example.com",
+ "timeZone": "Australia/Melbourne",
+ "capabilities": {
+ "urn:com.example:jmap:todo": {
+ "accountId": null,
+ "mayShareWith": true
+ }
+ },
+ "accounts": null
+ }, {
+ "id": "P674pp24095qo49pr",
+ "name": "Board room",
+ "type": "location",
+ ...
+ }, ... ],
+ "notFound": []
+ }, "0" ]]
+
+ Figure 3: "methodResponses" Property of a JMAP Response
+
+ A TodoList can be shared with "Joe Bloggs" by updating its shareWith
+ property, as in this example request:
+
+ [[ "TodoList/set", {
+ "accountId": "u12345678",
+ "update": {
+ "tl01n231": {
+ "shareWith": {
+ "P2342fnddd20": {
+ "mayRead": true,
+ "mayWrite": true,
+ "mayAdmin": false
+ }
+ }
+ }
+ }
+ }, "0" ]]
+
+ Figure 4: "methodCalls" Property of a JMAP Request
+
+5. Internationalization Considerations
+
+ Experience has shown that unrestricted use of Unicode can lead to
+ problems such as inconsistent rendering, users reading text and
+ interpreting it differently than intended, and unexpected results
+ when copying text from one location to another. Servers MAY choose
+ to mitigate this by restricting the set of characters allowed in
+ otherwise unconstrained String fields. The FreeformClass, as
+ documented in [RFC8264], Section 4.3, might be a good starting point
+ for this.
+
+ Attempts to set a value containing code points outside of the
+ permissible set can be handled in a few ways by the server. The
+ first option is to simply strip the forbidden characters and store
+ the resulting string. This is likely to be appropriate for control
+ characters, for example, where they can end up in data accidentally
+ due to copy-and-paste issues and are probably invisible to the end
+ user. JMAP allows the server to transform data on create/update, as
+ long as any changed properties are returned to the client in the
+ "/set" response so it knows what has changed, as per [RFC8620],
+ Section 5.3. Alternatively, the server MAY just reject the create/
+ update with an "invalidProperties" SetError.
+
+6. Security Considerations
+
+ All security considerations of JMAP [RFC8620] apply to this
+ specification. Additional considerations are detailed below.
+
+6.1. Spoofing
+
+ Allowing users to edit their own Principal's name (and, to a lesser
+ extent, email, description, or type) could allow a user to change
+ their Principal to look like another user in the system, potentially
+ tricking others into sharing private data with them. Servers may
+ choose to forbid this and SHOULD keep logs of such changes to provide
+ an audit trail.
+
+ Note that simply forbidding the use of a name already in the system
+ is insufficient protection, as a malicious user could still change
+ their name to something easily confused with the existing name by
+ using trivial misspellings or visually similar Unicode characters.
+
+6.2. Unnoticed Sharing
+
+ Sharing data with another user allows someone to turn a transitory
+ account compromise (e.g., brief access to an unlocked or logged-in
+ client) into a persistent compromise (by setting up sharing with a
+ user that is controlled by the attacker). This can be mitigated by
+ requiring further authorization for configuring sharing or sending
+ notifications to the sharer via another channel whenever a new
+ permission is added.
+
+6.3. Denial of Service
+
+ By creating many changes to the sharing status of objects, a user can
+ cause many ShareNotifications to be generated, which could lead to
+ resource exhaustion. Servers can mitigate this by coalescing
+ multiple changes to the same object into a single notification,
+ limiting the maximum number of notifications it stores per user and/
+ or rate-limiting the changes to sharing permissions in the first
+ place. Automatically deleting older notifications after reaching a
+ limit can mean the user is not made aware of a sharing change, which
+ can itself be a security issue. For this reason, it is better to
+ coalesce changes and use other mitigation strategies.
+
+6.4. Unauthorized Principals
+
+ The set of Principals within a shared environment MUST be strictly
+ controlled. If adding a new Principal is open to the public, risks
+ include:
+
+ * An increased risk of a user accidentally sharing data with an
+ unintended person.
+ * An attacker sharing unwanted or offensive information with the
+ user.
+ * An attacker sharing items with spam content in the names in order
+ to generate ShareNotification objects, which are likely to be
+ prominently displayed to the user receiving them.
+
+7. IANA Considerations
+
+7.1. JMAP Capability Registration for "principals"
+
+ IANA has registered "principals" in the "JMAP Capabilities" registry
+ as follows:
+
+ Capability Name: urn:ietf:params:jmap:principals
+ Intended Use: common
+ Change Controller: IETF
+ Security and Privacy Considerations: RFC 9670, Section 6
+ Reference: RFC 9670
+
+7.2. JMAP Capability Registration for "principals:owner"
+
+ IANA has registered "principals:owner" in the "JMAP Capabilities"
+ registry as follows:
+
+ Capability Name: urn:ietf:params:jmap:principals:owner
+ Intended Use: common
+ Change Controller: IETF
+ Security and Privacy Considerations: RFC 9670, Section 6
+ Reference: RFC 9670
+
+7.3. JMAP Data Type Registration for "Principal"
+
+ IANA has registered "Principal" in the "JMAP Data Types" registry as
+ follows:
+
+ Type Name: Principal
+ Can Reference Blobs: No
+ Can Use for State Change: Yes
+ Capability: urn:ietf:params:jmap:principals
+ Reference: RFC 9670
+
+7.4. JMAP Data Type Registration for "ShareNotification"
+
+ IANA has registered "ShareNotification" in the "JMAP Data Types"
+ registry as follows:
+
+ Type Name: ShareNotification
+ Can Reference Blobs: No
+ Can Use for State Change: Yes
+ Capability: urn:ietf:params:jmap:principals
+ Reference: RFC 9670
+
+8. References
+
+8.1. Normative References
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119,
+ DOI 10.17487/RFC2119, March 1997,
+ .
+
+ [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
+ DOI 10.17487/RFC5322, October 2008,
+ .
+
+ [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
+ 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
+ May 2017, .
+
+ [RFC8620] Jenkins, N. and C. Newman, "The JSON Meta Application
+ Protocol (JMAP)", RFC 8620, DOI 10.17487/RFC8620, July
+ 2019, .
+
+8.2. Informative References
+
+ [IANA-JMAP]
+ IANA, "JMAP Data Types",
+ .
+
+ [IANA-TZDB]
+ IANA, "Time Zone Database",
+ .
+
+ [RFC8264] Saint-Andre, P. and M. Blanchet, "PRECIS Framework:
+ Preparation, Enforcement, and Comparison of
+ Internationalized Strings in Application Protocols",
+ RFC 8264, DOI 10.17487/RFC8264, October 2017,
+ .
+
+Author's Address
+
+ Neil Jenkins (editor)
+ Fastmail
+ PO Box 234, Collins St West
+ Melbourne VIC 8007
+ Australia
+ Email: neilj@fastmailteam.com
+ URI: https://www.fastmail.com
diff --git a/specifications/contacts/rfc6350.pdf b/specifications/contacts/rfc6350.pdf
new file mode 100644
index 00000000..a40987ca
Binary files /dev/null and b/specifications/contacts/rfc6350.pdf differ
diff --git a/specifications/contacts/rfc6350.txt b/specifications/contacts/rfc6350.txt
new file mode 100644
index 00000000..d853cbc6
--- /dev/null
+++ b/specifications/contacts/rfc6350.txt
@@ -0,0 +1,4147 @@
+
+
+
+
+
+
+Internet Engineering Task Force (IETF) S. Perreault
+Request for Comments: 6350 Viagenie
+Obsoletes: 2425, 2426, 4770 August 2011
+Updates: 2739
+Category: Standards Track
+ISSN: 2070-1721
+
+
+ vCard Format Specification
+
+Abstract
+
+ This document defines the vCard data format for representing and
+ exchanging a variety of information about individuals and other
+ entities (e.g., formatted and structured name and delivery addresses,
+ email address, multiple telephone numbers, photograph, logo, audio
+ clips, etc.). This document obsoletes RFCs 2425, 2426, and 4770, and
+ updates RFC 2739.
+
+Status of This Memo
+
+ This is an Internet Standards Track document.
+
+ This document is a product of the Internet Engineering Task Force
+ (IETF). It represents the consensus of the IETF community. It has
+ received public review and has been approved for publication by the
+ Internet Engineering Steering Group (IESG). Further information on
+ Internet Standards is available in Section 2 of RFC 5741.
+
+ Information about the current status of this document, any errata,
+ and how to provide feedback on it may be obtained at
+ http://www.rfc-editor.org/info/rfc6350.
+
+Copyright Notice
+
+ Copyright (c) 2011 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents
+ (http://trustee.ietf.org/license-info) in effect on the date of
+ publication of this document. Please review these documents
+ carefully, as they describe your rights and restrictions with respect
+ to this document. Code Components extracted from this document must
+ include Simplified BSD License text as described in Section 4.e of
+ the Trust Legal Provisions and are provided without warranty as
+ described in the Simplified BSD License.
+
+
+
+
+Perreault Standards Track [Page 1]
+
+RFC 6350 vCard August 2011
+
+
+ This document may contain material from IETF Documents or IETF
+ Contributions published or made publicly available before November
+ 10, 2008. The person(s) controlling the copyright in some of this
+ material may not have granted the IETF Trust the right to allow
+ modifications of such material outside the IETF Standards Process.
+ Without obtaining an adequate license from the person(s) controlling
+ the copyright in such materials, this document may not be modified
+ outside the IETF Standards Process, and derivative works of it may
+ not be created outside the IETF Standards Process, except to format
+ it for publication as an RFC or to translate it into languages other
+ than English.
+
+Table of Contents
+
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 3. vCard Format Specification . . . . . . . . . . . . . . . . . . 5
+ 3.1. Charset . . . . . . . . . . . . . . . . . . . . . . . . . 5
+ 3.2. Line Delimiting and Folding . . . . . . . . . . . . . . . 5
+ 3.3. ABNF Format Definition . . . . . . . . . . . . . . . . . . 6
+ 3.4. Property Value Escaping . . . . . . . . . . . . . . . . . 9
+ 4. Property Value Data Types . . . . . . . . . . . . . . . . . . 9
+ 4.1. TEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
+ 4.2. URI . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
+ 4.3. DATE, TIME, DATE-TIME, DATE-AND-OR-TIME, and TIMESTAMP . . 12
+ 4.3.1. DATE . . . . . . . . . . . . . . . . . . . . . . . . . 12
+ 4.3.2. TIME . . . . . . . . . . . . . . . . . . . . . . . . . 13
+ 4.3.3. DATE-TIME . . . . . . . . . . . . . . . . . . . . . . 13
+ 4.3.4. DATE-AND-OR-TIME . . . . . . . . . . . . . . . . . . . 14
+ 4.3.5. TIMESTAMP . . . . . . . . . . . . . . . . . . . . . . 14
+ 4.4. BOOLEAN . . . . . . . . . . . . . . . . . . . . . . . . . 14
+ 4.5. INTEGER . . . . . . . . . . . . . . . . . . . . . . . . . 15
+ 4.6. FLOAT . . . . . . . . . . . . . . . . . . . . . . . . . . 15
+ 4.7. UTC-OFFSET . . . . . . . . . . . . . . . . . . . . . . . . 15
+ 4.8. LANGUAGE-TAG . . . . . . . . . . . . . . . . . . . . . . . 16
+ 5. Property Parameters . . . . . . . . . . . . . . . . . . . . . 16
+ 5.1. LANGUAGE . . . . . . . . . . . . . . . . . . . . . . . . . 16
+ 5.2. VALUE . . . . . . . . . . . . . . . . . . . . . . . . . . 16
+ 5.3. PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
+ 5.4. ALTID . . . . . . . . . . . . . . . . . . . . . . . . . . 18
+ 5.5. PID . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
+ 5.6. TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
+ 5.7. MEDIATYPE . . . . . . . . . . . . . . . . . . . . . . . . 20
+ 5.8. CALSCALE . . . . . . . . . . . . . . . . . . . . . . . . . 20
+ 5.9. SORT-AS . . . . . . . . . . . . . . . . . . . . . . . . . 21
+ 5.10. GEO . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
+ 5.11. TZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
+
+
+
+
+Perreault Standards Track [Page 2]
+
+RFC 6350 vCard August 2011
+
+
+ 6. vCard Properties . . . . . . . . . . . . . . . . . . . . . . . 23
+ 6.1. General Properties . . . . . . . . . . . . . . . . . . . . 23
+ 6.1.1. BEGIN . . . . . . . . . . . . . . . . . . . . . . . . 23
+ 6.1.2. END . . . . . . . . . . . . . . . . . . . . . . . . . 23
+ 6.1.3. SOURCE . . . . . . . . . . . . . . . . . . . . . . . . 24
+ 6.1.4. KIND . . . . . . . . . . . . . . . . . . . . . . . . . 25
+ 6.1.5. XML . . . . . . . . . . . . . . . . . . . . . . . . . 27
+ 6.2. Identification Properties . . . . . . . . . . . . . . . . 28
+ 6.2.1. FN . . . . . . . . . . . . . . . . . . . . . . . . . . 28
+ 6.2.2. N . . . . . . . . . . . . . . . . . . . . . . . . . . 29
+ 6.2.3. NICKNAME . . . . . . . . . . . . . . . . . . . . . . . 29
+ 6.2.4. PHOTO . . . . . . . . . . . . . . . . . . . . . . . . 30
+ 6.2.5. BDAY . . . . . . . . . . . . . . . . . . . . . . . . . 30
+ 6.2.6. ANNIVERSARY . . . . . . . . . . . . . . . . . . . . . 31
+ 6.2.7. GENDER . . . . . . . . . . . . . . . . . . . . . . . . 32
+ 6.3. Delivery Addressing Properties . . . . . . . . . . . . . . 32
+ 6.3.1. ADR . . . . . . . . . . . . . . . . . . . . . . . . . 32
+ 6.4. Communications Properties . . . . . . . . . . . . . . . . 34
+ 6.4.1. TEL . . . . . . . . . . . . . . . . . . . . . . . . . 34
+ 6.4.2. EMAIL . . . . . . . . . . . . . . . . . . . . . . . . 36
+ 6.4.3. IMPP . . . . . . . . . . . . . . . . . . . . . . . . . 36
+ 6.4.4. LANG . . . . . . . . . . . . . . . . . . . . . . . . . 37
+ 6.5. Geographical Properties . . . . . . . . . . . . . . . . . 37
+ 6.5.1. TZ . . . . . . . . . . . . . . . . . . . . . . . . . . 37
+ 6.5.2. GEO . . . . . . . . . . . . . . . . . . . . . . . . . 38
+ 6.6. Organizational Properties . . . . . . . . . . . . . . . . 39
+ 6.6.1. TITLE . . . . . . . . . . . . . . . . . . . . . . . . 39
+ 6.6.2. ROLE . . . . . . . . . . . . . . . . . . . . . . . . . 39
+ 6.6.3. LOGO . . . . . . . . . . . . . . . . . . . . . . . . . 40
+ 6.6.4. ORG . . . . . . . . . . . . . . . . . . . . . . . . . 40
+ 6.6.5. MEMBER . . . . . . . . . . . . . . . . . . . . . . . . 41
+ 6.6.6. RELATED . . . . . . . . . . . . . . . . . . . . . . . 42
+ 6.7. Explanatory Properties . . . . . . . . . . . . . . . . . . 43
+ 6.7.1. CATEGORIES . . . . . . . . . . . . . . . . . . . . . . 43
+ 6.7.2. NOTE . . . . . . . . . . . . . . . . . . . . . . . . . 44
+ 6.7.3. PRODID . . . . . . . . . . . . . . . . . . . . . . . . 44
+ 6.7.4. REV . . . . . . . . . . . . . . . . . . . . . . . . . 45
+ 6.7.5. SOUND . . . . . . . . . . . . . . . . . . . . . . . . 45
+ 6.7.6. UID . . . . . . . . . . . . . . . . . . . . . . . . . 46
+ 6.7.7. CLIENTPIDMAP . . . . . . . . . . . . . . . . . . . . . 47
+ 6.7.8. URL . . . . . . . . . . . . . . . . . . . . . . . . . 47
+ 6.7.9. VERSION . . . . . . . . . . . . . . . . . . . . . . . 48
+ 6.8. Security Properties . . . . . . . . . . . . . . . . . . . 48
+ 6.8.1. KEY . . . . . . . . . . . . . . . . . . . . . . . . . 48
+ 6.9. Calendar Properties . . . . . . . . . . . . . . . . . . . 49
+ 6.9.1. FBURL . . . . . . . . . . . . . . . . . . . . . . . . 49
+ 6.9.2. CALADRURI . . . . . . . . . . . . . . . . . . . . . . 50
+ 6.9.3. CALURI . . . . . . . . . . . . . . . . . . . . . . . . 50
+
+
+
+Perreault Standards Track [Page 3]
+
+RFC 6350 vCard August 2011
+
+
+ 6.10. Extended Properties and Parameters . . . . . . . . . . . . 51
+ 7. Synchronization . . . . . . . . . . . . . . . . . . . . . . . 51
+ 7.1. Mechanisms . . . . . . . . . . . . . . . . . . . . . . . . 51
+ 7.1.1. Matching vCard Instances . . . . . . . . . . . . . . . 51
+ 7.1.2. Matching Property Instances . . . . . . . . . . . . . 52
+ 7.1.3. PID Matching . . . . . . . . . . . . . . . . . . . . . 52
+ 7.2. Example . . . . . . . . . . . . . . . . . . . . . . . . . 53
+ 7.2.1. Creation . . . . . . . . . . . . . . . . . . . . . . . 53
+ 7.2.2. Initial Sharing . . . . . . . . . . . . . . . . . . . 53
+ 7.2.3. Adding and Sharing a Property . . . . . . . . . . . . 54
+ 7.2.4. Simultaneous Editing . . . . . . . . . . . . . . . . . 54
+ 7.2.5. Global Context Simplification . . . . . . . . . . . . 56
+ 8. Example: Author's vCard . . . . . . . . . . . . . . . . . . . 56
+ 9. Security Considerations . . . . . . . . . . . . . . . . . . . 57
+ 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 58
+ 10.1. Media Type Registration . . . . . . . . . . . . . . . . . 58
+ 10.2. Registering New vCard Elements . . . . . . . . . . . . . . 59
+ 10.2.1. Registration Procedure . . . . . . . . . . . . . . . . 59
+ 10.2.2. Vendor Namespace . . . . . . . . . . . . . . . . . . . 60
+ 10.2.3. Registration Template for Properties . . . . . . . . . 61
+ 10.2.4. Registration Template for Parameters . . . . . . . . . 61
+ 10.2.5. Registration Template for Value Data Types . . . . . . 62
+ 10.2.6. Registration Template for Values . . . . . . . . . . . 62
+ 10.3. Initial vCard Elements Registries . . . . . . . . . . . . 63
+ 10.3.1. Properties Registry . . . . . . . . . . . . . . . . . 64
+ 10.3.2. Parameters Registry . . . . . . . . . . . . . . . . . 65
+ 10.3.3. Value Data Types Registry . . . . . . . . . . . . . . 65
+ 10.3.4. Values Registries . . . . . . . . . . . . . . . . . . 66
+ 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 69
+ 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 69
+ 12.1. Normative References . . . . . . . . . . . . . . . . . . . 69
+ 12.2. Informative References . . . . . . . . . . . . . . . . . . 71
+ Appendix A. Differences from RFCs 2425 and 2426 . . . . . . . . . 73
+ A.1. New Structure . . . . . . . . . . . . . . . . . . . . . . 73
+ A.2. Removed Features . . . . . . . . . . . . . . . . . . . . . 73
+ A.3. New Properties and Parameters . . . . . . . . . . . . . . 73
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 4]
+
+RFC 6350 vCard August 2011
+
+
+1. Introduction
+
+ Electronic address books have become ubiquitous. Their increased
+ presence on portable, connected devices as well as the diversity of
+ platforms that exchange contact data call for a standard. This memo
+ defines the vCard format, which allows the capture and exchange of
+ information normally stored within an address book or directory
+ application.
+
+ A high-level overview of the differences from RFCs 2425 and 2426 can
+ be found in Appendix A.
+
+2. Conventions
+
+ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+ "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
+ "OPTIONAL" in this document are to be interpreted as described in
+ [RFC2119].
+
+3. vCard Format Specification
+
+ The text/vcard MIME content type (hereafter known as "vCard"; see
+ Section 10.1) contains contact information, typically pertaining to a
+ single contact or group of contacts. The content consists of one or
+ more lines in the format given below.
+
+3.1. Charset
+
+ The charset (see [RFC3536] for internationalization terminology) for
+ vCard is UTF-8 as defined in [RFC3629]. There is no way to override
+ this. It is invalid to specify a value other than "UTF-8" in the
+ "charset" MIME parameter (see Section 10.1).
+
+3.2. Line Delimiting and Folding
+
+ Individual lines within vCard are delimited by the [RFC5322] line
+ break, which is a CRLF sequence (U+000D followed by U+000A). Long
+ logical lines of text can be split into a multiple-physical-line
+ representation using the following folding technique. Content lines
+ SHOULD be folded to a maximum width of 75 octets, excluding the line
+ break. Multi-octet characters MUST remain contiguous. The rationale
+ for this folding process can be found in [RFC5322], Section 2.1.1.
+
+ A logical line MAY be continued on the next physical line anywhere
+ between two characters by inserting a CRLF immediately followed by a
+ single white space character (space (U+0020) or horizontal tab
+ (U+0009)). The folded line MUST contain at least one character. Any
+ sequence of CRLF followed immediately by a single white space
+
+
+
+Perreault Standards Track [Page 5]
+
+RFC 6350 vCard August 2011
+
+
+ character is ignored (removed) when processing the content type. For
+ example, the line:
+
+ NOTE:This is a long description that exists on a long line.
+
+ can be represented as:
+
+ NOTE:This is a long description
+ that exists on a long line.
+
+ It could also be represented as:
+
+ NOTE:This is a long descrip
+ tion that exists o
+ n a long line.
+
+ The process of moving from this folded multiple-line representation
+ of a property definition to its single-line representation is called
+ unfolding. Unfolding is accomplished by regarding CRLF immediately
+ followed by a white space character (namely, HTAB (U+0009) or SPACE
+ (U+0020)) as equivalent to no characters at all (i.e., the CRLF and
+ single white space character are removed).
+
+ Note: It is possible for very simple implementations to generate
+ improperly folded lines in the middle of a UTF-8 multi-octet
+ sequence. For this reason, implementations SHOULD unfold lines in
+ such a way as to properly restore the original sequence.
+
+ Note: Unfolding is done differently than in [RFC5322]. Unfolding
+ in [RFC5322] only removes the CRLF, not the space following it.
+
+ Folding is done after any content encoding of a type value.
+ Unfolding is done before any decoding of a type value in a content
+ line.
+
+3.3. ABNF Format Definition
+
+ The following ABNF uses the notation of [RFC5234], which also defines
+ CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT.
+
+ vcard-entity = 1*vcard
+
+ vcard = "BEGIN:VCARD" CRLF
+ "VERSION:4.0" CRLF
+ 1*contentline
+ "END:VCARD" CRLF
+ ; A vCard object MUST include the VERSION and FN properties.
+ ; VERSION MUST come immediately after BEGIN:VCARD.
+
+
+
+Perreault Standards Track [Page 6]
+
+RFC 6350 vCard August 2011
+
+
+ contentline = [group "."] name *(";" param) ":" value CRLF
+ ; When parsing a content line, folded lines must first
+ ; be unfolded according to the unfolding procedure
+ ; described in Section 3.2.
+ ; When generating a content line, lines longer than 75
+ ; characters SHOULD be folded according to the folding
+ ; procedure described in Section 3.2.
+
+ group = 1*(ALPHA / DIGIT / "-")
+ name = "SOURCE" / "KIND" / "FN" / "N" / "NICKNAME"
+ / "PHOTO" / "BDAY" / "ANNIVERSARY" / "GENDER" / "ADR" / "TEL"
+ / "EMAIL" / "IMPP" / "LANG" / "TZ" / "GEO" / "TITLE" / "ROLE"
+ / "LOGO" / "ORG" / "MEMBER" / "RELATED" / "CATEGORIES"
+ / "NOTE" / "PRODID" / "REV" / "SOUND" / "UID" / "CLIENTPIDMAP"
+ / "URL" / "KEY" / "FBURL" / "CALADRURI" / "CALURI" / "XML"
+ / iana-token / x-name
+ ; Parsing of the param and value is based on the "name" as
+ ; defined in ABNF sections below.
+ ; Group and name are case-insensitive.
+
+ iana-token = 1*(ALPHA / DIGIT / "-")
+ ; identifier registered with IANA
+
+ x-name = "x-" 1*(ALPHA / DIGIT / "-")
+ ; Names that begin with "x-" or "X-" are
+ ; reserved for experimental use, not intended for released
+ ; products, or for use in bilateral agreements.
+
+ param = language-param / value-param / pref-param / pid-param
+ / type-param / geo-parameter / tz-parameter / sort-as-param
+ / calscale-param / any-param
+ ; Allowed parameters depend on property name.
+
+ param-value = *SAFE-CHAR / DQUOTE *QSAFE-CHAR DQUOTE
+
+ any-param = (iana-token / x-name) "=" param-value *("," param-value)
+
+ NON-ASCII = UTF8-2 / UTF8-3 / UTF8-4
+ ; UTF8-{2,3,4} are defined in [RFC3629]
+
+ QSAFE-CHAR = WSP / "!" / %x23-7E / NON-ASCII
+ ; Any character except CTLs, DQUOTE
+
+ SAFE-CHAR = WSP / "!" / %x23-39 / %x3C-7E / NON-ASCII
+ ; Any character except CTLs, DQUOTE, ";", ":"
+
+ VALUE-CHAR = WSP / VCHAR / NON-ASCII
+ ; Any textual character
+
+
+
+Perreault Standards Track [Page 7]
+
+RFC 6350 vCard August 2011
+
+
+ A line that begins with a white space character is a continuation of
+ the previous line, as described in Section 3.2. The white space
+ character and immediately preceeding CRLF should be discarded when
+ reconstructing the original line. Note that this line-folding
+ convention differs from that found in [RFC5322], in that the sequence
+ found anywhere in the content indicates a continued line
+ and should be removed.
+
+ Property names and parameter names are case-insensitive (e.g., the
+ property name "fn" is the same as "FN" and "Fn"). Parameter values
+ MAY be case-sensitive or case-insensitive, depending on their
+ definition. Parameter values that are not explicitly defined as
+ being case-sensitive are case-insensitive. Based on experience with
+ vCard 3 interoperability, it is RECOMMENDED that property and
+ parameter names be upper-case on output.
+
+ The group construct is used to group related properties together.
+ The group name is a syntactic convention used to indicate that all
+ property names prefaced with the same group name SHOULD be grouped
+ together when displayed by an application. It has no other
+ significance. Implementations that do not understand or support
+ grouping MAY simply strip off any text before a "." to the left of
+ the type name and present the types and values as normal.
+
+ Property cardinalities are indicated using the following notation,
+ which is based on ABNF (see [RFC5234], Section 3.6):
+
+ +-------------+--------------------------------------------------+
+ | Cardinality | Meaning |
+ +-------------+--------------------------------------------------+
+ | 1 | Exactly one instance per vCard MUST be present. |
+ | *1 | Exactly one instance per vCard MAY be present. |
+ | 1* | One or more instances per vCard MUST be present. |
+ | * | One or more instances per vCard MAY be present. |
+ +-------------+--------------------------------------------------+
+
+ Properties defined in a vCard instance may have multiple values
+ depending on the property cardinality. The general rule for encoding
+ multi-valued properties is to simply create a new content line for
+ each value (including the property name). However, it should be
+ noted that some value types support encoding multiple values in a
+ single content line by separating the values with a comma ",". This
+ approach has been taken for several of the content types defined
+ below (date, time, integer, float).
+
+
+
+
+
+
+
+Perreault Standards Track [Page 8]
+
+RFC 6350 vCard August 2011
+
+
+3.4. Property Value Escaping
+
+ Some properties may contain one or more values delimited by a COMMA
+ character (U+002C). Therefore, a COMMA character in a value MUST be
+ escaped with a BACKSLASH character (U+005C), even for properties that
+ don't allow multiple instances (for consistency).
+
+ Some properties (e.g., N and ADR) comprise multiple fields delimited
+ by a SEMICOLON character (U+003B). Therefore, a SEMICOLON in a field
+ of such a "compound" property MUST be escaped with a BACKSLASH
+ character. SEMICOLON characters in non-compound properties MAY be
+ escaped. On input, an escaped SEMICOLON character is never a field
+ separator. An unescaped SEMICOLON character may be a field
+ separator, depending on the property in which it appears.
+
+ Furthermore, some fields of compound properties may contain a list of
+ values delimited by a COMMA character. Therefore, a COMMA character
+ in one of a field's values MUST be escaped with a BACKSLASH
+ character, even for fields that don't allow multiple values (for
+ consistency). Compound properties allowing multiple instances MUST
+ NOT be encoded in a single content line.
+
+ Finally, BACKSLASH characters in values MUST be escaped with a
+ BACKSLASH character. NEWLINE (U+000A) characters in values MUST be
+ encoded by two characters: a BACKSLASH followed by either an 'n'
+ (U+006E) or an 'N' (U+004E).
+
+ In all other cases, escaping MUST NOT be used.
+
+4. Property Value Data Types
+
+ Standard value types are defined below.
+
+ value = text
+ / text-list
+ / date-list
+ / time-list
+ / date-time-list
+ / date-and-or-time-list
+ / timestamp-list
+ / boolean
+ / integer-list
+ / float-list
+ / URI ; from Section 3 of [RFC3986]
+ / utc-offset
+ / Language-Tag
+ / iana-valuespec
+ ; Actual value type depends on property name and VALUE parameter.
+
+
+
+Perreault Standards Track [Page 9]
+
+RFC 6350 vCard August 2011
+
+
+ text = *TEXT-CHAR
+
+ TEXT-CHAR = "\\" / "\," / "\n" / WSP / NON-ASCII
+ / %x21-2B / %x2D-5B / %x5D-7E
+ ; Backslashes, commas, and newlines must be encoded.
+
+ component = "\\" / "\," / "\;" / "\n" / WSP / NON-ASCII
+ / %x21-2B / %x2D-3A / %x3C-5B / %x5D-7E
+ list-component = component *("," component)
+
+ text-list = text *("," text)
+ date-list = date *("," date)
+ time-list = time *("," time)
+ date-time-list = date-time *("," date-time)
+ date-and-or-time-list = date-and-or-time *("," date-and-or-time)
+ timestamp-list = timestamp *("," timestamp)
+ integer-list = integer *("," integer)
+ float-list = float *("," float)
+
+ boolean = "TRUE" / "FALSE"
+ integer = [sign] 1*DIGIT
+ float = [sign] 1*DIGIT ["." 1*DIGIT]
+
+ sign = "+" / "-"
+
+ year = 4DIGIT ; 0000-9999
+ month = 2DIGIT ; 01-12
+ day = 2DIGIT ; 01-28/29/30/31 depending on month and leap year
+ hour = 2DIGIT ; 00-23
+ minute = 2DIGIT ; 00-59
+ second = 2DIGIT ; 00-58/59/60 depending on leap second
+ zone = utc-designator / utc-offset
+ utc-designator = %x5A ; uppercase "Z"
+
+ date = year [month day]
+ / year "-" month
+ / "--" month [day]
+ / "--" "-" day
+ date-noreduc = year month day
+ / "--" month day
+ / "--" "-" day
+ date-complete = year month day
+
+ time = hour [minute [second]] [zone]
+ / "-" minute [second] [zone]
+ / "-" "-" second [zone]
+ time-notrunc = hour [minute [second]] [zone]
+ time-complete = hour minute second [zone]
+
+
+
+Perreault Standards Track [Page 10]
+
+RFC 6350 vCard August 2011
+
+
+ time-designator = %x54 ; uppercase "T"
+ date-time = date-noreduc time-designator time-notrunc
+ timestamp = date-complete time-designator time-complete
+
+ date-and-or-time = date-time / date / time-designator time
+
+ utc-offset = sign hour [minute]
+
+ Language-Tag =
+
+ iana-valuespec =
+ ; a publicly defined valuetype format, registered
+ ; with IANA, as defined in Section 12 of this
+ ; document.
+
+4.1. TEXT
+
+ "text": The "text" value type should be used to identify values that
+ contain human-readable text. As for the language, it is controlled
+ by the LANGUAGE property parameter defined in Section 5.1.
+
+ Examples for "text":
+
+ this is a text value
+ this is one value,this is another
+ this is a single value\, with a comma encoded
+
+ A formatted text line break in a text value type MUST be represented
+ as the character sequence backslash (U+005C) followed by a Latin
+ small letter n (U+006E) or a Latin capital letter N (U+004E), that
+ is, "\n" or "\N".
+
+ For example, a multiple line NOTE value of:
+
+ Mythical Manager
+ Hyjinx Software Division
+ BabsCo, Inc.
+
+ could be represented as:
+
+ NOTE:Mythical Manager\nHyjinx Software Division\n
+ BabsCo\, Inc.\n
+
+ demonstrating the \n literal formatted line break technique, the
+ CRLF-followed-by-space line folding technique, and the backslash
+ escape technique.
+
+
+
+
+
+Perreault Standards Track [Page 11]
+
+RFC 6350 vCard August 2011
+
+
+4.2. URI
+
+ "uri": The "uri" value type should be used to identify values that
+ are referenced by a Uniform Resource Identifier (URI) instead of
+ encoded in-line. These value references might be used if the value
+ is too large, or otherwise undesirable to include directly. The
+ format for the URI is as defined in Section 3 of [RFC3986]. Note
+ that the value of a property of type "uri" is what the URI points to,
+ not the URI itself.
+
+ Examples for "uri":
+
+ http://www.example.com/my/picture.jpg
+ ldap://ldap.example.com/cn=babs%20jensen
+
+4.3. DATE, TIME, DATE-TIME, DATE-AND-OR-TIME, and TIMESTAMP
+
+ "date", "time", "date-time", "date-and-or-time", and "timestamp":
+ Each of these value types is based on the definitions in
+ [ISO.8601.2004]. Multiple such values can be specified using the
+ comma-separated notation.
+
+ Only the basic format is supported.
+
+4.3.1. DATE
+
+ A calendar date as specified in [ISO.8601.2004], Section 4.1.2.
+
+ Reduced accuracy, as specified in [ISO.8601.2004], Sections 4.1.2.3
+ a) and b), but not c), is permitted.
+
+ Expanded representation, as specified in [ISO.8601.2004], Section
+ 4.1.4, is forbidden.
+
+ Truncated representation, as specified in [ISO.8601.2000], Sections
+ 5.2.1.3 d), e), and f), is permitted.
+
+ Examples for "date":
+
+ 19850412
+ 1985-04
+ 1985
+ --0412
+ ---12
+
+
+
+
+
+
+
+Perreault Standards Track [Page 12]
+
+RFC 6350 vCard August 2011
+
+
+ Note the use of YYYY-MM in the second example above. YYYYMM is
+ disallowed to prevent confusion with YYMMDD. Note also that
+ YYYY-MM-DD is disallowed since we are using the basic format instead
+ of the extended format.
+
+4.3.2. TIME
+
+ A time of day as specified in [ISO.8601.2004], Section 4.2.
+
+ Reduced accuracy, as specified in [ISO.8601.2004], Section 4.2.2.3,
+ is permitted.
+
+ Representation with decimal fraction, as specified in
+ [ISO.8601.2004], Section 4.2.2.4, is forbidden.
+
+ The midnight hour is always represented by 00, never 24 (see
+ [ISO.8601.2004], Section 4.2.3).
+
+ Truncated representation, as specified in [ISO.8601.2000], Sections
+ 5.3.1.4 a), b), and c), is permitted.
+
+ Examples for "time":
+
+ 102200
+ 1022
+ 10
+ -2200
+ --00
+ 102200Z
+ 102200-0800
+
+4.3.3. DATE-TIME
+
+ A date and time of day combination as specified in [ISO.8601.2004],
+ Section 4.3.
+
+ Truncation of the date part, as specified in [ISO.8601.2000], Section
+ 5.4.2 c), is permitted.
+
+ Examples for "date-time":
+
+ 19961022T140000
+ --1022T1400
+ ---22T14
+
+
+
+
+
+
+
+Perreault Standards Track [Page 13]
+
+RFC 6350 vCard August 2011
+
+
+4.3.4. DATE-AND-OR-TIME
+
+ Either a DATE-TIME, a DATE, or a TIME value. To allow unambiguous
+ interpretation, a stand-alone TIME value is always preceded by a "T".
+
+ Examples for "date-and-or-time":
+
+ 19961022T140000
+ --1022T1400
+ ---22T14
+ 19850412
+ 1985-04
+ 1985
+ --0412
+ ---12
+ T102200
+ T1022
+ T10
+ T-2200
+ T--00
+ T102200Z
+ T102200-0800
+
+4.3.5. TIMESTAMP
+
+ A complete date and time of day combination as specified in
+ [ISO.8601.2004], Section 4.3.2.
+
+ Examples for "timestamp":
+
+ 19961022T140000
+ 19961022T140000Z
+ 19961022T140000-05
+ 19961022T140000-0500
+
+4.4. BOOLEAN
+
+ "boolean": The "boolean" value type is used to express boolean
+ values. These values are case-insensitive.
+
+ Examples:
+
+ TRUE
+ false
+ True
+
+
+
+
+
+
+Perreault Standards Track [Page 14]
+
+RFC 6350 vCard August 2011
+
+
+4.5. INTEGER
+
+ "integer": The "integer" value type is used to express signed
+ integers in decimal format. If sign is not specified, the value is
+ assumed positive "+". Multiple "integer" values can be specified
+ using the comma-separated notation. The maximum value is
+ 9223372036854775807, and the minimum value is -9223372036854775808.
+ These limits correspond to a signed 64-bit integer using two's-
+ complement arithmetic.
+
+ Examples:
+
+ 1234567890
+ -1234556790
+ +1234556790,432109876
+
+4.6. FLOAT
+
+ "float": The "float" value type is used to express real numbers. If
+ sign is not specified, the value is assumed positive "+". Multiple
+ "float" values can be specified using the comma-separated notation.
+ Implementations MUST support a precision equal or better than that of
+ the IEEE "binary64" format [IEEE.754.2008].
+
+ Note: Scientific notation is disallowed. Implementers wishing to
+ use their favorite language's %f formatting should be careful.
+
+ Examples:
+
+ 20.30
+ 1000000.0000001
+ 1.333,3.14
+
+4.7. UTC-OFFSET
+
+ "utc-offset": The "utc-offset" value type specifies that the property
+ value is a signed offset from UTC. This value type can be specified
+ in the TZ property.
+
+ The value type is an offset from Coordinated Universal Time (UTC).
+ It is specified as a positive or negative difference in units of
+ hours and minutes (e.g., +hhmm). The time is specified as a 24-hour
+ clock. Hour values are from 00 to 23, and minute values are from 00
+ to 59. Hour and minutes are 2 digits with high-order zeroes required
+ to maintain digit count. The basic format for ISO 8601 UTC offsets
+ MUST be used.
+
+
+
+
+
+Perreault Standards Track [Page 15]
+
+RFC 6350 vCard August 2011
+
+
+4.8. LANGUAGE-TAG
+
+ "language-tag": A single language tag, as defined in [RFC5646].
+
+5. Property Parameters
+
+ A property can have attributes associated with it. These "property
+ parameters" contain meta-information about the property or the
+ property value. In some cases, the property parameter can be multi-
+ valued in which case the property parameter value elements are
+ separated by a COMMA (U+002C).
+
+ Property parameter value elements that contain the COLON (U+003A),
+ SEMICOLON (U+003B), or COMMA (U+002C) character separators MUST be
+ specified as quoted-string text values. Property parameter values
+ MUST NOT contain the DQUOTE (U+0022) character. The DQUOTE character
+ is used as a delimiter for parameter values that contain restricted
+ characters or URI text.
+
+ Applications MUST ignore x-param and iana-param values they don't
+ recognize.
+
+5.1. LANGUAGE
+
+ The LANGUAGE property parameter is used to identify data in multiple
+ languages. There is no concept of "default" language, except as
+ specified by any "Content-Language" MIME header parameter that is
+ present [RFC3282]. The value of the LANGUAGE property parameter is a
+ language tag as defined in Section 2 of [RFC5646].
+
+ Examples:
+
+ ROLE;LANGUAGE=tr:hoca
+
+ ABNF:
+
+ language-param = "LANGUAGE=" Language-Tag
+ ; Language-Tag is defined in section 2.1 of RFC 5646
+
+5.2. VALUE
+
+ The VALUE parameter is OPTIONAL, used to identify the value type
+ (data type) and format of the value. The use of these predefined
+ formats is encouraged even if the value parameter is not explicitly
+ used. By defining a standard set of value types and their formats,
+ existing parsing and processing code can be leveraged. The
+
+
+
+
+
+Perreault Standards Track [Page 16]
+
+RFC 6350 vCard August 2011
+
+
+ predefined data type values MUST NOT be repeated in COMMA-separated
+ value lists except within the N, NICKNAME, ADR, and CATEGORIES
+ properties.
+
+ ABNF:
+
+ value-param = "VALUE=" value-type
+
+ value-type = "text"
+ / "uri"
+ / "date"
+ / "time"
+ / "date-time"
+ / "date-and-or-time"
+ / "timestamp"
+ / "boolean"
+ / "integer"
+ / "float"
+ / "utc-offset"
+ / "language-tag"
+ / iana-token ; registered as described in section 12
+ / x-name
+
+5.3. PREF
+
+ The PREF parameter is OPTIONAL and is used to indicate that the
+ corresponding instance of a property is preferred by the vCard
+ author. Its value MUST be an integer between 1 and 100 that
+ quantifies the level of preference. Lower values correspond to a
+ higher level of preference, with 1 being most preferred.
+
+ When the parameter is absent, the default MUST be to interpret the
+ property instance as being least preferred.
+
+ Note that the value of this parameter is to be interpreted only in
+ relation to values assigned to other instances of the same property
+ in the same vCard. A given value, or the absence of a value, MUST
+ NOT be interpreted on its own.
+
+ This parameter MAY be applied to any property that allows multiple
+ instances.
+
+ ABNF:
+
+ pref-param = "PREF=" (1*2DIGIT / "100")
+ ; An integer between 1 and 100.
+
+
+
+
+
+Perreault Standards Track [Page 17]
+
+RFC 6350 vCard August 2011
+
+
+5.4. ALTID
+
+ The ALTID parameter is used to "tag" property instances as being
+ alternative representations of the same logical property. For
+ example, translations of a property in multiple languages generates
+ multiple property instances having different LANGUAGE (Section 5.1)
+ parameter that are tagged with the same ALTID value.
+
+ This parameter's value is treated as an opaque string. Its sole
+ purpose is to be compared for equality against other ALTID parameter
+ values.
+
+ Two property instances are considered alternative representations of
+ the same logical property if and only if their names as well as the
+ value of their ALTID parameters are identical. Property instances
+ without the ALTID parameter MUST NOT be considered an alternative
+ representation of any other property instance. Values for the ALTID
+ parameter are not globally unique: they MAY be reused for different
+ property names.
+
+ Property instances having the same ALTID parameter value count as 1
+ toward cardinality. Therefore, since N (Section 6.2.2) has
+ cardinality *1 and TITLE (Section 6.6.1) has cardinality *, these
+ three examples would be legal:
+
+ N;ALTID=1;LANGUAGE=jp:;;;;
+ N;ALTID=1;LANGUAGE=en:Yamada;Taro;;;
+ ( denotes a UTF8-encoded Unicode character.)
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE;ALTID=1;LANGUAGE=en:Boss
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE;ALTID=1;LANGUAGE=en:Boss
+ TITLE;ALTID=2;LANGUAGE=en:Chief vCard Evangelist
+
+ while this one would not:
+
+ N;ALTID=1;LANGUAGE=jp:;;;;
+ N:Yamada;Taro;;;
+ (Two instances of the N property.)
+
+ and these three would be legal but questionable:
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE;ALTID=2;LANGUAGE=en:Boss
+ (Should probably have the same ALTID value.)
+
+
+
+
+Perreault Standards Track [Page 18]
+
+RFC 6350 vCard August 2011
+
+
+ TITLE;ALTID=1;LANGUAGE=fr:Patron
+ TITLE:LANGUAGE=en:Boss
+ (Second line should probably have ALTID=1.)
+
+ N;ALTID=1;LANGUAGE=jp:;;;;
+ N;ALTID=1;LANGUAGE=en:Yamada;Taro;;;
+ N;ALTID=1;LANGUAGE=en:Smith;John;;;
+ (The last line should probably have ALTID=2. But that would be
+ illegal because N has cardinality *1.)
+
+ The ALTID property MAY also be used in may contexts other than with
+ the LANGUAGE parameter. Here's an example with two representations
+ of the same photo in different file formats:
+
+ PHOTO;ALTID=1:data:image/jpeg;base64,...
+ PHOTO;ALTID=1;data:image/jp2;base64,...
+
+ ABNF:
+
+ altid-param = "ALTID=" param-value
+
+5.5. PID
+
+ The PID parameter is used to identify a specific property among
+ multiple instances. It plays a role analogous to the UID property
+ (Section 6.7.6) on a per-property instead of per-vCard basis. It MAY
+ appear more than once in a given property. It MUST NOT appear on
+ properties that may have only one instance per vCard. Its value is
+ either a single small positive integer or a pair of small positive
+ integers separated by a dot. Multiple values may be encoded in a
+ single PID parameter by separating the values with a comma ",". See
+ Section 7 for more details on its usage.
+
+ ABNF:
+
+ pid-param = "PID=" pid-value *("," pid-value)
+ pid-value = 1*DIGIT ["." 1*DIGIT]
+
+5.6. TYPE
+
+ The TYPE parameter has multiple, different uses. In general, it is a
+ way of specifying class characteristics of the associated property.
+ Most of the time, its value is a comma-separated subset of a
+ predefined enumeration. In this document, the following properties
+ make use of this parameter: FN, NICKNAME, PHOTO, ADR, TEL, EMAIL,
+ IMPP, LANG, TZ, GEO, TITLE, ROLE, LOGO, ORG, RELATED, CATEGORIES,
+
+
+
+
+
+Perreault Standards Track [Page 19]
+
+RFC 6350 vCard August 2011
+
+
+ NOTE, SOUND, URL, KEY, FBURL, CALADRURI, and CALURI. The TYPE
+ parameter MUST NOT be applied on other properties defined in this
+ document.
+
+ The "work" and "home" values act like tags. The "work" value implies
+ that the property is related to an individual's work place, while the
+ "home" value implies that the property is related to an individual's
+ personal life. When neither "work" nor "home" is present, it is
+ implied that the property is related to both an individual's work
+ place and personal life in the case that the KIND property's value is
+ "individual", or to none in other cases.
+
+ ABNF:
+
+ type-param = "TYPE=" type-value *("," type-value)
+
+ type-value = "work" / "home" / type-param-tel
+ / type-param-related / iana-token / x-name
+ ; This is further defined in individual property sections.
+
+5.7. MEDIATYPE
+
+ The MEDIATYPE parameter is used with properties whose value is a URI.
+ Its use is OPTIONAL. It provides a hint to the vCard consumer
+ application about the media type [RFC2046] of the resource identified
+ by the URI. Some URI schemes do not need this parameter. For
+ example, the "data" scheme allows the media type to be explicitly
+ indicated as part of the URI [RFC2397]. Another scheme, "http",
+ provides the media type as part of the URI resolution process, with
+ the Content-Type HTTP header [RFC2616]. The MEDIATYPE parameter is
+ intended to be used with URI schemes that do not provide such
+ functionality (e.g., "ftp" [RFC1738]).
+
+ ABNF:
+
+ mediatype-param = "MEDIATYPE=" mediatype
+ mediatype = type-name "/" subtype-name *( ";" attribute "=" value )
+ ; "attribute" and "value" are from [RFC2045]
+ ; "type-name" and "subtype-name" are from [RFC4288]
+
+5.8. CALSCALE
+
+ The CALSCALE parameter is identical to the CALSCALE property in
+ iCalendar (see [RFC5545], Section 3.7.1). It is used to define the
+ calendar system in which a date or date-time value is expressed. The
+ only value specified by iCalendar is "gregorian", which stands for
+ the Gregorian system. It is the default when the parameter is
+ absent. Additional values may be defined in extension documents and
+
+
+
+Perreault Standards Track [Page 20]
+
+RFC 6350 vCard August 2011
+
+
+ registered with IANA (see Section 10.3.4). A vCard implementation
+ MUST ignore properties with a CALSCALE parameter value that it does
+ not understand.
+
+ ABNF:
+
+ calscale-param = "CALSCALE=" calscale-value
+
+ calscale-value = "gregorian" / iana-token / x-name
+
+5.9. SORT-AS
+
+ The "sort-as" parameter is used to specify the string to be used for
+ national-language-specific sorting. Without this information,
+ sorting algorithms could incorrectly sort this vCard within a
+ sequence of sorted vCards. When this property is present in a vCard,
+ then the given strings are used for sorting the vCard.
+
+ This parameter's value is a comma-separated list that MUST have as
+ many or fewer elements as the corresponding property value has
+ components. This parameter's value is case-sensitive.
+
+ ABNF:
+
+ sort-as-param = "SORT-AS=" sort-as-value
+
+ sort-as-value = param-value *("," param-value)
+
+ Examples: For the case of surname and given name sorting, the
+ following examples define common sort string usage with the N
+ property.
+
+ FN:Rene van der Harten
+ N;SORT-AS="Harten,Rene":van der Harten;Rene,J.;Sir;R.D.O.N.
+
+ FN:Robert Pau Shou Chang
+ N;SORT-AS="Pau Shou Chang,Robert":Shou Chang;Robert,Pau;;
+
+ FN:Osamu Koura
+ N;SORT-AS="Koura,Osamu":Koura;Osamu;;
+
+ FN:Oscar del Pozo
+ N;SORT-AS="Pozo,Oscar":del Pozo Triscon;Oscar;;
+
+ FN:Chistine d'Aboville
+ N;SORT-AS="Aboville,Christine":d'Aboville;Christine;;
+
+
+
+
+
+Perreault Standards Track [Page 21]
+
+RFC 6350 vCard August 2011
+
+
+ FN:H. James de Mann
+ N;SORT-AS="Mann,James":de Mann;Henry,James;;
+
+ If sorted by surname, the results would be:
+
+ Christine d'Aboville
+ Rene van der Harten
+ Osamu Koura
+ H. James de Mann
+ Robert Pau Shou Chang
+ Oscar del Pozo
+
+ If sorted by given name, the results would be:
+
+ Christine d'Aboville
+ H. James de Mann
+ Osamu Koura
+ Oscar del Pozo
+ Rene van der Harten
+ Robert Pau Shou Chang
+
+5.10. GEO
+
+ The GEO parameter can be used to indicate global positioning
+ information that is specific to an address. Its value is the same as
+ that of the GEO property (see Section 6.5.2).
+
+ ABNF:
+
+ geo-parameter = "GEO=" DQUOTE URI DQUOTE
+
+5.11. TZ
+
+ The TZ parameter can be used to indicate time zone information that
+ is specific to an address. Its value is the same as that of the TZ
+ property.
+
+ ABNF:
+
+ tz-parameter = "TZ=" (param-value / DQUOTE URI DQUOTE)
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 22]
+
+RFC 6350 vCard August 2011
+
+
+6. vCard Properties
+
+ What follows is an enumeration of the standard vCard properties.
+
+6.1. General Properties
+
+6.1.1. BEGIN
+
+ Purpose: To denote the beginning of a syntactic entity within a
+ text/vcard content-type.
+
+ Value type: text
+
+ Cardinality: 1
+
+ Special notes: The content entity MUST begin with the BEGIN property
+ with a value of "VCARD". The value is case-insensitive.
+
+ The BEGIN property is used in conjunction with the END property to
+ delimit an entity containing a related set of properties within a
+ text/vcard content-type. This construct can be used instead of
+ including multiple vCards as body parts inside of a multipart/
+ alternative MIME message. It is provided for applications that
+ wish to define content that can contain multiple entities within
+ the same text/vcard content-type or to define content that can be
+ identifiable outside of a MIME environment.
+
+ ABNF:
+
+ BEGIN-param = 0" " ; no parameter allowed
+ BEGIN-value = "VCARD"
+
+ Example:
+
+ BEGIN:VCARD
+
+6.1.2. END
+
+ Purpose: To denote the end of a syntactic entity within a text/vcard
+ content-type.
+
+ Value type: text
+
+ Cardinality: 1
+
+ Special notes: The content entity MUST end with the END type with a
+ value of "VCARD". The value is case-insensitive.
+
+
+
+
+Perreault Standards Track [Page 23]
+
+RFC 6350 vCard August 2011
+
+
+ The END property is used in conjunction with the BEGIN property to
+ delimit an entity containing a related set of properties within a
+ text/vcard content-type. This construct can be used instead of or
+ in addition to wrapping separate sets of information inside
+ additional MIME headers. It is provided for applications that
+ wish to define content that can contain multiple entities within
+ the same text/vcard content-type or to define content that can be
+ identifiable outside of a MIME environment.
+
+ ABNF:
+
+ END-param = 0" " ; no parameter allowed
+ END-value = "VCARD"
+
+ Example:
+
+ END:VCARD
+
+6.1.3. SOURCE
+
+ Purpose: To identify the source of directory information contained
+ in the content type.
+
+ Value type: uri
+
+ Cardinality: *
+
+ Special notes: The SOURCE property is used to provide the means by
+ which applications knowledgable in the given directory service
+ protocol can obtain additional or more up-to-date information from
+ the directory service. It contains a URI as defined in [RFC3986]
+ and/or other information referencing the vCard to which the
+ information pertains. When directory information is available
+ from more than one source, the sending entity can pick what it
+ considers to be the best source, or multiple SOURCE properties can
+ be included.
+
+ ABNF:
+
+ SOURCE-param = "VALUE=uri" / pid-param / pref-param / altid-param
+ / mediatype-param / any-param
+ SOURCE-value = URI
+
+ Examples:
+
+ SOURCE:ldap://ldap.example.com/cn=Babs%20Jensen,%20o=Babsco,%20c=US
+
+
+
+
+
+Perreault Standards Track [Page 24]
+
+RFC 6350 vCard August 2011
+
+
+ SOURCE:http://directory.example.com/addressbooks/jdoe/
+ Jean%20Dupont.vcf
+
+6.1.4. KIND
+
+ Purpose: To specify the kind of object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: *1
+
+ Special notes: The value may be one of the following:
+
+ "individual" for a vCard representing a single person or entity.
+ This is the default kind of vCard.
+
+ "group" for a vCard representing a group of persons or entities.
+ The group's member entities can be other vCards or other types
+ of entities, such as email addresses or web sites. A group
+ vCard will usually contain MEMBER properties to specify the
+ members of the group, but it is not required to. A group vCard
+ without MEMBER properties can be considered an abstract
+ grouping, or one whose members are known empirically (perhaps
+ "IETF Participants" or "Republican U.S. Senators").
+
+ All properties in a group vCard apply to the group as a whole,
+ and not to any particular MEMBER. For example, an EMAIL
+ property might specify the address of a mailing list associated
+ with the group, and an IMPP property might refer to a group
+ chat room.
+
+ "org" for a vCard representing an organization. An organization
+ vCard will not (in fact, MUST NOT) contain MEMBER properties,
+ and so these are something of a cross between "individual" and
+ "group". An organization is a single entity, but not a person.
+ It might represent a business or government, a department or
+ division within a business or government, a club, an
+ association, or the like.
+
+ All properties in an organization vCard apply to the
+ organization as a whole, as is the case with a group vCard.
+ For example, an EMAIL property might specify the address of a
+ contact point for the organization.
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 25]
+
+RFC 6350 vCard August 2011
+
+
+ "location" for a named geographical place. A location vCard will
+ usually contain a GEO property, but it is not required to. A
+ location vCard without a GEO property can be considered an
+ abstract location, or one whose definition is known empirically
+ (perhaps "New England" or "The Seashore").
+
+ All properties in a location vCard apply to the location
+ itself, and not with any entity that might exist at that
+ location. For example, in a vCard for an office building, an
+ ADR property might give the mailing address for the building,
+ and a TEL property might specify the telephone number of the
+ receptionist.
+
+ An x-name. vCards MAY include private or experimental values for
+ KIND. Remember that x-name values are not intended for general
+ use and are unlikely to interoperate.
+
+ An iana-token. Additional values may be registered with IANA (see
+ Section 10.3.4). A new value's specification document MUST
+ specify which properties make sense for that new kind of vCard
+ and which do not.
+
+ Implementations MUST support the specific string values defined
+ above. If this property is absent, "individual" MUST be assumed
+ as the default. If this property is present but the
+ implementation does not understand its value (the value is an
+ x-name or iana-token that the implementation does not support),
+ the implementation SHOULD act in a neutral way, which usually
+ means treating the vCard as though its kind were "individual".
+ The presence of MEMBER properties MAY, however, be taken as an
+ indication that the unknown kind is an extension of "group".
+
+ Clients often need to visually distinguish contacts based on what
+ they represent, and the KIND property provides a direct way for
+ them to do so. For example, when displaying contacts in a list,
+ an icon could be displayed next to each one, using distinctive
+ icons for the different kinds; a client might use an outline of a
+ single person to represent an "individual", an outline of multiple
+ people to represent a "group", and so on. Alternatively, or in
+ addition, a client might choose to segregate different kinds of
+ vCards to different panes, tabs, or selections in the user
+ interface.
+
+ Some clients might also make functional distinctions among the
+ kinds, ignoring "location" vCards for some purposes and
+ considering only "location" vCards for others.
+
+
+
+
+
+Perreault Standards Track [Page 26]
+
+RFC 6350 vCard August 2011
+
+
+ When designing those sorts of visual and functional distinctions,
+ client implementations have to decide how to fit unsupported kinds
+ into the scheme. What icon is used for them? The one for
+ "individual"? A unique one, such as an icon of a question mark?
+ Which tab do they go into? It is beyond the scope of this
+ specification to answer these questions, but these are things
+ implementers need to consider.
+
+ ABNF:
+
+ KIND-param = "VALUE=text" / any-param
+ KIND-value = "individual" / "group" / "org" / "location"
+ / iana-token / x-name
+
+ Example:
+
+ This represents someone named Jane Doe working in the marketing
+ department of the North American division of ABC Inc.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:individual
+ FN:Jane Doe
+ ORG:ABC\, Inc.;North American Division;Marketing
+ END:VCARD
+
+ This represents the department itself, commonly known as ABC
+ Marketing.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:org
+ FN:ABC Marketing
+ ORG:ABC\, Inc.;North American Division;Marketing
+ END:VCARD
+
+6.1.5. XML
+
+ Purpose: To include extended XML-encoded vCard data in a plain
+ vCard.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: The content of this property is a single XML 1.0
+ [W3C.REC-xml-20081126] element whose namespace MUST be explicitly
+ specified using the xmlns attribute and MUST NOT be the vCard 4
+
+
+
+Perreault Standards Track [Page 27]
+
+RFC 6350 vCard August 2011
+
+
+ namespace ("urn:ietf:params:xml:ns:vcard-4.0"). (This implies
+ that it cannot duplicate a standard vCard property.) The element
+ is to be interpreted as if it was contained in a element,
+ as defined in [RFC6351].
+
+ The fragment is subject to normal line folding and escaping, i.e.,
+ replace all backslashes with "\\", then replace all newlines with
+ "\n", then fold long lines.
+
+ Support for this property is OPTIONAL, but implementations of this
+ specification MUST preserve instances of this property when
+ propagating vCards.
+
+ See [RFC6351] for more information on the intended use of this
+ property.
+
+ ABNF:
+
+ XML-param = "VALUE=text" / altid-param
+ XML-value = text
+
+6.2. Identification Properties
+
+ These types are used to capture information associated with the
+ identification and naming of the entity associated with the vCard.
+
+6.2.1. FN
+
+ Purpose: To specify the formatted text corresponding to the name of
+ the object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: 1*
+
+ Special notes: This property is based on the semantics of the X.520
+ Common Name attribute [CCITT.X520.1988]. The property MUST be
+ present in the vCard object.
+
+ ABNF:
+
+ FN-param = "VALUE=text" / type-param / language-param / altid-param
+ / pid-param / pref-param / any-param
+ FN-value = text
+
+ Example:
+
+ FN:Mr. John Q. Public\, Esq.
+
+
+
+Perreault Standards Track [Page 28]
+
+RFC 6350 vCard August 2011
+
+
+6.2.2. N
+
+ Purpose: To specify the components of the name of the object the
+ vCard represents.
+
+ Value type: A single structured text value. Each component can have
+ multiple values.
+
+ Cardinality: *1
+
+ Special note: The structured property value corresponds, in
+ sequence, to the Family Names (also known as surnames), Given
+ Names, Additional Names, Honorific Prefixes, and Honorific
+ Suffixes. The text components are separated by the SEMICOLON
+ character (U+003B). Individual text components can include
+ multiple text values separated by the COMMA character (U+002C).
+ This property is based on the semantics of the X.520 individual
+ name attributes [CCITT.X520.1988]. The property SHOULD be present
+ in the vCard object when the name of the object the vCard
+ represents follows the X.520 model.
+
+ The SORT-AS parameter MAY be applied to this property.
+
+ ABNF:
+
+ N-param = "VALUE=text" / sort-as-param / language-param
+ / altid-param / any-param
+ N-value = list-component 4(";" list-component)
+
+ Examples:
+
+ N:Public;John;Quinlan;Mr.;Esq.
+
+ N:Stevenson;John;Philip,Paul;Dr.;Jr.,M.D.,A.C.P.
+
+6.2.3. NICKNAME
+
+ Purpose: To specify the text corresponding to the nickname of the
+ object the vCard represents.
+
+ Value type: One or more text values separated by a COMMA character
+ (U+002C).
+
+ Cardinality: *
+
+
+
+
+
+
+
+Perreault Standards Track [Page 29]
+
+RFC 6350 vCard August 2011
+
+
+ Special note: The nickname is the descriptive name given instead of
+ or in addition to the one belonging to the object the vCard
+ represents. It can also be used to specify a familiar form of a
+ proper name specified by the FN or N properties.
+
+ ABNF:
+
+ NICKNAME-param = "VALUE=text" / type-param / language-param
+ / altid-param / pid-param / pref-param / any-param
+ NICKNAME-value = text-list
+
+ Examples:
+
+ NICKNAME:Robbie
+
+ NICKNAME:Jim,Jimmie
+
+ NICKNAME;TYPE=work:Boss
+
+6.2.4. PHOTO
+
+ Purpose: To specify an image or photograph information that
+ annotates some aspect of the object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ ABNF:
+
+ PHOTO-param = "VALUE=uri" / altid-param / type-param
+ / mediatype-param / pref-param / pid-param / any-param
+ PHOTO-value = URI
+
+ Examples:
+
+ PHOTO:http://www.example.com/pub/photos/jqpublic.gif
+
+ PHOTO:data:image/jpeg;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhv
+ AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
+ ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
+ <...remainder of base64-encoded data...>
+
+6.2.5. BDAY
+
+ Purpose: To specify the birth date of the object the vCard
+ represents.
+
+
+
+
+Perreault Standards Track [Page 30]
+
+RFC 6350 vCard August 2011
+
+
+ Value type: The default is a single date-and-or-time value. It can
+ also be reset to a single text value.
+
+ Cardinality: *1
+
+ ABNF:
+
+ BDAY-param = BDAY-param-date / BDAY-param-text
+ BDAY-value = date-and-or-time / text
+ ; Value and parameter MUST match.
+
+ BDAY-param-date = "VALUE=date-and-or-time"
+ BDAY-param-text = "VALUE=text" / language-param
+
+ BDAY-param =/ altid-param / calscale-param / any-param
+ ; calscale-param can only be present when BDAY-value is
+ ; date-and-or-time and actually contains a date or date-time.
+
+ Examples:
+
+ BDAY:19960415
+ BDAY:--0415
+ BDAY;19531015T231000Z
+ BDAY;VALUE=text:circa 1800
+
+6.2.6. ANNIVERSARY
+
+ Purpose: The date of marriage, or equivalent, of the object the
+ vCard represents.
+
+ Value type: The default is a single date-and-or-time value. It can
+ also be reset to a single text value.
+
+ Cardinality: *1
+
+ ABNF:
+
+ ANNIVERSARY-param = "VALUE=" ("date-and-or-time" / "text")
+ ANNIVERSARY-value = date-and-or-time / text
+ ; Value and parameter MUST match.
+
+ ANNIVERSARY-param =/ altid-param / calscale-param / any-param
+ ; calscale-param can only be present when ANNIVERSARY-value is
+ ; date-and-or-time and actually contains a date or date-time.
+
+ Examples:
+
+ ANNIVERSARY:19960415
+
+
+
+Perreault Standards Track [Page 31]
+
+RFC 6350 vCard August 2011
+
+
+6.2.7. GENDER
+
+ Purpose: To specify the components of the sex and gender identity of
+ the object the vCard represents.
+
+ Value type: A single structured value with two components. Each
+ component has a single text value.
+
+ Cardinality: *1
+
+ Special notes: The components correspond, in sequence, to the sex
+ (biological), and gender identity. Each component is optional.
+
+ Sex component: A single letter. M stands for "male", F stands
+ for "female", O stands for "other", N stands for "none or not
+ applicable", U stands for "unknown".
+
+ Gender identity component: Free-form text.
+
+ ABNF:
+
+ GENDER-param = "VALUE=text" / any-param
+ GENDER-value = sex [";" text]
+
+ sex = "" / "M" / "F" / "O" / "N" / "U"
+
+ Examples:
+
+ GENDER:M
+ GENDER:F
+ GENDER:M;Fellow
+ GENDER:F;grrrl
+ GENDER:O;intersex
+ GENDER:;it's complicated
+
+6.3. Delivery Addressing Properties
+
+ These types are concerned with information related to the delivery
+ addressing or label for the vCard object.
+
+6.3.1. ADR
+
+ Purpose: To specify the components of the delivery address for the
+ vCard object.
+
+ Value type: A single structured text value, separated by the
+ SEMICOLON character (U+003B).
+
+
+
+
+Perreault Standards Track [Page 32]
+
+RFC 6350 vCard August 2011
+
+
+ Cardinality: *
+
+ Special notes: The structured type value consists of a sequence of
+ address components. The component values MUST be specified in
+ their corresponding position. The structured type value
+ corresponds, in sequence, to
+ the post office box;
+ the extended address (e.g., apartment or suite number);
+ the street address;
+ the locality (e.g., city);
+ the region (e.g., state or province);
+ the postal code;
+ the country name (full name in the language specified in
+ Section 5.1).
+
+ When a component value is missing, the associated component
+ separator MUST still be specified.
+
+ Experience with vCard 3 has shown that the first two components
+ (post office box and extended address) are plagued with many
+ interoperability issues. To ensure maximal interoperability,
+ their values SHOULD be empty.
+
+ The text components are separated by the SEMICOLON character
+ (U+003B). Where it makes semantic sense, individual text
+ components can include multiple text values (e.g., a "street"
+ component with multiple lines) separated by the COMMA character
+ (U+002C).
+
+ The property can include the "PREF" parameter to indicate the
+ preferred delivery address when more than one address is
+ specified.
+
+ The GEO and TZ parameters MAY be used with this property.
+
+ The property can also include a "LABEL" parameter to present a
+ delivery address label for the address. Its value is a plain-text
+ string representing the formatted address. Newlines are encoded
+ as \n, as they are for property values.
+
+ ABNF:
+
+ label-param = "LABEL=" param-value
+
+ ADR-param = "VALUE=text" / label-param / language-param
+ / geo-parameter / tz-parameter / altid-param / pid-param
+ / pref-param / type-param / any-param
+
+
+
+
+Perreault Standards Track [Page 33]
+
+RFC 6350 vCard August 2011
+
+
+ ADR-value = ADR-component-pobox ";" ADR-component-ext ";"
+ ADR-component-street ";" ADR-component-locality ";"
+ ADR-component-region ";" ADR-component-code ";"
+ ADR-component-country
+ ADR-component-pobox = list-component
+ ADR-component-ext = list-component
+ ADR-component-street = list-component
+ ADR-component-locality = list-component
+ ADR-component-region = list-component
+ ADR-component-code = list-component
+ ADR-component-country = list-component
+
+ Example: In this example, the post office box and the extended
+ address are absent.
+
+ ADR;GEO="geo:12.3457,78.910";LABEL="Mr. John Q. Public, Esq.\n
+ Mail Drop: TNE QB\n123 Main Street\nAny Town, CA 91921-1234\n
+ U.S.A.":;;123 Main Street;Any Town;CA;91921-1234;U.S.A.
+
+6.4. Communications Properties
+
+ These properties describe information about how to communicate with
+ the object the vCard represents.
+
+6.4.1. TEL
+
+ Purpose: To specify the telephone number for telephony communication
+ with the object the vCard represents.
+
+ Value type: By default, it is a single free-form text value (for
+ backward compatibility with vCard 3), but it SHOULD be reset to a
+ URI value. It is expected that the URI scheme will be "tel", as
+ specified in [RFC3966], but other schemes MAY be used.
+
+ Cardinality: *
+
+ Special notes: This property is based on the X.520 Telephone Number
+ attribute [CCITT.X520.1988].
+
+ The property can include the "PREF" parameter to indicate a
+ preferred-use telephone number.
+
+ The property can include the parameter "TYPE" to specify intended
+ use for the telephone number. The predefined values for the TYPE
+ parameter are:
+
+
+
+
+
+
+Perreault Standards Track [Page 34]
+
+RFC 6350 vCard August 2011
+
+
+ +-----------+-------------------------------------------------------+
+ | Value | Description |
+ +-----------+-------------------------------------------------------+
+ | text | Indicates that the telephone number supports text |
+ | | messages (SMS). |
+ | voice | Indicates a voice telephone number. |
+ | fax | Indicates a facsimile telephone number. |
+ | cell | Indicates a cellular or mobile telephone number. |
+ | video | Indicates a video conferencing telephone number. |
+ | pager | Indicates a paging device telephone number. |
+ | textphone | Indicates a telecommunication device for people with |
+ | | hearing or speech difficulties. |
+ +-----------+-------------------------------------------------------+
+
+ The default type is "voice". These type parameter values can be
+ specified as a parameter list (e.g., TYPE=text;TYPE=voice) or as a
+ value list (e.g., TYPE="text,voice"). The default can be
+ overridden to another set of values by specifying one or more
+ alternate values. For example, the default TYPE of "voice" can be
+ reset to a VOICE and FAX telephone number by the value list
+ TYPE="voice,fax".
+
+ If this property's value is a URI that can also be used for
+ instant messaging, the IMPP (Section 6.4.3) property SHOULD be
+ used in addition to this property.
+
+ ABNF:
+
+ TEL-param = TEL-text-param / TEL-uri-param
+ TEL-value = TEL-text-value / TEL-uri-value
+ ; Value and parameter MUST match.
+
+ TEL-text-param = "VALUE=text"
+ TEL-text-value = text
+
+ TEL-uri-param = "VALUE=uri" / mediatype-param
+ TEL-uri-value = URI
+
+ TEL-param =/ type-param / pid-param / pref-param / altid-param
+ / any-param
+
+ type-param-tel = "text" / "voice" / "fax" / "cell" / "video"
+ / "pager" / "textphone" / iana-token / x-name
+ ; type-param-tel MUST NOT be used with a property other than TEL.
+
+
+
+
+
+
+
+Perreault Standards Track [Page 35]
+
+RFC 6350 vCard August 2011
+
+
+ Example:
+
+ TEL;VALUE=uri;PREF=1;TYPE="voice,home":tel:+1-555-555-5555;ext=5555
+ TEL;VALUE=uri;TYPE=home:tel:+33-01-23-45-67
+
+6.4.2. EMAIL
+
+ Purpose: To specify the electronic mail address for communication
+ with the object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: The property can include tye "PREF" parameter to
+ indicate a preferred-use email address when more than one is
+ specified.
+
+ Even though the value is free-form UTF-8 text, it is likely to be
+ interpreted by a Mail User Agent (MUA) as an "addr-spec", as
+ defined in [RFC5322], Section 3.4.1. Readers should also be aware
+ of the current work toward internationalized email addresses
+ [RFC5335bis].
+
+ ABNF:
+
+ EMAIL-param = "VALUE=text" / pid-param / pref-param / type-param
+ / altid-param / any-param
+ EMAIL-value = text
+
+ Example:
+
+ EMAIL;TYPE=work:jqpublic@xyz.example.com
+
+ EMAIL;PREF=1:jane_doe@example.com
+
+6.4.3. IMPP
+
+ Purpose: To specify the URI for instant messaging and presence
+ protocol communications with the object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ Special notes: The property may include the "PREF" parameter to
+ indicate that this is a preferred address and has the same
+ semantics as the "PREF" parameter in a TEL property.
+
+
+
+Perreault Standards Track [Page 36]
+
+RFC 6350 vCard August 2011
+
+
+ If this property's value is a URI that can be used for voice
+ and/or video, the TEL property (Section 6.4.1) SHOULD be used in
+ addition to this property.
+
+ This property is adapted from [RFC4770], which is made obsolete by
+ this document.
+
+ ABNF:
+
+ IMPP-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ IMPP-value = URI
+
+ Example:
+
+ IMPP;PREF=1:xmpp:alice@example.com
+
+6.4.4. LANG
+
+ Purpose: To specify the language(s) that may be used for contacting
+ the entity associated with the vCard.
+
+ Value type: A single language-tag value.
+
+ Cardinality: *
+
+ ABNF:
+
+ LANG-param = "VALUE=language-tag" / pid-param / pref-param
+ / altid-param / type-param / any-param
+ LANG-value = Language-Tag
+
+ Example:
+
+ LANG;TYPE=work;PREF=1:en
+ LANG;TYPE=work;PREF=2:fr
+ LANG;TYPE=home:fr
+
+6.5. Geographical Properties
+
+ These properties are concerned with information associated with
+ geographical positions or regions associated with the object the
+ vCard represents.
+
+6.5.1. TZ
+
+ Purpose: To specify information related to the time zone of the
+ object the vCard represents.
+
+
+
+Perreault Standards Track [Page 37]
+
+RFC 6350 vCard August 2011
+
+
+ Value type: The default is a single text value. It can also be
+ reset to a single URI or utc-offset value.
+
+ Cardinality: *
+
+ Special notes: It is expected that names from the public-domain
+ Olson database [TZ-DB] will be used, but this is not a
+ restriction. See also [IANA-TZ].
+
+ Efforts are currently being directed at creating a standard URI
+ scheme for expressing time zone information. Usage of such a
+ scheme would ensure a high level of interoperability between
+ implementations that support it.
+
+ Note that utc-offset values SHOULD NOT be used because the UTC
+ offset varies with time -- not just because of the usual daylight
+ saving time shifts that occur in may regions, but often entire
+ regions will "re-base" their overall offset. The actual offset
+ may be +/- 1 hour (or perhaps a little more) than the one given.
+
+ ABNF:
+
+ TZ-param = "VALUE=" ("text" / "uri" / "utc-offset")
+ TZ-value = text / URI / utc-offset
+ ; Value and parameter MUST match.
+
+ TZ-param =/ altid-param / pid-param / pref-param / type-param
+ / mediatype-param / any-param
+
+ Examples:
+
+ TZ:Raleigh/North America
+
+ TZ;VALUE=utc-offset:-0500
+ ; Note: utc-offset format is NOT RECOMMENDED.
+
+6.5.2. GEO
+
+ Purpose: To specify information related to the global positioning of
+ the object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ Special notes: The "geo" URI scheme [RFC5870] is particularly well
+ suited for this property, but other schemes MAY be used.
+
+
+
+
+Perreault Standards Track [Page 38]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ GEO-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ GEO-value = URI
+
+ Example:
+
+ GEO:geo:37.386013,-122.082932
+
+6.6. Organizational Properties
+
+ These properties are concerned with information associated with
+ characteristics of the organization or organizational units of the
+ object that the vCard represents.
+
+6.6.1. TITLE
+
+ Purpose: To specify the position or job of the object the vCard
+ represents.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: This property is based on the X.520 Title attribute
+ [CCITT.X520.1988].
+
+ ABNF:
+
+ TITLE-param = "VALUE=text" / language-param / pid-param
+ / pref-param / altid-param / type-param / any-param
+ TITLE-value = text
+
+ Example:
+
+ TITLE:Research Scientist
+
+6.6.2. ROLE
+
+ Purpose: To specify the function or part played in a particular
+ situation by the object the vCard represents.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+
+
+
+
+Perreault Standards Track [Page 39]
+
+RFC 6350 vCard August 2011
+
+
+ Special notes: This property is based on the X.520 Business Category
+ explanatory attribute [CCITT.X520.1988]. This property is
+ included as an organizational type to avoid confusion with the
+ semantics of the TITLE property and incorrect usage of that
+ property when the semantics of this property is intended.
+
+ ABNF:
+
+ ROLE-param = "VALUE=text" / language-param / pid-param / pref-param
+ / type-param / altid-param / any-param
+ ROLE-value = text
+
+ Example:
+
+ ROLE:Project Leader
+
+6.6.3. LOGO
+
+ Purpose: To specify a graphic image of a logo associated with the
+ object the vCard represents.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ ABNF:
+
+ LOGO-param = "VALUE=uri" / language-param / pid-param / pref-param
+ / type-param / mediatype-param / altid-param / any-param
+ LOGO-value = URI
+
+ Examples:
+
+ LOGO:http://www.example.com/pub/logos/abccorp.jpg
+
+ LOGO:data:image/jpeg;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhvc
+ AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
+ ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
+ <...the remainder of base64-encoded data...>
+
+6.6.4. ORG
+
+ Purpose: To specify the organizational name and units associated
+ with the vCard.
+
+ Value type: A single structured text value consisting of components
+ separated by the SEMICOLON character (U+003B).
+
+
+
+
+Perreault Standards Track [Page 40]
+
+RFC 6350 vCard August 2011
+
+
+ Cardinality: *
+
+ Special notes: The property is based on the X.520 Organization Name
+ and Organization Unit attributes [CCITT.X520.1988]. The property
+ value is a structured type consisting of the organization name,
+ followed by zero or more levels of organizational unit names.
+
+ The SORT-AS parameter MAY be applied to this property.
+
+ ABNF:
+
+ ORG-param = "VALUE=text" / sort-as-param / language-param
+ / pid-param / pref-param / altid-param / type-param
+ / any-param
+ ORG-value = component *(";" component)
+
+ Example: A property value consisting of an organizational name,
+ organizational unit #1 name, and organizational unit #2 name.
+
+ ORG:ABC\, Inc.;North American Division;Marketing
+
+6.6.5. MEMBER
+
+ Purpose: To include a member in the group this vCard represents.
+
+ Value type: A single URI. It MAY refer to something other than a
+ vCard object. For example, an email distribution list could
+ employ the "mailto" URI scheme [RFC6068] for efficiency.
+
+ Cardinality: *
+
+ Special notes: This property MUST NOT be present unless the value of
+ the KIND property is "group".
+
+ ABNF:
+
+ MEMBER-param = "VALUE=uri" / pid-param / pref-param / altid-param
+ / mediatype-param / any-param
+ MEMBER-value = URI
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 41]
+
+RFC 6350 vCard August 2011
+
+
+ Examples:
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:group
+ FN:The Doe family
+ MEMBER:urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af
+ MEMBER:urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519
+ END:VCARD
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:John Doe
+ UID:urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af
+ END:VCARD
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:Jane Doe
+ UID:urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519
+ END:VCARD
+
+ BEGIN:VCARD
+ VERSION:4.0
+ KIND:group
+ FN:Funky distribution list
+ MEMBER:mailto:subscriber1@example.com
+ MEMBER:xmpp:subscriber2@example.com
+ MEMBER:sip:subscriber3@example.com
+ MEMBER:tel:+1-418-555-5555
+ END:VCARD
+
+6.6.6. RELATED
+
+ Purpose: To specify a relationship between another entity and the
+ entity represented by this vCard.
+
+ Value type: A single URI. It can also be reset to a single text
+ value. The text value can be used to specify textual information.
+
+ Cardinality: *
+
+ Special notes: The TYPE parameter MAY be used to characterize the
+ related entity. It contains a comma-separated list of values that
+ are registered with IANA as described in Section 10.2. The
+ registry is pre-populated with the values defined in [xfn]. This
+ document also specifies two additional values:
+
+ agent: an entity who may sometimes act on behalf of the entity
+ associated with the vCard.
+
+
+
+Perreault Standards Track [Page 42]
+
+RFC 6350 vCard August 2011
+
+
+ emergency: indicates an emergency contact
+
+ ABNF:
+
+ RELATED-param = RELATED-param-uri / RELATED-param-text
+ RELATED-value = URI / text
+ ; Parameter and value MUST match.
+
+ RELATED-param-uri = "VALUE=uri" / mediatype-param
+ RELATED-param-text = "VALUE=text" / language-param
+
+ RELATED-param =/ pid-param / pref-param / altid-param / type-param
+ / any-param
+
+ type-param-related = related-type-value *("," related-type-value)
+ ; type-param-related MUST NOT be used with a property other than
+ ; RELATED.
+
+ related-type-value = "contact" / "acquaintance" / "friend" / "met"
+ / "co-worker" / "colleague" / "co-resident"
+ / "neighbor" / "child" / "parent"
+ / "sibling" / "spouse" / "kin" / "muse"
+ / "crush" / "date" / "sweetheart" / "me"
+ / "agent" / "emergency"
+
+ Examples:
+
+ RELATED;TYPE=friend:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+ RELATED;TYPE=contact:http://example.com/directory/jdoe.vcf
+ RELATED;TYPE=co-worker;VALUE=text:Please contact my assistant Jane
+ Doe for any inquiries.
+
+6.7. Explanatory Properties
+
+ These properties are concerned with additional explanations, such as
+ that related to informational notes or revisions specific to the
+ vCard.
+
+6.7.1. CATEGORIES
+
+ Purpose: To specify application category information about the
+ vCard, also known as "tags".
+
+ Value type: One or more text values separated by a COMMA character
+ (U+002C).
+
+ Cardinality: *
+
+
+
+
+Perreault Standards Track [Page 43]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ CATEGORIES-param = "VALUE=text" / pid-param / pref-param
+ / type-param / altid-param / any-param
+ CATEGORIES-value = text-list
+
+ Example:
+
+ CATEGORIES:TRAVEL AGENT
+
+ CATEGORIES:INTERNET,IETF,INDUSTRY,INFORMATION TECHNOLOGY
+
+6.7.2. NOTE
+
+ Purpose: To specify supplemental information or a comment that is
+ associated with the vCard.
+
+ Value type: A single text value.
+
+ Cardinality: *
+
+ Special notes: The property is based on the X.520 Description
+ attribute [CCITT.X520.1988].
+
+ ABNF:
+
+ NOTE-param = "VALUE=text" / language-param / pid-param / pref-param
+ / type-param / altid-param / any-param
+ NOTE-value = text
+
+ Example:
+
+ NOTE:This fax number is operational 0800 to 1715
+ EST\, Mon-Fri.
+
+6.7.3. PRODID
+
+ Purpose: To specify the identifier for the product that created the
+ vCard object.
+
+ Type value: A single text value.
+
+ Cardinality: *1
+
+ Special notes: Implementations SHOULD use a method such as that
+ specified for Formal Public Identifiers in [ISO9070] or for
+ Universal Resource Names in [RFC3406] to ensure that the text
+ value is unique.
+
+
+
+Perreault Standards Track [Page 44]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ PRODID-param = "VALUE=text" / any-param
+ PRODID-value = text
+
+ Example:
+
+ PRODID:-//ONLINE DIRECTORY//NONSGML Version 1//EN
+
+6.7.4. REV
+
+ Purpose: To specify revision information about the current vCard.
+
+ Value type: A single timestamp value.
+
+ Cardinality: *1
+
+ Special notes: The value distinguishes the current revision of the
+ information in this vCard for other renditions of the information.
+
+ ABNF:
+
+ REV-param = "VALUE=timestamp" / any-param
+ REV-value = timestamp
+
+ Example:
+
+ REV:19951031T222710Z
+
+6.7.5. SOUND
+
+ Purpose: To specify a digital sound content information that
+ annotates some aspect of the vCard. This property is often used
+ to specify the proper pronunciation of the name property value of
+ the vCard.
+
+ Value type: A single URI.
+
+ Cardinality: *
+
+ ABNF:
+
+ SOUND-param = "VALUE=uri" / language-param / pid-param / pref-param
+ / type-param / mediatype-param / altid-param
+ / any-param
+ SOUND-value = URI
+
+
+
+
+
+Perreault Standards Track [Page 45]
+
+RFC 6350 vCard August 2011
+
+
+ Example:
+
+ SOUND:CID:JOHNQPUBLIC.part8.19960229T080000.xyzMail@example.com
+
+ SOUND:data:audio/basic;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIh
+ AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
+ ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
+ <...the remainder of base64-encoded data...>
+
+6.7.6. UID
+
+ Purpose: To specify a value that represents a globally unique
+ identifier corresponding to the entity associated with the vCard.
+
+ Value type: A single URI value. It MAY also be reset to free-form
+ text.
+
+ Cardinality: *1
+
+ Special notes: This property is used to uniquely identify the object
+ that the vCard represents. The "uuid" URN namespace defined in
+ [RFC4122] is particularly well suited to this task, but other URI
+ schemes MAY be used. Free-form text MAY also be used.
+
+ ABNF:
+
+ UID-param = UID-uri-param / UID-text-param
+ UID-value = UID-uri-value / UID-text-value
+ ; Value and parameter MUST match.
+
+ UID-uri-param = "VALUE=uri"
+ UID-uri-value = URI
+
+ UID-text-param = "VALUE=text"
+ UID-text-value = text
+
+ UID-param =/ any-param
+
+ Example:
+
+ UID:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 46]
+
+RFC 6350 vCard August 2011
+
+
+6.7.7. CLIENTPIDMAP
+
+ Purpose: To give a global meaning to a local PID source identifier.
+
+ Value type: A semicolon-separated pair of values. The first field
+ is a small integer corresponding to the second field of a PID
+ parameter instance. The second field is a URI. The "uuid" URN
+ namespace defined in [RFC4122] is particularly well suited to this
+ task, but other URI schemes MAY be used.
+
+ Cardinality: *
+
+ Special notes: PID source identifiers (the source identifier is the
+ second field in a PID parameter instance) are small integers that
+ only have significance within the scope of a single vCard
+ instance. Each distinct source identifier present in a vCard MUST
+ have an associated CLIENTPIDMAP. See Section 7 for more details
+ on the usage of CLIENTPIDMAP.
+
+ PID source identifiers MUST be strictly positive. Zero is not
+ allowed.
+
+ As a special exception, the PID parameter MUST NOT be applied to
+ this property.
+
+ ABNF:
+
+ CLIENTPIDMAP-param = any-param
+ CLIENTPIDMAP-value = 1*DIGIT ";" URI
+
+ Example:
+
+ TEL;PID=3.1,4.2;VALUE=uri:tel:+1-555-555-5555
+ EMAIL;PID=4.1,5.2:jdoe@example.com
+ CLIENTPIDMAP:1;urn:uuid:3df403f4-5924-4bb7-b077-3c711d9eb34b
+ CLIENTPIDMAP:2;urn:uuid:d89c9c7a-2e1b-4832-82de-7e992d95faa5
+
+6.7.8. URL
+
+ Purpose: To specify a uniform resource locator associated with the
+ object to which the vCard refers. Examples for individuals
+ include personal web sites, blogs, and social networking site
+ identifiers.
+
+ Cardinality: *
+
+ Value type: A single uri value.
+
+
+
+
+Perreault Standards Track [Page 47]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ URL-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ URL-value = URI
+
+ Example:
+
+ URL:http://example.org/restaurant.french/~chezchic.html
+
+6.7.9. VERSION
+
+ Purpose: To specify the version of the vCard specification used to
+ format this vCard.
+
+ Value type: A single text value.
+
+ Cardinality: 1
+
+ Special notes: This property MUST be present in the vCard object,
+ and it must appear immediately after BEGIN:VCARD. The value MUST
+ be "4.0" if the vCard corresponds to this specification. Note
+ that earlier versions of vCard allowed this property to be placed
+ anywhere in the vCard object, or even to be absent.
+
+ ABNF:
+
+ VERSION-param = "VALUE=text" / any-param
+ VERSION-value = "4.0"
+
+ Example:
+
+ VERSION:4.0
+
+6.8. Security Properties
+
+ These properties are concerned with the security of communication
+ pathways or access to the vCard.
+
+6.8.1. KEY
+
+ Purpose: To specify a public key or authentication certificate
+ associated with the object that the vCard represents.
+
+ Value type: A single URI. It can also be reset to a text value.
+
+ Cardinality: *
+
+
+
+
+Perreault Standards Track [Page 48]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ KEY-param = KEY-uri-param / KEY-text-param
+ KEY-value = KEY-uri-value / KEY-text-value
+ ; Value and parameter MUST match.
+
+ KEY-uri-param = "VALUE=uri" / mediatype-param
+ KEY-uri-value = URI
+
+ KEY-text-param = "VALUE=text"
+ KEY-text-value = text
+
+ KEY-param =/ altid-param / pid-param / pref-param / type-param
+ / any-param
+
+ Examples:
+
+ KEY:http://www.example.com/keys/jdoe.cer
+
+ KEY;MEDIATYPE=application/pgp-keys:ftp://example.com/keys/jdoe
+
+ KEY:data:application/pgp-keys;base64,MIICajCCAdOgAwIBAgICBE
+ UwDQYJKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05l
+ <... remainder of base64-encoded data ...>
+
+6.9. Calendar Properties
+
+ These properties are further specified in [RFC2739].
+
+6.9.1. FBURL
+
+ Purpose: To specify the URI for the busy time associated with the
+ object that the vCard represents.
+
+ Value type: A single URI value.
+
+ Cardinality: *
+
+ Special notes: Where multiple FBURL properties are specified, the
+ default FBURL property is indicated with the PREF parameter. The
+ FTP [RFC1738] or HTTP [RFC2616] type of URI points to an iCalendar
+ [RFC5545] object associated with a snapshot of the next few weeks
+ or months of busy time data. If the iCalendar object is
+ represented as a file or document, its file extension should be
+ ".ifb".
+
+
+
+
+
+
+Perreault Standards Track [Page 49]
+
+RFC 6350 vCard August 2011
+
+
+ ABNF:
+
+ FBURL-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ FBURL-value = URI
+
+ Examples:
+
+ FBURL;PREF=1:http://www.example.com/busy/janedoe
+ FBURL;MEDIATYPE=text/calendar:ftp://example.com/busy/project-a.ifb
+
+6.9.2. CALADRURI
+
+ Purpose: To specify the calendar user address [RFC5545] to which a
+ scheduling request [RFC5546] should be sent for the object
+ represented by the vCard.
+
+ Value type: A single URI value.
+
+ Cardinality: *
+
+ Special notes: Where multiple CALADRURI properties are specified,
+ the default CALADRURI property is indicated with the PREF
+ parameter.
+
+ ABNF:
+
+ CALADRURI-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ CALADRURI-value = URI
+
+ Example:
+
+ CALADRURI;PREF=1:mailto:janedoe@example.com
+ CALADRURI:http://example.com/calendar/jdoe
+
+6.9.3. CALURI
+
+ Purpose: To specify the URI for a calendar associated with the
+ object represented by the vCard.
+
+ Value type: A single URI value.
+
+ Cardinality: *
+
+ Special notes: Where multiple CALURI properties are specified, the
+ default CALURI property is indicated with the PREF parameter. The
+ property should contain a URI pointing to an iCalendar [RFC5545]
+
+
+
+Perreault Standards Track [Page 50]
+
+RFC 6350 vCard August 2011
+
+
+ object associated with a snapshot of the user's calendar store.
+ If the iCalendar object is represented as a file or document, its
+ file extension should be ".ics".
+
+ ABNF:
+
+ CALURI-param = "VALUE=uri" / pid-param / pref-param / type-param
+ / mediatype-param / altid-param / any-param
+ CALURI-value = URI
+
+ Examples:
+
+ CALURI;PREF=1:http://cal.example.com/calA
+ CALURI;MEDIATYPE=text/calendar:ftp://ftp.example.com/calA.ics
+
+6.10. Extended Properties and Parameters
+
+ The properties and parameters defined by this document can be
+ extended. Non-standard, private properties and parameters with a
+ name starting with "X-" may be defined bilaterally between two
+ cooperating agents without outside registration or standardization.
+
+7. Synchronization
+
+ vCard data often needs to be synchronized between devices. In this
+ context, synchronization is defined as the intelligent merging of two
+ representations of the same object. vCard 4.0 includes mechanisms to
+ aid this process.
+
+7.1. Mechanisms
+
+ Two mechanisms are available: the UID property is used to match
+ multiple instances of the same vCard, while the PID parameter is used
+ to match multiple instances of the same property.
+
+ The term "matching" is used here to mean recognizing that two
+ instances are in fact representations of the same object. For
+ example, a single vCard that is shared with someone results in two
+ vCard instances. After they have evolved separately, they still
+ represent the same object, and therefore may be matched by a
+ synchronization engine.
+
+7.1.1. Matching vCard Instances
+
+ vCard instances for which the UID properties (Section 6.7.6) are
+ equivalent MUST be matched. Equivalence is determined as specified
+ in [RFC3986], Section 6.
+
+
+
+
+Perreault Standards Track [Page 51]
+
+RFC 6350 vCard August 2011
+
+
+ In all other cases, vCard instances MAY be matched at the discretion
+ of the synchronization engine.
+
+7.1.2. Matching Property Instances
+
+ Property instances belonging to unmatched vCards MUST NOT be matched.
+
+ Property instances whose name (e.g., EMAIL, TEL, etc.) is not the
+ same MUST NOT be matched.
+
+ Property instances whose name is CLIENTPIDMAP are handled separately
+ and MUST NOT be matched. The synchronization MUST ensure that there
+ is consistency of CLIENTPIDMAPs among matched vCard instances.
+
+ Property instances belonging to matched vCards, whose name is the
+ same, and whose maximum cardinality is 1, MUST be matched.
+
+ Property instances belonging to matched vCards, whose name is the
+ same, and whose PID parameters match, MUST be matched. See
+ Section 7.1.3 for details on PID matching.
+
+ In all other cases, property instances MAY be matched at the
+ discretion of the synchronization engine.
+
+7.1.3. PID Matching
+
+ Two PID values for which the first fields are equivalent represent
+ the same local value.
+
+ Two PID values representing the same local value and for which the
+ second fields point to CLIENTPIDMAP properties whose second field
+ URIs are equivalent (as specified in [RFC3986], Section 6) also
+ represent the same global value.
+
+ PID parameters for which at least one pair of their values represent
+ the same global value MUST be matched.
+
+ In all other cases, PID parameters MAY be matched at the discretion
+ of the synchronization engine.
+
+ For example, PID value "5.1", in the first vCard below, and PID value
+ "5.2", in the second vCard below, represent the same global value.
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 52]
+
+RFC 6350 vCard August 2011
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ EMAIL;PID=4.2,5.1:jdoe@example.com
+ CLIENTPIDMAP:1;urn:uuid:3eef374e-7179-4196-a914-27358c3e6527
+ CLIENTPIDMAP:2;urn:uuid:42bcd5a7-1699-4514-87b4-056edf68e9cc
+ END:VCARD
+
+ BEGIN:VCARD
+ VERSION:4.0
+ EMAIL;PID=5.1,5.2:john@example.com
+ CLIENTPIDMAP:1;urn:uuid:0c75c629-6a8d-4d5e-a07f-1bb35846854d
+ CLIENTPIDMAP:2;urn:uuid:3eef374e-7179-4196-a914-27358c3e6527
+ END:VCARD
+
+7.2. Example
+
+7.2.1. Creation
+
+ The following simple vCard is first created on a given device.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe@example.com
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ This new vCard is assigned the UID
+ "urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1" by the creating
+ device. The FN and EMAIL properties are assigned the same local
+ value of 1, and this value is given global context by associating it
+ with "urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556", which
+ represents the creating device. We are at liberty to reuse the same
+ local value since instances of different properties will never be
+ matched. The N property has no PID because it is forbidden by its
+ maximum cardinality of 1.
+
+7.2.2. Initial Sharing
+
+ This vCard is shared with a second device. Upon inspecting the UID
+ property, the second device understands that this is a new vCard
+ (i.e., unmatched) and thus the synchronization results in a simple
+ copy.
+
+
+
+
+
+
+Perreault Standards Track [Page 53]
+
+RFC 6350 vCard August 2011
+
+
+7.2.3. Adding and Sharing a Property
+
+ A new phone number is created on the first device, then the vCard is
+ shared with the second device. This is what the second device
+ receives:
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe@example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ Upon inspecting the UID property, the second device matches the vCard
+ it received to the vCard that it already has stored. It then starts
+ comparing the properties of the two vCards in same-named pairs.
+
+ The FN properties are matched because the PID parameters have the
+ same global value. Since the property value is the same, no update
+ takes place.
+
+ The N properties are matched automatically because their maximum
+ cardinality is 1. Since the property value is the same, no update
+ takes place.
+
+ The EMAIL properties are matched because the PID parameters have the
+ same global value. Since the property value is the same, no update
+ takes place.
+
+ The TEL property in the new vCard is not matched to any in the stored
+ vCard because no property in the stored vCard has the same name.
+ Therefore, this property is copied from the new vCard to the stored
+ vCard.
+
+ The CLIENTPIDMAP property is handled separately by the
+ synchronization engine. It ensures that it is consistent with the
+ stored one. If it was not, the results would be up to the
+ synchronization engine, and thus undefined by this document.
+
+7.2.4. Simultaneous Editing
+
+ A new email address and a new phone number are added to the vCard on
+ each of the two devices, and then a new synchronization event
+ happens. Here are the vCards that are communicated to each other:
+
+
+
+
+Perreault Standards Track [Page 54]
+
+RFC 6350 vCard August 2011
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe@example.com
+ EMAIL;PID=2.1:boss@example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.1;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN;PID=1.1:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe@example.com
+ EMAIL;PID=2.2:ceo@example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.2;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ CLIENTPIDMAP:2;urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee
+ END:VCARD
+
+ On the first device, the same PID source identifier (1) is reused for
+ the new EMAIL and TEL properties. On the second device, a new source
+ identifier (2) is generated, and a corresponding CLIENTPIDMAP
+ property is created. It contains the second device's identifier,
+ "urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee".
+
+ The new EMAIL properties are unmatched on both sides since the PID
+ global value is new in both cases. The sync thus results in a copy
+ on both sides.
+
+ Although the situation appears to be the same for the TEL properties,
+ in this case, the synchronization engine is particularly smart and
+ matches the two new TEL properties even though their PID global
+ values are different. Note that in this case, the rules of
+ Section 7.1.2 state that two properties MAY be matched at the
+ discretion of the synchronization engine. Therefore, the two
+ properties are merged.
+
+ All this results in the following vCard, which is stored on both
+ devices:
+
+
+
+
+
+
+Perreault Standards Track [Page 55]
+
+RFC 6350 vCard August 2011
+
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe@example.com
+ EMAIL;PID=2.1:boss@example.com
+ EMAIL;PID=2.2:ceo@example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.1,2.2;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ CLIENTPIDMAP:2;urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee
+ END:VCARD
+
+7.2.5. Global Context Simplification
+
+ The two devices finish their synchronization procedure by simplifying
+ their global contexts. Since they haven't talked to any other
+ device, the following vCard is for all purposes equivalent to the
+ above. It is also shorter.
+
+ BEGIN:VCARD
+ VERSION:4.0
+ UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
+ FN:J. Doe
+ N:Doe;J.;;;
+ EMAIL;PID=1.1:jdoe@example.com
+ EMAIL;PID=2.1:boss@example.com
+ EMAIL;PID=3.1:ceo@example.com
+ TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
+ TEL;PID=2.1;VALUE=uri:tel:+1-666-666-6666
+ CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
+ END:VCARD
+
+ The details of global context simplification are unspecified by this
+ document. They are left up to the synchronization engine. This
+ example is merely intended to illustrate the possibility, which
+ investigating would be, in the author's opinion, worthwhile.
+
+8. Example: Author's vCard
+
+ BEGIN:VCARD
+ VERSION:4.0
+ FN:Simon Perreault
+ N:Perreault;Simon;;;ing. jr,M.Sc.
+ BDAY:--0203
+ ANNIVERSARY:20090808T1430-0500
+ GENDER:M
+
+
+
+Perreault Standards Track [Page 56]
+
+RFC 6350 vCard August 2011
+
+
+ LANG;PREF=1:fr
+ LANG;PREF=2:en
+ ORG;TYPE=work:Viagenie
+ ADR;TYPE=work:;Suite D2-630;2875 Laurier;
+ Quebec;QC;G1V 2M2;Canada
+ TEL;VALUE=uri;TYPE="work,voice";PREF=1:tel:+1-418-656-9254;ext=102
+ TEL;VALUE=uri;TYPE="work,cell,voice,video,text":tel:+1-418-262-6501
+ EMAIL;TYPE=work:simon.perreault@viagenie.ca
+ GEO;TYPE=work:geo:46.772673,-71.282945
+ KEY;TYPE=work;VALUE=uri:
+ http://www.viagenie.ca/simon.perreault/simon.asc
+ TZ:-0500
+ URL;TYPE=home:http://nomis80.org
+ END:VCARD
+
+9. Security Considerations
+
+ o Internet mail is often used to transport vCards and is subject to
+ many well-known security attacks, including monitoring, replay,
+ and forgery. Care should be taken by any directory service in
+ allowing information to leave the scope of the service itself,
+ where any access controls or confidentiality can no longer be
+ guaranteed. Applications should also take care to display
+ directory data in a "safe" environment.
+
+ o vCards can carry cryptographic keys or certificates, as described
+ in Section 6.8.1.
+
+ o vCards often carry information that can be sensitive (e.g.,
+ birthday, address, and phone information). Although vCards have
+ no inherent authentication or confidentiality provisions, they can
+ easily be carried by any security mechanism that transfers MIME
+ objects to address authentication or confidentiality (e.g., S/MIME
+ [RFC5751], OpenPGP [RFC4880]). In cases where the confidentiality
+ or authenticity of information contained in vCard is a concern,
+ the vCard SHOULD be transported using one of these secure
+ mechanisms. The KEY property (Section 6.8.1) can be used to
+ transport the public key used by these mechanisms.
+
+ o The information in a vCard may become out of date. In cases where
+ the vitality of data is important to an originator of a vCard, the
+ SOURCE property (Section 6.1.3) SHOULD be specified. In addition,
+ the "REV" type described in Section 6.7.4 can be specified to
+ indicate the last time that the vCard data was updated.
+
+ o Many vCard properties may be used to transport URIs. Please refer
+ to [RFC3986], Section 7, for considerations related to URIs.
+
+
+
+
+Perreault Standards Track [Page 57]
+
+RFC 6350 vCard August 2011
+
+
+10. IANA Considerations
+
+10.1. Media Type Registration
+
+ IANA has registered the following Media Type (in
+ ) and marked the text/directory Media Type as
+ DEPRECATED.
+
+ To: ietf-types@iana.org
+
+ Subject: Registration of media type text/vcard
+
+ Type name: text
+
+ Subtype name: vcard
+
+ Required parameters: none
+
+ Optional parameters: version
+
+ The "version" parameter is to be interpreted identically as the
+ VERSION vCard property. If this parameter is present, all vCards
+ in a text/vcard body part MUST have a VERSION property with value
+ identical to that of this MIME parameter.
+
+ "charset": as defined for text/plain [RFC2046]; encodings other
+ than UTF-8 [RFC3629] MUST NOT be used.
+
+ Encoding considerations: 8bit
+
+ Security considerations: See Section 9.
+
+ Interoperability considerations: The text/vcard media type is
+ intended to identify vCard data of any version. There are older
+ specifications of vCard [RFC2426][vCard21] still in common use.
+ While these formats are similar, they are not strictly compatible.
+ In general, it is necessary to inspect the value of the VERSION
+ property (see Section 6.7.9) for identifying the standard to which
+ a given vCard object conforms.
+
+ In addition, the following media types are known to have been used
+ to refer to vCard data. They should be considered deprecated in
+ favor of text/vcard.
+
+ * text/directory
+ * text/directory; profile=vcard
+ * text/x-vcard
+
+
+
+
+Perreault Standards Track [Page 58]
+
+RFC 6350 vCard August 2011
+
+
+ Published specification: RFC 6350
+
+ Applications that use this media type: They are numerous, diverse,
+ and include mail user agents, instant messaging clients, address
+ book applications, directory servers, and customer relationship
+ management software.
+
+ Additional information:
+
+ Magic number(s):
+
+ File extension(s): .vcf .vcard
+
+ Macintosh file type code(s):
+
+ Person & email address to contact for further information: vCard
+ discussion mailing list
+
+ Intended usage: COMMON
+
+ Restrictions on usage: none
+
+ Author: Simon Perreault
+
+ Change controller: IETF
+
+10.2. Registering New vCard Elements
+
+ This section defines the process for registering new or modified
+ vCard elements (i.e., properties, parameters, value data types, and
+ values) with IANA.
+
+10.2.1. Registration Procedure
+
+ The IETF has created a mailing list, vcarddav@ietf.org, which can be
+ used for public discussion of vCard element proposals prior to
+ registration. Use of the mailing list is strongly encouraged. The
+ IESG has appointed a designated expert who will monitor the
+ vcarddav@ietf.org mailing list and review registrations.
+
+ Registration of new vCard elements MUST be reviewed by the designated
+ expert and published in an RFC. A Standards Track RFC is REQUIRED
+ for the registration of new value data types that modify existing
+ properties. A Standards Track RFC is also REQUIRED for registration
+ of vCard elements that modify vCard elements previously documented in
+ a Standards Track RFC.
+
+
+
+
+
+Perreault Standards Track [Page 59]
+
+RFC 6350 vCard August 2011
+
+
+ The registration procedure begins when a completed registration
+ template, defined in the sections below, is sent to vcarddav@ietf.org
+ and iana@iana.org. Within two weeks, the designated expert is
+ expected to tell IANA and the submitter of the registration whether
+ the registration is approved, approved with minor changes, or
+ rejected with cause. When a registration is rejected with cause, it
+ can be re-submitted if the concerns listed in the cause are
+ addressed. Decisions made by the designated expert can be appealed
+ to the IESG Applications Area Director, then to the IESG. They
+ follow the normal appeals procedure for IESG decisions.
+
+ Once the registration procedure concludes successfully, IANA creates
+ or modifies the corresponding record in the vCard registry. The
+ completed registration template is discarded.
+
+ An RFC specifying new vCard elements MUST include the completed
+ registration templates, which MAY be expanded with additional
+ information. These completed templates are intended to go in the
+ body of the document, not in the IANA Considerations section.
+
+ Finally, note that there is an XML representation for vCard defined
+ in [RFC6351]. An XML representation SHOULD be defined for new vCard
+ elements.
+
+10.2.2. Vendor Namespace
+
+ The vendor namespace is used for vCard elements associated with
+ commercially available products. "Vendor" or "producer" are
+ construed as equivalent and very broadly in this context.
+
+ A registration may be placed in the vendor namespace by anyone who
+ needs to interchange files associated with the particular product.
+ However, the registration formally belongs to the vendor or
+ organization handling the vCard elements in the namespace being
+ registered. Changes to the specification will be made at their
+ request, as discussed in subsequent sections.
+
+ vCard elements belonging to the vendor namespace will be
+ distinguished by the "VND-" prefix. This is followed by an IANA-
+ registered Private Enterprise Number (PEN), a dash, and a vCard
+ element designation of the vendor's choosing (e.g., "VND-123456-
+ MUDPIE").
+
+ While public exposure and review of vCard elements to be registered
+ in the vendor namespace are not required, using the vcarddav@ietf.org
+ mailing list for review is strongly encouraged to improve the quality
+ of those specifications. Registrations in the vendor namespace may
+ be submitted directly to the IANA.
+
+
+
+Perreault Standards Track [Page 60]
+
+RFC 6350 vCard August 2011
+
+
+10.2.3. Registration Template for Properties
+
+ A property is defined by completing the following template.
+
+ Namespace: Empty for the global namespace, "VND-NNNN-" for a vendor-
+ specific property (where NNNN is replaced by the vendor's PEN).
+
+ Property name: The name of the property.
+
+ Purpose: The purpose of the property. Give a short but clear
+ description.
+
+ Value type: Any of the valid value types for the property value
+ needs to be specified. The default value type also needs to be
+ specified.
+
+ Cardinality: See Section 6.
+
+ Property parameters: Any of the valid property parameters for the
+ property MUST be specified.
+
+ Description: Any special notes about the property, how it is to be
+ used, etc.
+
+ Format definition: The ABNF for the property definition needs to be
+ specified.
+
+ Example(s): One or more examples of instances of the property need
+ to be specified.
+
+10.2.4. Registration Template for Parameters
+
+ A parameter is defined by completing the following template.
+
+ Namespace: Empty for the global namespace, "VND-NNNN-" for a vendor-
+ specific property (where NNNN is replaced by the vendor's PEN).
+
+ Parameter name: The name of the parameter.
+
+ Purpose: The purpose of the parameter. Give a short but clear
+ description.
+
+ Description: Any special notes about the parameter, how it is to be
+ used, etc.
+
+ Format definition: The ABNF for the parameter definition needs to be
+ specified.
+
+
+
+
+Perreault Standards Track [Page 61]
+
+RFC 6350 vCard August 2011
+
+
+ Example(s): One or more examples of instances of the parameter need
+ to be specified.
+
+10.2.5. Registration Template for Value Data Types
+
+ A value data type is defined by completing the following template.
+
+ Value name: The name of the value type.
+
+ Purpose: The purpose of the value type. Give a short but clear
+ description.
+
+ Description: Any special notes about the value type, how it is to be
+ used, etc.
+
+ Format definition: The ABNF for the value type definition needs to
+ be specified.
+
+ Example(s): One or more examples of instances of the value type need
+ to be specified.
+
+10.2.6. Registration Template for Values
+
+ A value is defined by completing the following template.
+
+ Value: The value literal.
+
+ Purpose: The purpose of the value. Give a short but clear
+ description.
+
+ Conformance: The vCard properties and/or parameters that can take
+ this value needs to be specified.
+
+ Example(s): One or more examples of instances of the value need to
+ be specified.
+
+ The following is a fictitious example of a registration of a vCard
+ value:
+
+ Value: supervisor
+
+ Purpose: It means that the related entity is the direct hierarchical
+ superior (i.e., supervisor or manager) of the entity this vCard
+ represents.
+
+ Conformance: This value can be used with the "TYPE" parameter
+ applied on the "RELATED" property.
+
+
+
+
+Perreault Standards Track [Page 62]
+
+RFC 6350 vCard August 2011
+
+
+ Example(s):
+
+ RELATED;TYPE=supervisor:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
+
+10.3. Initial vCard Elements Registries
+
+ The IANA has created and will maintain the following registries for
+ vCard elements with pointers to appropriate reference documents. The
+ registries are grouped together under the heading "vCard Elements".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 63]
+
+RFC 6350 vCard August 2011
+
+
+10.3.1. Properties Registry
+
+ The following table has been used to initialize the properties
+ registry.
+
+ +-----------+--------------+-------------------------+
+ | Namespace | Property | Reference |
+ +-----------+--------------+-------------------------+
+ | | SOURCE | RFC 6350, Section 6.1.3 |
+ | | KIND | RFC 6350, Section 6.1.4 |
+ | | XML | RFC 6350, Section 6.1.5 |
+ | | FN | RFC 6350, Section 6.2.1 |
+ | | N | RFC 6350, Section 6.2.2 |
+ | | NICKNAME | RFC 6350, Section 6.2.3 |
+ | | PHOTO | RFC 6350, Section 6.2.4 |
+ | | BDAY | RFC 6350, Section 6.2.5 |
+ | | ANNIVERSARY | RFC 6350, Section 6.2.6 |
+ | | GENDER | RFC 6350, Section 6.2.7 |
+ | | ADR | RFC 6350, Section 6.3.1 |
+ | | TEL | RFC 6350, Section 6.4.1 |
+ | | EMAIL | RFC 6350, Section 6.4.2 |
+ | | IMPP | RFC 6350, Section 6.4.3 |
+ | | LANG | RFC 6350, Section 6.4.4 |
+ | | TZ | RFC 6350, Section 6.5.1 |
+ | | GEO | RFC 6350, Section 6.5.2 |
+ | | TITLE | RFC 6350, Section 6.6.1 |
+ | | ROLE | RFC 6350, Section 6.6.2 |
+ | | LOGO | RFC 6350, Section 6.6.3 |
+ | | ORG | RFC 6350, Section 6.6.4 |
+ | | MEMBER | RFC 6350, Section 6.6.5 |
+ | | RELATED | RFC 6350, Section 6.6.6 |
+ | | CATEGORIES | RFC 6350, Section 6.7.1 |
+ | | NOTE | RFC 6350, Section 6.7.2 |
+ | | PRODID | RFC 6350, Section 6.7.3 |
+ | | REV | RFC 6350, Section 6.7.4 |
+ | | SOUND | RFC 6350, Section 6.7.5 |
+ | | UID | RFC 6350, Section 6.7.6 |
+ | | CLIENTPIDMAP | RFC 6350, Section 6.7.7 |
+ | | URL | RFC 6350, Section 6.7.8 |
+ | | VERSION | RFC 6350, Section 6.7.9 |
+ | | KEY | RFC 6350, Section 6.8.1 |
+ | | FBURL | RFC 6350, Section 6.9.1 |
+ | | CALADRURI | RFC 6350, Section 6.9.2 |
+ | | CALURI | RFC 6350, Section 6.9.3 |
+ +-----------+--------------+-------------------------+
+
+
+
+
+
+
+Perreault Standards Track [Page 64]
+
+RFC 6350 vCard August 2011
+
+
+10.3.2. Parameters Registry
+
+ The following table has been used to initialize the parameters
+ registry.
+
+ +-----------+-----------+------------------------+
+ | Namespace | Parameter | Reference |
+ +-----------+-----------+------------------------+
+ | | LANGUAGE | RFC 6350, Section 5.1 |
+ | | VALUE | RFC 6350, Section 5.2 |
+ | | PREF | RFC 6350, Section 5.3 |
+ | | ALTID | RFC 6350, Section 5.4 |
+ | | PID | RFC 6350, Section 5.5 |
+ | | TYPE | RFC 6350, Section 5.6 |
+ | | MEDIATYPE | RFC 6350, Section 5.7 |
+ | | CALSCALE | RFC 6350, Section 5.8 |
+ | | SORT-AS | RFC 6350, Section 5.9 |
+ | | GEO | RFC 6350, Section 5.10 |
+ | | TZ | RFC 6350, Section 5.11 |
+ +-----------+-----------+------------------------+
+
+10.3.3. Value Data Types Registry
+
+ The following table has been used to initialize the parameters
+ registry.
+
+ +------------------+-------------------------+
+ | Value Data Type | Reference |
+ +------------------+-------------------------+
+ | BOOLEAN | RFC 6350, Section 4.4 |
+ | DATE | RFC 6350, Section 4.3.1 |
+ | DATE-AND-OR-TIME | RFC 6350, Section 4.3.4 |
+ | DATE-TIME | RFC 6350, Section 4.3.3 |
+ | FLOAT | RFC 6350, Section 4.6 |
+ | INTEGER | RFC 6350, Section 4.5 |
+ | LANGUAGE-TAG | RFC 6350, Section 4.8 |
+ | TEXT | RFC 6350, Section 4.1 |
+ | TIME | RFC 6350, Section 4.3.2 |
+ | TIMESTAMP | RFC 6350, Section 4.3.5 |
+ | URI | RFC 6350, Section 4.2 |
+ | UTC-OFFSET | RFC 6350, Section 4.7 |
+ +------------------+-------------------------+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 65]
+
+RFC 6350 vCard August 2011
+
+
+10.3.4. Values Registries
+
+ Separate tables are used for property and parameter values.
+
+ The following table is to be used to initialize the property values
+ registry.
+
+ +----------+------------+-------------------------+
+ | Property | Value | Reference |
+ +----------+------------+-------------------------+
+ | BEGIN | VCARD | RFC 6350, Section 6.1.1 |
+ | END | VCARD | RFC 6350, Section 6.1.2 |
+ | KIND | individual | RFC 6350, Section 6.1.4 |
+ | KIND | group | RFC 6350, Section 6.1.4 |
+ | KIND | org | RFC 6350, Section 6.1.4 |
+ | KIND | location | RFC 6350, Section 6.1.4 |
+ +----------+------------+-------------------------+
+
+ The following table has been used to initialize the parameter values
+ registry.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 66]
+
+RFC 6350 vCard August 2011
+
+
+ +------------------------+-----------+--------------+---------------+
+ | Property | Parameter | Value | Reference |
+ +------------------------+-----------+--------------+---------------+
+ | FN, NICKNAME, PHOTO, | TYPE | work | RFC 6350, |
+ | ADR, TEL, EMAIL, IMPP, | | | Section 5.6 |
+ | LANG, TZ, GEO, TITLE, | | | |
+ | ROLE, LOGO, ORG, | | | |
+ | RELATED, CATEGORIES, | | | |
+ | NOTE, SOUND, URL, KEY, | | | |
+ | FBURL, CALADRURI, and | | | |
+ | CALURI | | | |
+ | FN, NICKNAME, PHOTO, | TYPE | home | RFC 6350, |
+ | ADR, TEL, EMAIL, IMPP, | | | Section 5.6 |
+ | LANG, TZ, GEO, TITLE, | | | |
+ | ROLE, LOGO, ORG, | | | |
+ | RELATED, CATEGORIES, | | | |
+ | NOTE, SOUND, URL, KEY, | | | |
+ | FBURL, CALADRURI, and | | | |
+ | CALURI | | | |
+ | TEL | TYPE | text | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | voice | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | fax | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | cell | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | video | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | pager | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | TEL | TYPE | textphone | RFC 6350, |
+ | | | | Section 6.4.1 |
+ | BDAY, ANNIVERSARY | CALSCALE | gregorian | RFC 6350, |
+ | | | | Section 5.8 |
+ | RELATED | TYPE | contact | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | acquaintance | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | friend | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | met | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+
+
+
+
+Perreault Standards Track [Page 67]
+
+RFC 6350 vCard August 2011
+
+
+ | RELATED | TYPE | co-worker | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | colleague | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | co-resident | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | neighbor | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | child | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | parent | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | sibling | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | spouse | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | kin | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | muse | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | crush | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | date | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | sweetheart | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | me | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | | | | and [xfn] |
+ | RELATED | TYPE | agent | RFC 6350, |
+ | | | | Section 6.6.6 |
+ | RELATED | TYPE | emergency | RFC 6350, |
+ | | | | Section 6.6.6 |
+ +------------------------+-----------+--------------+---------------+
+
+
+
+
+Perreault Standards Track [Page 68]
+
+RFC 6350 vCard August 2011
+
+
+11. Acknowledgments
+
+ The authors would like to thank Tim Howes, Mark Smith, and Frank
+ Dawson, the original authors of [RFC2425] and [RFC2426], Pete
+ Resnick, who got this effort started and provided help along the way,
+ as well as the following individuals who have participated in the
+ drafting, review, and discussion of this memo:
+
+ Aki Niemi, Andy Mabbett, Alexander Mayrhofer, Alexey Melnikov, Anil
+ Srivastava, Barry Leiba, Ben Fortuna, Bernard Desruisseaux, Bernie
+ Hoeneisen, Bjoern Hoehrmann, Caleb Richardson, Chris Bryant, Chris
+ Newman, Cyrus Daboo, Daisuke Miyakawa, Dan Brickley, Dan Mosedale,
+ Dany Cauchie, Darryl Champagne, Dave Thewlis, Filip Navara, Florian
+ Zeitz, Helge Hess, Jari Urpalainen, Javier Godoy, Jean-Luc Schellens,
+ Joe Hildebrand, Jose Luis Gayosso, Joseph Smarr, Julian Reschke,
+ Kepeng Li, Kevin Marks, Kevin Wu Won, Kurt Zeilenga, Lisa Dusseault,
+ Marc Blanchet, Mark Paterson, Markus Lorenz, Michael Haardt, Mike
+ Douglass, Nick Levinson, Peter K. Sheerin, Peter Mogensen, Peter
+ Saint-Andre, Renato Iannella, Rohit Khare, Sly Gryphon, Stephane
+ Bortzmeyer, Tantek Celik, and Zoltan Ordogh.
+
+12. References
+
+12.1. Normative References
+
+ [CCITT.X520.1988]
+ International Telephone and Telegraph Consultative
+ Committee, "Information Technology - Open Systems
+ Interconnection - The Directory: Selected Attribute
+ Types", CCITT Recommendation X.520, November 1988.
+
+ [IEEE.754.2008]
+ Institute of Electrical and Electronics Engineers,
+ "Standard for Binary Floating-Point Arithmetic",
+ IEEE Standard 754, August 2008.
+
+ [ISO.8601.2000]
+ International Organization for Standardization, "Data
+ elements and interchange formats - Information interchange
+ - Representation of dates and times", ISO Standard 8601,
+ December 2000.
+
+ [ISO.8601.2004]
+ International Organization for Standardization, "Data
+ elements and interchange formats - Information interchange
+ - Representation of dates and times", ISO Standard 8601,
+ December 2004.
+
+
+
+
+Perreault Standards Track [Page 69]
+
+RFC 6350 vCard August 2011
+
+
+ [RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
+ Extensions (MIME) Part One: Format of Internet Message
+ Bodies", RFC 2045, November 1996.
+
+ [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
+ Extensions (MIME) Part Two: Media Types", RFC 2046,
+ November 1996.
+
+ [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
+ Requirement Levels", BCP 14, RFC 2119, March 1997.
+
+ [RFC2739] Small, T., Hennessy, D., and F. Dawson, "Calendar
+ Attributes for vCard and LDAP", RFC 2739, January 2000.
+
+ [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
+ 10646", STD 63, RFC 3629, November 2003.
+
+ [RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers",
+ RFC 3966, December 2004.
+
+ [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
+ Resource Identifier (URI): Generic Syntax", STD 66,
+ RFC 3986, January 2005.
+
+ [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
+ Unique IDentifier (UUID) URN Namespace", RFC 4122,
+ July 2005.
+
+ [RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and
+ Registration Procedures", BCP 13, RFC 4288, December 2005.
+
+ [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax
+ Specifications: ABNF", STD 68, RFC 5234, January 2008.
+
+ [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
+ October 2008.
+
+ [RFC5545] Desruisseaux, B., "Internet Calendaring and Scheduling
+ Core Object Specification (iCalendar)", RFC 5545,
+ September 2009.
+
+ [RFC5546] Daboo, C., "iCalendar Transport-Independent
+ Interoperability Protocol (iTIP)", RFC 5546,
+ December 2009.
+
+ [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
+ Languages", BCP 47, RFC 5646, September 2009.
+
+
+
+
+Perreault Standards Track [Page 70]
+
+RFC 6350 vCard August 2011
+
+
+ [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource
+ Identifier for Geographic Locations ('geo' URI)",
+ RFC 5870, June 2010.
+
+ [RFC6351] Perreault, S., "xCard: vCard XML Representation",
+ RFC 6351, August 2011.
+
+ [W3C.REC-xml-20081126]
+ Maler, E., Yergeau, F., Sperberg-McQueen, C., Paoli, J.,
+ and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth
+ Edition)", World Wide Web Consortium Recommendation REC-
+ xml-20081126, November 2008,
+ .
+
+ [xfn] Celik, T., Mullenweg, M., and E. Meyer, "XFN 1.1 profile",
+ .
+
+12.2. Informative References
+
+ [IANA-TZ] Lear, E. and P. Eggert, "IANA Procedures for Maintaining
+ the Timezone Database", Work in Progress, May 2011.
+
+ [ISO9070] International Organization for Standardization,
+ "Information Processing - SGML support facilities -
+ Registration Procedures for Public Text Owner
+ Identifiers", ISO 9070, April 1991.
+
+ [RFC1738] Berners-Lee, T., Masinter, L., and M. McCahill, "Uniform
+ Resource Locators (URL)", RFC 1738, December 1994.
+
+ [RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
+ August 1998.
+
+ [RFC2425] Howes, T., Smith, M., and F. Dawson, "A MIME Content-Type
+ for Directory Information", RFC 2425, September 1998.
+
+ [RFC2426] Dawson, F. and T. Howes, "vCard MIME Directory Profile",
+ RFC 2426, September 1998.
+
+ [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
+ Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
+ Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
+
+ [RFC3282] Alvestrand, H., "Content Language Headers", RFC 3282,
+ May 2002.
+
+
+
+
+
+
+Perreault Standards Track [Page 71]
+
+RFC 6350 vCard August 2011
+
+
+ [RFC3406] Daigle, L., van Gulik, D., Iannella, R., and P. Faltstrom,
+ "Uniform Resource Names (URN) Namespace Definition
+ Mechanisms", BCP 66, RFC 3406, October 2002.
+
+ [RFC3536] Hoffman, P., "Terminology Used in Internationalization in
+ the IETF", RFC 3536, May 2003.
+
+ [RFC4770] Jennings, C. and J. Reschke, Ed., "vCard Extensions for
+ Instant Messaging (IM)", RFC 4770, January 2007.
+
+ [RFC4880] Callas, J., Donnerhacke, L., Finney, H., Shaw, D., and R.
+ Thayer, "OpenPGP Message Format", RFC 4880, November 2007.
+
+ [RFC5335bis]
+ Yang, A. and S. Steele, "Internationalized Email Headers",
+ Work in Progress, July 2011.
+
+ [RFC5751] Ramsdell, B. and S. Turner, "Secure/Multipurpose Internet
+ Mail Extensions (S/MIME) Version 3.2 Message
+ Specification", RFC 5751, January 2010.
+
+ [RFC6068] Duerst, M., Masinter, L., and J. Zawinski, "The 'mailto'
+ URI Scheme", RFC 6068, October 2010.
+
+ [TZ-DB] Olson, A., "Time zone code and data",
+ .
+
+ [vCard21] Internet Mail Consortium, "vCard - The Electronic Business
+ Card Version 2.1", September 1996.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 72]
+
+RFC 6350 vCard August 2011
+
+
+Appendix A. Differences from RFCs 2425 and 2426
+
+ This appendix contains a high-level overview of the major changes
+ that have been made in the vCard specification from RFCs 2425 and
+ 2426. It is incomplete, as it only lists the most important changes.
+
+A.1. New Structure
+
+ o [RFC2425] and [RFC2426] have been merged.
+
+ o vCard is now not only a MIME type but a stand-alone format.
+
+ o A proper MIME type registration form has been included.
+
+ o UTF-8 is now the only possible character set.
+
+ o New vCard elements can be registered from IANA.
+
+A.2. Removed Features
+
+ o The CONTEXT and CHARSET parameters are no more.
+
+ o The NAME, MAILER, LABEL, and CLASS properties are no more.
+
+ o The "intl", "dom", "postal", and "parcel" TYPE parameter values
+ for the ADR property have been removed.
+
+ o In-line vCards (such as the value of the AGENT property) are no
+ longer supported.
+
+A.3. New Properties and Parameters
+
+ o The KIND, GENDER, LANG, ANNIVERSARY, XML, and CLIENTPIDMAP
+ properties have been added.
+
+ o [RFC2739], which defines the FBURL, CALADRURI, CAPURI, and CALURI
+ properties, has been merged in.
+
+ o [RFC4770], which defines the IMPP property, has been merged in.
+
+ o The "work" and "home" TYPE parameter values are now applicable to
+ many more properties.
+
+ o The "pref" value of the TYPE parameter is now a parameter of its
+ own, with a positive integer value indicating the level of
+ preference.
+
+ o The ALTID and PID parameters have been added.
+
+
+
+Perreault Standards Track [Page 73]
+
+RFC 6350 vCard August 2011
+
+
+ o The MEDIATYPE parameter has been added and replaces the TYPE
+ parameter when it was used for indicating the media type of the
+ property's content.
+
+Author's Address
+
+ Simon Perreault
+ Viagenie
+ 2875 Laurier, suite D2-630
+ Quebec, QC G1V 2M2
+ Canada
+
+ Phone: +1 418 656 9254
+ EMail: simon.perreault@viagenie.ca
+ URI: http://www.viagenie.ca
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Perreault Standards Track [Page 74]
+
diff --git a/specifications/contacts/rfc9553.pdf b/specifications/contacts/rfc9553.pdf
new file mode 100644
index 00000000..d58949d8
--- /dev/null
+++ b/specifications/contacts/rfc9553.pdf
@@ -0,0 +1,17115 @@
+%PDF-1.7
%
+3 0 obj
+<>/EmbeddedFiles 1639 0 R>>/Outlines 1788 0 R/OutputIntents 1789 0 R/Pages 1 0 R/Type/Catalog>>
+endobj
+1637 0 obj
+<>stream
+
+
+
+
+ application/pdf
+
+
+ Robert Stepanek, Mario Loffredo
+
+
+
+
+
This specification defines a data model and JavaScript Object Notation (JSON) representation of contact card
information that can be used for data storage and exchange in address book or directory applications. It aims to
be an alternative to the vCard data format and to be unambiguous, extendable, and simple to process. In contrast
to the JSON-based jCard format, it is not a direct mapping from the vCard data model and expands semantics where
appropriate. Two additional specifications define new vCard elements and how to convert between JSContact and
vCard.
+
+
+
+
+ RFC 9553: JSContact: A JSON Representation of Contact Data
+
+
+ xml2rfc 3.21.0
+ 2024-05-07T07:30:35-07:00
+ 2024-05-07T07:30:31-07:00
+ 2024-05-07T07:30:35-07:00
+ WeasyPrint 56.1
+ uuid:add3157a-b9ce-11b2-0a00-000000000000
+ uuid:adda0949-b9ce-11b2-0a00-690800000000
+ default
+ 1
+
+
+
+ converted
+ uuid:add3157e-b9ce-11b2-0a00-810700000000
+ converted to PDF/A-3u
+ pdfaPilot
+ 2024-05-07T07:30:35-07:00
+
+
+
+ 3
+ U
+
+
+
+ http://ns.adobe.com/pdf/1.3/
+ pdf
+ Adobe PDF Schema
+
+
+
+ internal
+ A name object indicating whether the document has been modified to include trapping information
+ Trapped
+ Text
+
+
+
+
+
+ http://ns.adobe.com/xap/1.0/mm/
+ xmpMM
+ XMP Media Management Schema
+
+
+
+ internal
+ UUID based identifier for specific incarnation of a document
+ InstanceID
+ URI
+
+
+ internal
+ The common identifier for all versions and renditions of a document.
+ OriginalDocumentID
+ URI
+
+
+
+
+
+ http://www.aiim.org/pdfa/ns/id/
+ pdfaid
+ PDF/A ID Schema
+
+
+
+ internal
+ Part of PDF/A standard
+ part
+ Integer
+
+
+ internal
+ Amendment of PDF/A standard
+ amd
+ Text
+
+
+ internal
+ Conformance level of PDF/A standard
+ conformance
+ Text
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+endstream
+endobj
+1788 0 obj
+<>
+endobj
+1789 0 obj
+[1792 0 R]
+endobj
+1 0 obj
+<>
+endobj
+6 0 obj
+<>
+endobj
+14 0 obj
+<>
+endobj
+95 0 obj
+<>
+endobj
+187 0 obj
+<>
+endobj
+276 0 obj
+<>
+endobj
+338 0 obj
+<>
+endobj
+358 0 obj
+<>
+endobj
+376 0 obj
+<>
+endobj
+385 0 obj
+<>
+endobj
+397 0 obj
+<>
+endobj
+408 0 obj
+<>
+endobj
+428 0 obj
+<>
+endobj
+453 0 obj
+<>
+endobj
+470 0 obj
+<>
+endobj
+491 0 obj
+<>
+endobj
+513 0 obj
+<>
+endobj
+529 0 obj
+<>
+endobj
+551 0 obj
+<>
+endobj
+570 0 obj
+<>
+endobj
+585 0 obj
+<>
+endobj
+601 0 obj
+<>
+endobj
+616 0 obj
+<>
+endobj
+629 0 obj
+<>
+endobj
+642 0 obj
+<>
+endobj
+651 0 obj
+<>
+endobj
+659 0 obj
+<>
+endobj
+670 0 obj
+<>
+endobj
+677 0 obj
+<>
+endobj
+687 0 obj
+<>
+endobj
+699 0 obj
+<>
+endobj
+710 0 obj
+<>
+endobj
+726 0 obj
+<>
+endobj
+740 0 obj
+<>
+endobj
+752 0 obj
+<>
+endobj
+769 0 obj
+<>
+endobj
+780 0 obj
+<>
+endobj
+792 0 obj
+<>
+endobj
+799 0 obj
+<>
+endobj
+804 0 obj
+<>
+endobj
+814 0 obj
+<>
+endobj
+826 0 obj
+<>
+endobj
+840 0 obj
+<>
+endobj
+855 0 obj
+<>
+endobj
+861 0 obj
+<>
+endobj
+871 0 obj
+<>
+endobj
+880 0 obj
+<>
+endobj
+890 0 obj
+<>
+endobj
+899 0 obj
+<>
+endobj
+912 0 obj
+<>
+endobj
+926 0 obj
+<>
+endobj
+936 0 obj
+<>
+endobj
+952 0 obj
+<>
+endobj
+960 0 obj
+<>
+endobj
+1021 0 obj
+<>
+endobj
+1055 0 obj
+<>
+endobj
+1100 0 obj
+<>
+endobj
+1141 0 obj
+<>
+endobj
+1173 0 obj
+<>
+endobj
+1189 0 obj
+<>
+endobj
+1215 0 obj
+<>
+endobj
+1235 0 obj
+<>
+endobj
+1246 0 obj
+<>
+endobj
+1267 0 obj
+<>
+endobj
+1289 0 obj
+<>
+endobj
+1313 0 obj
+<>
+endobj
+1334 0 obj
+<>
+endobj
+1357 0 obj
+<>
+endobj
+1376 0 obj
+<>
+endobj
+1400 0 obj
+<>
+endobj
+1414 0 obj
+<>
+endobj
+1432 0 obj
+<>
+endobj
+1454 0 obj
+<>
+endobj
+1476 0 obj
+<>
+endobj
+1865 0 obj
+<>stream
+x[[s>ԲXu);MNN*KZJb3mʋ}Cz i$Lc@,p=o]HxNHBΌq{.?ӗ?qͽ>Q#9?}?|7
~H2eI}PNgè,detYNj~=Z:P˥~:oT\pa{)dc
#)W:*yq'oOF̲.{xgh|fn(Kkb>w{E.~Q!˷-
+-1:7Vp"8Ո"Gl̞@c7̲ePm):W^fc
ţW\<
+
+A˜6"٪S@L^c&Z