asciidoctor-rfc 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +5 -0
- data/.oss-guides.rubocop.yml +1077 -0
- data/.rspec +1 -0
- data/.rubocop.yml +19 -1063
- data/.travis.yml +3 -2
- data/Guardfile +22 -0
- data/README.adoc +1151 -0
- data/Rakefile +1 -1
- data/asciidoctor-rfc.gemspec +20 -3
- data/bin/asciidoctor-rfc2 +15 -0
- data/bin/asciidoctor-rfc3 +15 -0
- data/bin/rspec +0 -1
- data/lib/asciidoctor-rfc.rb +4 -0
- data/lib/asciidoctor/rfc/common/base.rb +218 -0
- data/lib/asciidoctor/rfc/common/front.rb +120 -0
- data/lib/asciidoctor/rfc/v2/base.rb +341 -0
- data/lib/asciidoctor/rfc/v2/blocks.rb +192 -0
- data/lib/asciidoctor/rfc/v2/converter.rb +64 -0
- data/lib/asciidoctor/rfc/v2/front.rb +69 -0
- data/lib/asciidoctor/rfc/v2/inline_anchor.rb +102 -0
- data/lib/asciidoctor/rfc/v2/lists.rb +134 -0
- data/lib/asciidoctor/rfc/v2/table.rb +112 -0
- data/lib/asciidoctor/rfc/v2/validate.rb +738 -0
- data/lib/asciidoctor/rfc/v2/validate2.rng +716 -0
- data/lib/asciidoctor/rfc/v3/base.rb +358 -0
- data/lib/asciidoctor/rfc/v3/blocks.rb +203 -0
- data/lib/asciidoctor/rfc/v3/converter.rb +64 -0
- data/lib/asciidoctor/rfc/v3/front.rb +115 -0
- data/lib/asciidoctor/rfc/v3/inline_anchor.rb +90 -0
- data/lib/asciidoctor/rfc/v3/lists.rb +190 -0
- data/lib/asciidoctor/rfc/v3/svg.rng +9081 -0
- data/lib/asciidoctor/rfc/v3/table.rb +65 -0
- data/lib/asciidoctor/rfc/v3/validate.rb +2168 -0
- data/lib/asciidoctor/rfc/v3/validate.rng +2143 -0
- data/lib/asciidoctor/rfc/version.rb +2 -2
- data/spec/asciidoctor/rfc/v2/appendix_spec.rb +124 -0
- data/spec/asciidoctor/rfc/v2/area_spec.rb +60 -0
- data/spec/asciidoctor/rfc/v2/author_spec.rb +444 -0
- data/spec/asciidoctor/rfc/v2/comments_spec.rb +316 -0
- data/spec/asciidoctor/rfc/v2/crossref_spec.rb +205 -0
- data/spec/asciidoctor/rfc/v2/date_spec.rb +166 -0
- data/spec/asciidoctor/rfc/v2/dlist_spec.rb +108 -0
- data/spec/asciidoctor/rfc/v2/document_spec.rb +161 -0
- data/spec/asciidoctor/rfc/v2/example_spec.rb +50 -0
- data/spec/asciidoctor/rfc/v2/front_spec.rb +75 -0
- data/spec/asciidoctor/rfc/v2/image_spec.rb +81 -0
- data/spec/asciidoctor/rfc/v2/indexterm_spec.rb +66 -0
- data/spec/asciidoctor/rfc/v2/inline_formatting_spec.rb +177 -0
- data/spec/asciidoctor/rfc/v2/keyword_spec.rb +63 -0
- data/spec/asciidoctor/rfc/v2/listing_spec.rb +59 -0
- data/spec/asciidoctor/rfc/v2/literal_spec.rb +53 -0
- data/spec/asciidoctor/rfc/v2/olist_spec.rb +147 -0
- data/spec/asciidoctor/rfc/v2/paragraph_spec.rb +68 -0
- data/spec/asciidoctor/rfc/v2/preamble_spec.rb +140 -0
- data/spec/asciidoctor/rfc/v2/quote_spec.rb +24 -0
- data/spec/asciidoctor/rfc/v2/references_spec.rb +96 -0
- data/spec/asciidoctor/rfc/v2/section_spec.rb +260 -0
- data/spec/asciidoctor/rfc/v2/sidebar_spec.rb +32 -0
- data/spec/asciidoctor/rfc/v2/table_spec.rb +293 -0
- data/spec/asciidoctor/rfc/v2/ulist_spec.rb +96 -0
- data/spec/asciidoctor/rfc/v2/workgroup_spec.rb +60 -0
- data/spec/asciidoctor/rfc/v3/appendix_spec.rb +130 -0
- data/spec/asciidoctor/rfc/v3/area_spec.rb +63 -0
- data/spec/asciidoctor/rfc/v3/author_spec.rb +540 -0
- data/spec/asciidoctor/rfc/v3/comments_spec.rb +308 -0
- data/spec/asciidoctor/rfc/v3/crossref_spec.rb +269 -0
- data/spec/asciidoctor/rfc/v3/date_spec.rb +149 -0
- data/spec/asciidoctor/rfc/v3/dlist_spec.rb +121 -0
- data/spec/asciidoctor/rfc/v3/document_spec.rb +109 -0
- data/spec/asciidoctor/rfc/v3/example_spec.rb +34 -0
- data/spec/asciidoctor/rfc/v3/front_spec.rb +43 -0
- data/spec/asciidoctor/rfc/v3/image_spec.rb +81 -0
- data/spec/asciidoctor/rfc/v3/indexterm_spec.rb +69 -0
- data/spec/asciidoctor/rfc/v3/inline_formatting_spec.rb +319 -0
- data/spec/asciidoctor/rfc/v3/keyword_spec.rb +33 -0
- data/spec/asciidoctor/rfc/v3/link_spec.rb +34 -0
- data/spec/asciidoctor/rfc/v3/listing_spec.rb +59 -0
- data/spec/asciidoctor/rfc/v3/literal_spec.rb +51 -0
- data/spec/asciidoctor/rfc/v3/olist_spec.rb +168 -0
- data/spec/asciidoctor/rfc/v3/paragraph_spec.rb +73 -0
- data/spec/asciidoctor/rfc/v3/preamble_spec.rb +112 -0
- data/spec/asciidoctor/rfc/v3/quote_spec.rb +91 -0
- data/spec/asciidoctor/rfc/v3/references_spec.rb +147 -0
- data/spec/asciidoctor/rfc/v3/section_spec.rb +198 -0
- data/spec/asciidoctor/rfc/v3/series_info_spec.rb +151 -0
- data/spec/asciidoctor/rfc/v3/sidebar_spec.rb +30 -0
- data/spec/asciidoctor/rfc/v3/table_spec.rb +275 -0
- data/spec/asciidoctor/rfc/v3/ulist_spec.rb +74 -0
- data/spec/asciidoctor/rfc/v3/workgroup_spec.rb +33 -0
- data/spec/examples/davies-template-bare-06.adoc +361 -0
- data/spec/examples/davies-template-bare-06.xml.orig +426 -0
- data/spec/examples/example-v2.adoc +181 -0
- data/spec/examples/example-v2.xml +675 -0
- data/spec/examples/example-v3.adoc +185 -0
- data/spec/examples/example-v3.xml +1009 -0
- data/spec/examples/mib-doc-template-xml-06.adoc +596 -0
- data/spec/examples/mib-doc-template-xml-06.xml.orig +654 -0
- data/spec/examples/rfc1149.md +76 -0
- data/spec/examples/rfc1149.md.2.xml +94 -0
- data/spec/examples/rfc1149.md.3.xml +93 -0
- data/spec/examples/rfc1149.md.adoc +65 -0
- data/spec/examples/rfc2100.md +149 -0
- data/spec/examples/rfc2100.md.2.xml +169 -0
- data/spec/examples/rfc2100.md.3.xml +163 -0
- data/spec/examples/rfc2100.md.adoc +136 -0
- data/spec/examples/rfc3514.md +203 -0
- data/spec/examples/rfc3514.md.2.xml +238 -0
- data/spec/examples/rfc3514.md.3.xml +258 -0
- data/spec/examples/rfc3514.md.adoc +324 -0
- data/spec/examples/rfc5841.md +342 -0
- data/spec/examples/rfc5841.md.2.xml +393 -0
- data/spec/examples/rfc5841.md.3.xml +449 -0
- data/spec/examples/rfc5841.md.adoc +414 -0
- data/spec/examples/rfc6350.adoc +3499 -0
- data/spec/examples/rfc6350.bib +763 -0
- data/spec/examples/rfc748.md +79 -0
- data/spec/examples/rfc748.md.2.xml +116 -0
- data/spec/examples/rfc748.md.3.xml +109 -0
- data/spec/examples/rfc748.md.adoc +80 -0
- data/spec/examples/rfc7511.md +257 -0
- data/spec/examples/rfc7511.md.2.xml +300 -0
- data/spec/examples/rfc7511.md.3.xml +347 -0
- data/spec/examples/rfc7511.md.adoc +417 -0
- data/spec/spec_helper.rb +115 -5
- metadata +274 -9
- data/.hound.yml +0 -3
- data/README.md +0 -84
- data/lib/asciidoctor/rfc.rb +0 -7
- data/spec/asciidoctor-rfc/.keep +0 -0
@@ -0,0 +1,414 @@
|
|
1
|
+
= TCP Option to Denote Packet Mood
|
2
|
+
Richard Hay <rhay@google.com>; Warren Turkal <turkal@google.com>
|
3
|
+
:doctype: internet-draft
|
4
|
+
:abbrev: TCP Option to Denote Packet Mood
|
5
|
+
:status: info
|
6
|
+
:name: rfc-5841
|
7
|
+
:ipr: trust200902
|
8
|
+
:area: Internet
|
9
|
+
:workgroup: Network Working Group
|
10
|
+
:revdate: 2010-04-01T00:00:00Z
|
11
|
+
:forename_initials: R.
|
12
|
+
:organization: Google
|
13
|
+
:street: 1600 Amphitheatre Pkwy
|
14
|
+
:city: Mountain View
|
15
|
+
:code: CA 94043
|
16
|
+
:toc-include: false
|
17
|
+
:forename_initials_2: W.
|
18
|
+
:organization_2: Google
|
19
|
+
:street_2: 1600 Amphitheatre Pkwy
|
20
|
+
:city_2: Mountain View
|
21
|
+
:code_2: CA 94043
|
22
|
+
|
23
|
+
[abstract]
|
24
|
+
This document proposes a new TCP option to denote packet mood.
|
25
|
+
|
26
|
+
== Introduction
|
27
|
+
|
28
|
+
In an attempt to anthropomorphize the bit streams on countless
|
29
|
+
physical layer networks throughout the world, we propose a TCP option
|
30
|
+
to express packet mood <<DSM-IV>>.
|
31
|
+
|
32
|
+
Packets cannot feel. They are created for the purpose of moving data
|
33
|
+
from one system to another. However, it is clear that in specific
|
34
|
+
situations some measure of emotion can be inferred or added. For
|
35
|
+
instance, a packet that is retransmitted to resend data for a packet
|
36
|
+
for which no ACK was received could be described as an 'angry'
|
37
|
+
packet, or a 'frustrated' packet (if it is not the first
|
38
|
+
retransmission for instance). So how can these kinds of feelings be
|
39
|
+
conveyed in the packets themselves. This can be addressed by adding
|
40
|
+
TCP Options <<RFC0793>> to the TCP header, using ASCII characters that
|
41
|
+
encode commonly used "emoticons" to convey packet mood.
|
42
|
+
|
43
|
+
=== Terminology
|
44
|
+
|
45
|
+
The keywords **MUST**, **MUST NOT**, **REQUIRED**, **SHALL**, **SHALL NOT**, **SHOULD**,
|
46
|
+
**SHOULD NOT**, **RECOMMENDED**, **MAY**, and **OPTIONAL**, when they appear in this
|
47
|
+
document, are to be interpreted as described in <<RFC2119>>.
|
48
|
+
|
49
|
+
== Syntax
|
50
|
+
|
51
|
+
A TCP Option has a 1-byte kind field, followed by a 1-byte length
|
52
|
+
field <<RFC0793>>. It is proposed that option 25 (released 2000-12-18)
|
53
|
+
be used to define packet mood. This option would have a length value
|
54
|
+
of 4 or 5 bytes. All the simple emotions described as expressible
|
55
|
+
via this mechanism can be displayed with two or three 7-bit, ASCII-
|
56
|
+
encoded characters. Multiple mood options may appear in a TCP
|
57
|
+
header, so as to express more complex moods than those defined here
|
58
|
+
(for instance if a packet were happy and surprised).
|
59
|
+
|
60
|
+
.TCP Header Format
|
61
|
+
====
|
62
|
+
[align=center]
|
63
|
+
....
|
64
|
+
Kind Length Meaning
|
65
|
+
---- -------- -------
|
66
|
+
25 Variable Packet Mood
|
67
|
+
....
|
68
|
+
====
|
69
|
+
|
70
|
+
In more detail:
|
71
|
+
|
72
|
+
[align=left]
|
73
|
+
....
|
74
|
+
+--------+--------+--------+--------+
|
75
|
+
|00011001|00000100|00111010|00101001|
|
76
|
+
+--------+--------+--------+--------+
|
77
|
+
Kind=25 Length=4 ASCII : ASCII )
|
78
|
+
|
79
|
+
+--------+--------+--------+--------+--------+
|
80
|
+
|00011001|00000101|00111110|00111010|01000000|
|
81
|
+
+--------+--------+--------+--------+--------+
|
82
|
+
Kind=25 Length=5 ASCII > ACSII : ASCII @
|
83
|
+
....
|
84
|
+
|
85
|
+
[[simple-emotional-representation]]
|
86
|
+
== Simple Emotional Representation
|
87
|
+
|
88
|
+
It is proposed that common emoticons be used to denote packet mood.
|
89
|
+
Packets do not "feel" per se. The emotions they could be tagged with
|
90
|
+
are a reflection of the user mood expressed through packets.
|
91
|
+
|
92
|
+
So the humanity expressed in a packet would be entirely sourced from
|
93
|
+
humans.
|
94
|
+
|
95
|
+
To this end, it is proposed that simple emotions be used convey mood
|
96
|
+
as follows.
|
97
|
+
|
98
|
+
....
|
99
|
+
ASCII Mood
|
100
|
+
===== ====
|
101
|
+
:) Happy
|
102
|
+
:( Sad
|
103
|
+
:D Amused
|
104
|
+
%( Confused
|
105
|
+
:o Bored
|
106
|
+
:O Surprised
|
107
|
+
:P Silly
|
108
|
+
:@ Frustrated
|
109
|
+
>:@ Angry
|
110
|
+
:| Apathetic
|
111
|
+
;) Sneaky
|
112
|
+
>:) Evil
|
113
|
+
....
|
114
|
+
|
115
|
+
Proposed ASCII character encoding
|
116
|
+
|
117
|
+
....
|
118
|
+
Binary Dec Hex Character
|
119
|
+
======== === === =========
|
120
|
+
010 0101 37 25 %
|
121
|
+
010 1000 40 28 (
|
122
|
+
010 1001 41 29 )
|
123
|
+
011 1010 58 3A :
|
124
|
+
011 1011 59 3B ;
|
125
|
+
011 1110 62 3E >
|
126
|
+
100 0000 64 40 @
|
127
|
+
100 0100 68 44 D
|
128
|
+
100 1111 79 4F O
|
129
|
+
101 0000 80 50 P
|
130
|
+
110 1111 111 6F o
|
131
|
+
111 1100 124 7C |
|
132
|
+
....
|
133
|
+
|
134
|
+
For the purposes of this RFC, 7-bit ASCII encoding is sufficient for
|
135
|
+
representing emoticons. The ASCII characters will be sent in 8-bit
|
136
|
+
bytes with the leading bit always set to 0.
|
137
|
+
|
138
|
+
== Use Cases
|
139
|
+
|
140
|
+
There are two ways to denote packet mood. One is to infer the mood
|
141
|
+
based on an event in the TCP session. The other is to derive mood
|
142
|
+
from a higher-order action at a higher layer (subject matter of
|
143
|
+
payload for instance).
|
144
|
+
|
145
|
+
For packets where the 'mood' is inferred from activity within the TCP
|
146
|
+
session, the 'mood' **MUST** be set by the host that is watching for the
|
147
|
+
trigger event. If a client sends a frame and receives no ACK, then
|
148
|
+
the retransmitted frame **MAY** contain the TCP OPTION header with a mood
|
149
|
+
set.
|
150
|
+
|
151
|
+
Any packet that exhibits behavior that allows for mood to be inferred
|
152
|
+
**SHOULD** add the TCP OPTION to the packets with the implied mood.
|
153
|
+
|
154
|
+
Applications can take advantage of the defined moods by expressing
|
155
|
+
them in the packets. This can be done in the SYN packet sent from
|
156
|
+
the client. All packets in the session can be then tagged with the
|
157
|
+
mood set in the SYN packet, but this would have a per-packet
|
158
|
+
performance cost (see <<performance-considerations,Performance Considerations>>).
|
159
|
+
|
160
|
+
Each application **MUST** define the preconditions for marking packets as
|
161
|
+
happy, sad, bored, confused, angry, apathetic, and so on. This is a
|
162
|
+
framework for defining how such moods can be expressed, but it is up
|
163
|
+
to the developers to determine when to apply these encoded labels.
|
164
|
+
|
165
|
+
=== Happy Packets
|
166
|
+
|
167
|
+
Healthy packets are happy packets you could say. If the ACK packets
|
168
|
+
return within <10 ms end-to-end from a sender's stack to a receiver's
|
169
|
+
stack and back again, this would reflect high-speed bidirectional
|
170
|
+
capability, and if no retransmits are required and all ACKs are
|
171
|
+
received, all subsequent packets in that session **SHOULD** be marked as
|
172
|
+
'happy'.
|
173
|
+
|
174
|
+
No loss, low-latency packets also makes for happy users. So the
|
175
|
+
packet would be reflecting the end-user experience.
|
176
|
+
|
177
|
+
=== Sad Packets
|
178
|
+
|
179
|
+
If retransmission rates achieve greater than 20% of all packets sent
|
180
|
+
in a session, it is fair to say the session can be in mourning for
|
181
|
+
all of the good packets lost in the senseless wasteland of the wild
|
182
|
+
Internet.
|
183
|
+
|
184
|
+
This should not be confused with retransmitted packets marked as
|
185
|
+
'angry' since this tag would apply to all frames in the session
|
186
|
+
numbed by the staggering loss of packet life.
|
187
|
+
|
188
|
+
=== Amused Packets
|
189
|
+
|
190
|
+
Any packet that is carrying a text joke **SHOULD** be marked as 'amused'.
|
191
|
+
|
192
|
+
Example:
|
193
|
+
|
194
|
+
....
|
195
|
+
1: Knock Knock
|
196
|
+
2: Who's there?
|
197
|
+
1: Impatient chicken
|
198
|
+
2: Impatient chi...
|
199
|
+
1: BAWK!!!!
|
200
|
+
....
|
201
|
+
|
202
|
+
If such a joke is in the packet payload then, honestly, how can you
|
203
|
+
not be amused by one of the only knock-knock jokes that survives the
|
204
|
+
3rd grade?
|
205
|
+
|
206
|
+
=== Confused Packets
|
207
|
+
|
208
|
+
When is a packet confused? There are network elements that perform
|
209
|
+
per-packet load balancing, and if there are asymmetries in the
|
210
|
+
latencies between end-to-end paths, out-of-order packet delivery can
|
211
|
+
occur.
|
212
|
+
|
213
|
+
When a receiver host gets out-of-order packets, it **SHOULD** mark TCP
|
214
|
+
ACK packets sent back to the sender as confused.
|
215
|
+
|
216
|
+
The same can be said for packets that are sent to incorrect VLAN
|
217
|
+
segments or are misdirected. The receivers might be aware that the
|
218
|
+
packet is confused, but there is no way to know at ingress if that
|
219
|
+
will be the fate of the frame.
|
220
|
+
|
221
|
+
That being said, application developers **SHOULD** mark packets as
|
222
|
+
confused if the payload contains complex philosophical questions that
|
223
|
+
make one ponder the meaning of life and one's place in the universe.
|
224
|
+
|
225
|
+
=== Bored Packets
|
226
|
+
|
227
|
+
Packets carrying accounting data with debits, credits, and so on **MUST**
|
228
|
+
be marked as 'bored'.
|
229
|
+
|
230
|
+
It could be said that many people consider RFCs boring. Packets
|
231
|
+
containing RFC text **MAY** be marked as 'bored'.
|
232
|
+
|
233
|
+
Packets with phone book listings **MUST** be marked 'bored'.
|
234
|
+
|
235
|
+
Packets containing legal disclaimers and anything in Latin **SHOULD** be
|
236
|
+
marked 'bored'.
|
237
|
+
|
238
|
+
=== Surprised Packets
|
239
|
+
|
240
|
+
Who doesn't love when the out-of-order packets in your session
|
241
|
+
surprise you while waiting in a congested queue for 20 ms?
|
242
|
+
|
243
|
+
Packets do not have birthdays, so packets can be marked as surprised
|
244
|
+
when they encounter unexpected error conditions.
|
245
|
+
|
246
|
+
So when ICMP destination unreachable messages are received (perhaps
|
247
|
+
due to a routing loop or congestion discards), all subsequent packets
|
248
|
+
in that session **SHOULD** be marked as surprised.
|
249
|
+
|
250
|
+
=== Silly Packets
|
251
|
+
|
252
|
+
Not all packets are sent as part of a session. Random keepalives
|
253
|
+
during a TCP session **MAY** be set up as a repartee between systems
|
254
|
+
connected as client and server. Such random and even playful
|
255
|
+
interchanges **SHOULD** be marked as silly.
|
256
|
+
|
257
|
+
=== Frustrated Packets
|
258
|
+
|
259
|
+
Packets that are retransmitted more than once **SHOULD** be marked as
|
260
|
+
frustrated.
|
261
|
+
|
262
|
+
=== Angry Packets
|
263
|
+
|
264
|
+
Packets that are retransmitted **SHOULD** be marked as angry.
|
265
|
+
|
266
|
+
=== Apathetic Packets
|
267
|
+
|
268
|
+
When sending a RST packet to a connected system, the packet should be
|
269
|
+
marked as apathetic so that the receiver knows that your system does
|
270
|
+
not care what happens after that.
|
271
|
+
|
272
|
+
=== Sneaky Packets
|
273
|
+
|
274
|
+
When a packet is used in a particularly clever way, it **SHOULD** be
|
275
|
+
marked as sneaky. What is "clever" is rather subjective, so it would
|
276
|
+
be prudent to get a few opinions about a particular use to make sure
|
277
|
+
that it is clever.
|
278
|
+
|
279
|
+
=== Evil Packets
|
280
|
+
|
281
|
+
It is hard for a TCP packet to discern higher moral quandaries like
|
282
|
+
the meaning of life or what exactly defines 'evil' and from whose
|
283
|
+
perspective such a characterization is being made. However,
|
284
|
+
developers of TCP-based applications **MAY** choose to see some
|
285
|
+
activities as evil when viewed through their particular lens of the
|
286
|
+
world. At that point, they **SHOULD** mark packets as evil.
|
287
|
+
|
288
|
+
Some organizations are prohibited from using this mood by mission
|
289
|
+
statement. This would also prohibit using the security flag in the
|
290
|
+
IP header described in <<RFC3514>> for the same reasons.
|
291
|
+
|
292
|
+
[[performance-considerations]]
|
293
|
+
== Performance Considerations
|
294
|
+
|
295
|
+
Adding extensions to the TCP header has a cost. Using TCP extensions
|
296
|
+
with the ASCII-encoded mood of the packet would detract from the
|
297
|
+
available MSS usable for data payload. If the TCP header is more
|
298
|
+
than 20 bytes, then the extra bytes would be unavailable for use in
|
299
|
+
the payload of the frame.
|
300
|
+
|
301
|
+
This added per-packet overhead should be considered when using packet
|
302
|
+
mood extensions.
|
303
|
+
|
304
|
+
== Security Considerations
|
305
|
+
|
306
|
+
The TCP checksum, as a 16-bit value, could be mistaken if ASCII
|
307
|
+
characters with the same number of zeros and ones were substituted
|
308
|
+
out. A happy `:)` could be replaced with a frown by a malicious
|
309
|
+
attacker, by using a winking eye `;(`. This could misrepresent the
|
310
|
+
intended mood of the sender to the receiver.
|
311
|
+
|
312
|
+
== Related Work
|
313
|
+
|
314
|
+
This document does not seek to build a sentient network stack.
|
315
|
+
However, this framework could be used to express the emotions of a
|
316
|
+
sentient stack. If that were to happen, a new technical job class of
|
317
|
+
network psychologists could be created. Who doesn't like new jobs? :)
|
318
|
+
|
319
|
+
== IANA Considerations
|
320
|
+
|
321
|
+
If this work is standardized, IANA is requested to officially assign
|
322
|
+
value 25 as described in <<simple-emotional-representation>>. Additional moods and emoticon
|
323
|
+
representations would require IESG approval or standards action <<RFC5226>>.
|
324
|
+
|
325
|
+
[bibliography]
|
326
|
+
== Informative References
|
327
|
+
++++
|
328
|
+
|
329
|
+
<reference anchor="RFC0793" target="https://www.rfc-editor.org/info/rfc793">
|
330
|
+
<front>
|
331
|
+
<title>Transmission Control Protocol</title>
|
332
|
+
<author initials="J." surname="Postel" fullname="J. Postel">
|
333
|
+
<organization/>
|
334
|
+
</author>
|
335
|
+
<date year="1981" month="September"/>
|
336
|
+
</front>
|
337
|
+
<seriesInfo name="STD" value="7"/>
|
338
|
+
<seriesInfo name="RFC" value="793"/>
|
339
|
+
<seriesInfo name="DOI" value="10.17487/RFC0793"/>
|
340
|
+
</reference>
|
341
|
+
|
342
|
+
<reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119">
|
343
|
+
<front>
|
344
|
+
<title>
|
345
|
+
Key words for use in RFCs to Indicate Requirement Levels
|
346
|
+
</title>
|
347
|
+
<author initials="S." surname="Bradner" fullname="S. Bradner">
|
348
|
+
<organization/>
|
349
|
+
</author>
|
350
|
+
<date year="1997" month="March"/>
|
351
|
+
<abstract>
|
352
|
+
<t>
|
353
|
+
In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.
|
354
|
+
</t>
|
355
|
+
</abstract>
|
356
|
+
</front>
|
357
|
+
<seriesInfo name="BCP" value="14"/>
|
358
|
+
<seriesInfo name="RFC" value="2119"/>
|
359
|
+
<seriesInfo name="DOI" value="10.17487/RFC2119"/>
|
360
|
+
</reference>
|
361
|
+
|
362
|
+
<reference anchor="RFC3514" target="https://www.rfc-editor.org/info/rfc3514">
|
363
|
+
<front>
|
364
|
+
<title>The Security Flag in the IPv4 Header</title>
|
365
|
+
<author initials="S." surname="Bellovin" fullname="S. Bellovin">
|
366
|
+
<organization/>
|
367
|
+
</author>
|
368
|
+
<date year="2003" month="April"/>
|
369
|
+
<abstract>
|
370
|
+
<t>
|
371
|
+
Firewalls, packet filters, intrusion detection systems, and the like often have difficulty distinguishing between packets that have malicious intent and those that are merely unusual. We define a security flag in the IPv4 header as a means of distinguishing the two cases. This memo provides information for the Internet community.
|
372
|
+
</t>
|
373
|
+
</abstract>
|
374
|
+
</front>
|
375
|
+
<seriesInfo name="RFC" value="3514"/>
|
376
|
+
<seriesInfo name="DOI" value="10.17487/RFC3514"/>
|
377
|
+
</reference>
|
378
|
+
|
379
|
+
<reference anchor="RFC5226" target="https://www.rfc-editor.org/info/rfc5226">
|
380
|
+
<front>
|
381
|
+
<title>
|
382
|
+
Guidelines for Writing an IANA Considerations Section in RFCs
|
383
|
+
</title>
|
384
|
+
<author initials="T." surname="Narten" fullname="T. Narten">
|
385
|
+
<organization/>
|
386
|
+
</author>
|
387
|
+
<author initials="H." surname="Alvestrand" fullname="H. Alvestrand">
|
388
|
+
<organization/>
|
389
|
+
</author>
|
390
|
+
<date year="2008" month="May"/>
|
391
|
+
<abstract>
|
392
|
+
<t>
|
393
|
+
Many protocols make use of identifiers consisting of constants and other well-known values. Even after a protocol has been defined and deployment has begun, new values may need to be assigned (e.g., for a new option type in DHCP, or a new encryption or authentication transform for IPsec). To ensure that such quantities have consistent values and interpretations across all implementations, their assignment must be administered by a central authority. For IETF protocols, that role is provided by the Internet Assigned Numbers Authority (IANA).
|
394
|
+
</t>
|
395
|
+
<t>
|
396
|
+
In order for IANA to manage a given namespace prudently, it needs guidelines describing the conditions under which new values can be assigned or when modifications to existing values can be made. If IANA is expected to play a role in the management of a namespace, IANA must be given clear and concise instructions describing that role. This document discusses issues that should be considered in formulating a policy for assigning values to a namespace and provides guidelines for authors on the specific text that must be included in documents that place demands on IANA.
|
397
|
+
</t>
|
398
|
+
<t>
|
399
|
+
This document obsoletes RFC 2434. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.
|
400
|
+
</t>
|
401
|
+
</abstract>
|
402
|
+
</front>
|
403
|
+
<seriesInfo name="RFC" value="5226"/>
|
404
|
+
<seriesInfo name="DOI" value="10.17487/RFC5226"/>
|
405
|
+
</reference>
|
406
|
+
|
407
|
+
<reference anchor='DSM-IV' target='http://www.psychiatryonline.com/resourceTOC.aspx?resourceID=1'>
|
408
|
+
<front>
|
409
|
+
<title>Diagnostic and Statistical Manual of Mental Disorders (DSM)</title>
|
410
|
+
<author></author>
|
411
|
+
<date></date>
|
412
|
+
</front>
|
413
|
+
</reference>
|
414
|
+
++++
|
@@ -0,0 +1,3499 @@
|
|
1
|
+
= vCard Format Specification
|
2
|
+
Simon Perreault <simon.perreault@viagenie.ca>
|
3
|
+
:bibliography-database: rfc6350.bib
|
4
|
+
:bibliography-style: apa
|
5
|
+
:doctype: rfc
|
6
|
+
:obsoletes: 2425, 2426, 4770
|
7
|
+
:updates: 2739
|
8
|
+
:name: rfc-6350
|
9
|
+
:revdate: 20110831
|
10
|
+
:submission-type: IETF
|
11
|
+
:status: full-standard
|
12
|
+
:intended-series: full-standard 6350
|
13
|
+
:fullname: Simon Perreault
|
14
|
+
:lastname: Perreault
|
15
|
+
:organization: Viagenie
|
16
|
+
:email: simon.perreault@viagenie.ca
|
17
|
+
:street: 2875 Laurier, suite D2-630
|
18
|
+
:region: Quebec, QC
|
19
|
+
:code: G1V 2M2
|
20
|
+
:country: Canada
|
21
|
+
:phone: +1 418 656 9254
|
22
|
+
:uri: http://www.viagenie.ca
|
23
|
+
:link: urn:issn:2070-1721 item
|
24
|
+
|
25
|
+
|
26
|
+
This document defines the vCard data format for representing and
|
27
|
+
exchanging a variety of information about individuals and other
|
28
|
+
entities (e.g., formatted and structured name and delivery addresses,
|
29
|
+
email address, multiple telephone numbers, photograph, logo, audio
|
30
|
+
clips, etc.). This document obsoletes RFCs 2425, 2426, and 4770, and
|
31
|
+
updates RFC 2739.
|
32
|
+
|
33
|
+
[[section1]]
|
34
|
+
== Introduction
|
35
|
+
|
36
|
+
Electronic address books have become ubiquitous. Their increased
|
37
|
+
presence on portable, connected devices as well as the diversity of
|
38
|
+
platforms that exchange contact data call for a standard. This memo
|
39
|
+
defines the vCard format, which allows the capture and exchange of
|
40
|
+
information normally stored within an address book or directory
|
41
|
+
application.
|
42
|
+
|
43
|
+
A high-level overview of the differences from RFCs 2425 and 2426 can
|
44
|
+
be found in <<appendixA,Appendix A>>.
|
45
|
+
|
46
|
+
[[section2]]
|
47
|
+
== Conventions
|
48
|
+
|
49
|
+
The key words "[bcp14]#MUST#", "[bcp14]#MUST NOT#", "[bcp14]#REQUIRED#", "[bcp14]#SHALL#", "[bcp14]#SHALL NOT#",
|
50
|
+
"[bcp14]#SHOULD#", "[bcp14]#SHOULD NOT#", "[bcp14]#RECOMMENDED#", "[bcp14]#NOT RECOMMENDED#", "[bcp14]#MAY#", and
|
51
|
+
"[bcp14]#OPTIONAL#" in this document are to be interpreted as described in
|
52
|
+
cite:[RFC2119].
|
53
|
+
|
54
|
+
[[section3]]
|
55
|
+
== vCard Format Specification
|
56
|
+
|
57
|
+
The text/vcard MIME content type (hereafter known as "vCard"; see
|
58
|
+
<<section10_1,Section 10.1>>) contains contact information, typically pertaining to a
|
59
|
+
single contact or group of contacts. The content consists of one or
|
60
|
+
more lines in the format given below.
|
61
|
+
|
62
|
+
[[section3_1]]
|
63
|
+
=== Charset
|
64
|
+
|
65
|
+
The charset (see cite:[RFC3536] for internationalization terminology) for
|
66
|
+
vCard is UTF-8 as defined in cite:[RFC3629]. There is no way to override
|
67
|
+
this. It is invalid to specify a value other than "UTF-8" in the
|
68
|
+
"charset" MIME parameter (see <<section10_1,Section 10.1>>).
|
69
|
+
|
70
|
+
[[section3_2]]
|
71
|
+
=== Line Delimiting and Folding
|
72
|
+
|
73
|
+
Individual lines within vCard are delimited by the cite:[RFC5322] line
|
74
|
+
break, which is a `CRLF` sequence (`U+000D` followed by `U+000A`). Long
|
75
|
+
logical lines of text can be split into a multiple-physical-line
|
76
|
+
representation using the following folding technique. Content lines
|
77
|
+
[bcp14]#SHOULD# be folded to a maximum width of 75 octets, excluding the line
|
78
|
+
break. Multi-octet characters [bcp14]#MUST# remain contiguous. The rationale
|
79
|
+
for this folding process can be found in <<RFC5322,2.1.1 comma>>.
|
80
|
+
|
81
|
+
A logical line [bcp14]#MAY# be continued on the next physical line anywhere
|
82
|
+
between two characters by inserting a `CRLF` immediately followed by a
|
83
|
+
single white space character (space (`U+0020`) or horizontal tab
|
84
|
+
(`U+0009`)). The folded line [bcp14]#MUST# contain at least one character. Any
|
85
|
+
sequence of `CRLF` followed immediately by a single white space
|
86
|
+
character is ignored (removed) when processing the content type. For
|
87
|
+
example, the line:
|
88
|
+
|
89
|
+
....
|
90
|
+
NOTE:This is a long description that exists on a long line.
|
91
|
+
....
|
92
|
+
|
93
|
+
can be represented as:
|
94
|
+
|
95
|
+
....
|
96
|
+
NOTE:This is a long description
|
97
|
+
that exists on a long line.
|
98
|
+
....
|
99
|
+
|
100
|
+
It could also be represented as:
|
101
|
+
|
102
|
+
....
|
103
|
+
NOTE:This is a long descrip
|
104
|
+
tion that exists o
|
105
|
+
n a long line.
|
106
|
+
....
|
107
|
+
|
108
|
+
The process of moving from this folded multiple-line representation
|
109
|
+
of a property definition to its single-line representation is called
|
110
|
+
unfolding. Unfolding is accomplished by regarding `CRLF` immediately
|
111
|
+
followed by a white space character (namely, `HTAB` (U+0009) or `SPACE`
|
112
|
+
(`U+0020`)) as equivalent to no characters at all (i.e., the `CRLF` and
|
113
|
+
single white space character are removed).
|
114
|
+
|
115
|
+
NOTE: It is possible for very simple implementations to generate
|
116
|
+
improperly folded lines in the middle of a UTF-8 multi-octet
|
117
|
+
sequence. For this reason, implementations [bcp14]#SHOULD# unfold lines in
|
118
|
+
such a way as to properly restore the original sequence.
|
119
|
+
|
120
|
+
NOTE: Unfolding is done differently than in cite:[RFC5322]. Unfolding
|
121
|
+
in cite:[RFC5322] only removes the `CRLF`, not the space following it.
|
122
|
+
|
123
|
+
Folding is done after any content encoding of a type value.
|
124
|
+
Unfolding is done before any decoding of a type value in a content
|
125
|
+
line.
|
126
|
+
|
127
|
+
[[section3_3]]
|
128
|
+
=== ABNF Format Definition
|
129
|
+
|
130
|
+
The following ABNF uses the notation of cite:[RFC5234], which also defines
|
131
|
+
`CRLF`, `WSP`, `DQUOTE`, `VCHAR`, `ALPHA`, and `DIGIT`.
|
132
|
+
|
133
|
+
[source,abnf]
|
134
|
+
----
|
135
|
+
vcard-entity = 1*vcard
|
136
|
+
|
137
|
+
vcard = "BEGIN:VCARD" CRLF
|
138
|
+
"VERSION:4.0" CRLF
|
139
|
+
1*contentline
|
140
|
+
"END:VCARD" CRLF
|
141
|
+
; A vCard object MUST include the VERSION and FN properties.
|
142
|
+
; VERSION MUST come immediately after BEGIN:VCARD.
|
143
|
+
|
144
|
+
contentline = [group "."] name *(";" param) ":" value CRLF
|
145
|
+
; When parsing a content line, folded lines must first
|
146
|
+
; be unfolded according to the unfolding procedure
|
147
|
+
; described in Section 3.2.
|
148
|
+
; When generating a content line, lines longer than 75
|
149
|
+
; characters SHOULD be folded according to the folding
|
150
|
+
; procedure described in Section 3.2.
|
151
|
+
|
152
|
+
group = 1*(ALPHA / DIGIT / "-")
|
153
|
+
name = "SOURCE" / "KIND" / "FN" / "N" / "NICKNAME"
|
154
|
+
/ "PHOTO" / "BDAY" / "ANNIVERSARY" / "GENDER" / "ADR" / "TEL"
|
155
|
+
/ "EMAIL" / "IMPP" / "LANG" / "TZ" / "GEO" / "TITLE" / "ROLE"
|
156
|
+
/ "LOGO" / "ORG" / "MEMBER" / "RELATED" / "CATEGORIES"
|
157
|
+
/ "NOTE" / "PRODID" / "REV" / "SOUND" / "UID" / "CLIENTPIDMAP"
|
158
|
+
/ "URL" / "KEY" / "FBURL" / "CALADRURI" / "CALURI" / "XML"
|
159
|
+
/ iana-token / x-name
|
160
|
+
; Parsing of the param and value is based on the "name" as
|
161
|
+
; defined in ABNF sections below.
|
162
|
+
; Group and name are case-insensitive.
|
163
|
+
|
164
|
+
iana-token = 1*(ALPHA / DIGIT / "-")
|
165
|
+
; identifier registered with IANA
|
166
|
+
|
167
|
+
x-name = "x-" 1*(ALPHA / DIGIT / "-")
|
168
|
+
; Names that begin with "x-" or "X-" are
|
169
|
+
; reserved for experimental use, not intended for released
|
170
|
+
; products, or for use in bilateral agreements.
|
171
|
+
|
172
|
+
param = language-param / value-param / pref-param / pid-param
|
173
|
+
/ type-param / geo-parameter / tz-parameter / sort-as-param
|
174
|
+
/ calscale-param / any-param
|
175
|
+
; Allowed parameters depend on property name.
|
176
|
+
|
177
|
+
param-value = *SAFE-CHAR / DQUOTE *QSAFE-CHAR DQUOTE
|
178
|
+
|
179
|
+
any-param = (iana-token / x-name) "=" param-value *("," param-value)
|
180
|
+
|
181
|
+
NON-ASCII = UTF8-2 / UTF8-3 / UTF8-4
|
182
|
+
; UTF8-{2,3,4} are defined in RFC3629
|
183
|
+
|
184
|
+
QSAFE-CHAR = WSP / "!" / %x23-7E / NON-ASCII
|
185
|
+
; Any character except CTLs, DQUOTE
|
186
|
+
|
187
|
+
SAFE-CHAR = WSP / "!" / %x23-39 / %x3C-7E / NON-ASCII
|
188
|
+
; Any character except CTLs, DQUOTE, ";", ":"
|
189
|
+
|
190
|
+
VALUE-CHAR = WSP / VCHAR / NON-ASCII
|
191
|
+
; Any textual character
|
192
|
+
----
|
193
|
+
|
194
|
+
A line that begins with a white space character is a continuation of
|
195
|
+
the previous line, as described in <<section3_2,Section 3.2>>. The white space
|
196
|
+
character and immediately preceeding `CRLF` should be discarded when
|
197
|
+
reconstructing the original line. Note that this line-folding
|
198
|
+
convention differs from that found in cite:[RFC5322], in that the sequence
|
199
|
+
`<CRLF><WSP>` found anywhere in the content indicates a continued line
|
200
|
+
and should be removed.
|
201
|
+
|
202
|
+
Property names and parameter names are case-insensitive (e.g., the
|
203
|
+
property name `"fn"` is the same as `"FN"` and `"Fn"`). Parameter values
|
204
|
+
[bcp14]#MAY# be case-sensitive or case-insensitive, depending on their
|
205
|
+
definition. Parameter values that are not explicitly defined as
|
206
|
+
being case-sensitive are case-insensitive. Based on experience with
|
207
|
+
vCard 3 interoperability, it is [bcp14]#RECOMMENDED# that property and
|
208
|
+
parameter names be upper-case on output.
|
209
|
+
|
210
|
+
The group construct is used to group related properties together.
|
211
|
+
The group name is a syntactic convention used to indicate that all
|
212
|
+
property names prefaced with the same group name [bcp14]#SHOULD# be grouped
|
213
|
+
together when displayed by an application. It has no other
|
214
|
+
significance. Implementations that do not understand or support
|
215
|
+
grouping [bcp14]#MAY# simply strip off any text before a `"."` to the left of
|
216
|
+
the type name and present the types and values as normal.
|
217
|
+
|
218
|
+
Property cardinalities are indicated using the following notation,
|
219
|
+
which is based on ABNF (see <<RFC5234,3.6 comma>>):
|
220
|
+
|
221
|
+
|===
|
222
|
+
| Cardinality | Meaning
|
223
|
+
|
224
|
+
| 1 | Exactly one instance per vCard [bcp14]#MUST# be present.
|
225
|
+
| *1 | Exactly one instance per vCard [bcp14]#MAY# be present. |
|
226
|
+
| 1* | One or more instances per vCard [bcp14]#MUST# be present. |
|
227
|
+
| * | One or more instances per vCard [bcp14]#MAY# be present. |
|
228
|
+
|===
|
229
|
+
|
230
|
+
Properties defined in a vCard instance may have multiple values
|
231
|
+
depending on the property cardinality. The general rule for encoding
|
232
|
+
multi-valued properties is to simply create a new content line for
|
233
|
+
each value (including the property name). However, it should be
|
234
|
+
noted that some value types support encoding multiple values in a
|
235
|
+
single content line by separating the values with a comma `","`. This
|
236
|
+
approach has been taken for several of the content types defined
|
237
|
+
below (date, time, integer, float).
|
238
|
+
|
239
|
+
[[section3_4]]
|
240
|
+
=== Property Value Escaping
|
241
|
+
|
242
|
+
Some properties may contain one or more values delimited by a `COMMA`
|
243
|
+
character (`U+002C`). Therefore, a `COMMA` character in a value [bcp14]#MUST# be
|
244
|
+
escaped with a `BACKSLASH` character (`U+005C`), even for properties that
|
245
|
+
don't allow multiple instances (for consistency).
|
246
|
+
|
247
|
+
Some properties (e.g., `N` and `ADR`) comprise multiple fields delimited
|
248
|
+
by a `SEMICOLON` character (`U+003B`). Therefore, a `SEMICOLON` in a field
|
249
|
+
of such a "compound" property [bcp14]#MUST# be escaped with a `BACKSLASH`
|
250
|
+
character. `SEMICOLON` characters in non-compound properties [bcp14]#MAY# be
|
251
|
+
escaped. On input, an escaped `SEMICOLON` character is never a field
|
252
|
+
separator. An unescaped `SEMICOLON` character may be a field
|
253
|
+
separator, depending on the property in which it appears.
|
254
|
+
|
255
|
+
Furthermore, some fields of compound properties may contain a list of
|
256
|
+
values delimited by a `COMMA` character. Therefore, a `COMMA` character
|
257
|
+
in one of a field's values [bcp14]#MUST# be escaped with a `BACKSLASH`
|
258
|
+
character, even for fields that don't allow multiple values (for
|
259
|
+
consistency). Compound properties allowing multiple instances [bcp14]#MUST NOT#
|
260
|
+
be encoded in a single content line.
|
261
|
+
|
262
|
+
Finally, `BACKSLASH` characters in values [bcp14]#MUST# be escaped with a
|
263
|
+
`BACKSLASH` character. `NEWLINE` (`U+000A`) characters in values [bcp14]#MUST# be
|
264
|
+
encoded by two characters: a `BACKSLASH` followed by either an `'n'`
|
265
|
+
(`U+006E`) or an `'N'` (`U+004E`).
|
266
|
+
|
267
|
+
In all other cases, escaping [bcp14]#MUST NOT# be used.
|
268
|
+
|
269
|
+
[[section4]]
|
270
|
+
== Property Value Data Types
|
271
|
+
|
272
|
+
Standard value types are defined below.
|
273
|
+
|
274
|
+
[source,abnf]
|
275
|
+
----
|
276
|
+
value = text
|
277
|
+
/ text-list
|
278
|
+
/ date-list
|
279
|
+
/ time-list
|
280
|
+
/ date-time-list
|
281
|
+
/ date-and-or-time-list
|
282
|
+
/ timestamp-list
|
283
|
+
/ boolean
|
284
|
+
/ integer-list
|
285
|
+
/ float-list
|
286
|
+
/ URI ; from Section 3 of RFC3986
|
287
|
+
/ utc-offset
|
288
|
+
/ Language-Tag
|
289
|
+
/ iana-valuespec
|
290
|
+
; Actual value type depends on property name and VALUE parameter.
|
291
|
+
|
292
|
+
text = *TEXT-CHAR
|
293
|
+
|
294
|
+
TEXT-CHAR = "\\" / "\," / "\n" / WSP / NON-ASCII
|
295
|
+
/ %x21-2B / %x2D-5B / %x5D-7E
|
296
|
+
; Backslashes, commas, and newlines must be encoded.
|
297
|
+
|
298
|
+
component = "\\" / "\," / "\;" / "\n" / WSP / NON-ASCII
|
299
|
+
/ %x21-2B / %x2D-3A / %x3C-5B / %x5D-7E
|
300
|
+
list-component = component *("," component)
|
301
|
+
|
302
|
+
text-list = text *("," text)
|
303
|
+
date-list = date *("," date)
|
304
|
+
time-list = time *("," time)
|
305
|
+
date-time-list = date-time *("," date-time)
|
306
|
+
date-and-or-time-list = date-and-or-time *("," date-and-or-time)
|
307
|
+
timestamp-list = timestamp *("," timestamp)
|
308
|
+
integer-list = integer *("," integer)
|
309
|
+
float-list = float *("," float)
|
310
|
+
|
311
|
+
boolean = "TRUE" / "FALSE"
|
312
|
+
integer = [sign] 1*DIGIT
|
313
|
+
float = [sign] 1*DIGIT ["." 1*DIGIT]
|
314
|
+
|
315
|
+
sign = "+" / "-"
|
316
|
+
|
317
|
+
year = 4DIGIT ; 0000-9999
|
318
|
+
month = 2DIGIT ; 01-12
|
319
|
+
day = 2DIGIT ; 01-28/29/30/31 depending on month and leap year
|
320
|
+
hour = 2DIGIT ; 00-23
|
321
|
+
minute = 2DIGIT ; 00-59
|
322
|
+
second = 2DIGIT ; 00-58/59/60 depending on leap second
|
323
|
+
zone = utc-designator / utc-offset
|
324
|
+
utc-designator = %x5A ; uppercase "Z"
|
325
|
+
|
326
|
+
date = year [month day]
|
327
|
+
/ year "-" month
|
328
|
+
/ "--" month [day]
|
329
|
+
/ "--" "-" day
|
330
|
+
date-noreduc = year month day
|
331
|
+
/ "--" month day
|
332
|
+
/ "--" "-" day
|
333
|
+
date-complete = year month day
|
334
|
+
|
335
|
+
time = hour [minute [second]] [zone]
|
336
|
+
/ "-" minute [second] [zone]
|
337
|
+
/ "-" "-" second [zone]
|
338
|
+
time-notrunc = hour [minute [second]] [zone]
|
339
|
+
time-complete = hour minute second [zone]
|
340
|
+
|
341
|
+
|
342
|
+
time-designator = %x54 ; uppercase "T"
|
343
|
+
date-time = date-noreduc time-designator time-notrunc
|
344
|
+
timestamp = date-complete time-designator time-complete
|
345
|
+
|
346
|
+
date-and-or-time = date-time / date / time-designator time
|
347
|
+
|
348
|
+
utc-offset = sign hour [minute]
|
349
|
+
|
350
|
+
Language-Tag = <Language-Tag, defined in RFC5646, Section 2.1>
|
351
|
+
|
352
|
+
iana-valuespec = <value-spec, see Section 12>
|
353
|
+
; a publicly defined valuetype format, registered
|
354
|
+
; with IANA, as defined in Section 12 of this
|
355
|
+
; document.
|
356
|
+
----
|
357
|
+
|
358
|
+
[[section4_1]]
|
359
|
+
=== TEXT
|
360
|
+
|
361
|
+
"text": The "text" value type should be used to identify values that
|
362
|
+
contain human-readable text. As for the language, it is controlled
|
363
|
+
by the `LANGUAGE` property parameter defined in <<section5_1,Section 5.1>>.
|
364
|
+
|
365
|
+
Examples for "text":
|
366
|
+
|
367
|
+
....
|
368
|
+
this is a text value
|
369
|
+
this is one value,this is another
|
370
|
+
this is a single value\, with a comma encoded
|
371
|
+
....
|
372
|
+
|
373
|
+
A formatted text line break in a text value type [bcp14]#MUST# be represented
|
374
|
+
as the character sequence backslash (`U+005C`) followed by a Latin
|
375
|
+
small letter n (`U+006E`) or a Latin capital letter `N` (`U+004E`), that
|
376
|
+
is, `"\n"` or `"\N"`.
|
377
|
+
|
378
|
+
For example, a multiple line `NOTE` value of:
|
379
|
+
|
380
|
+
....
|
381
|
+
Mythical Manager
|
382
|
+
Hyjinx Software Division
|
383
|
+
BabsCo, Inc.
|
384
|
+
....
|
385
|
+
|
386
|
+
could be represented as:
|
387
|
+
|
388
|
+
....
|
389
|
+
NOTE:Mythical Manager\nHyjinx Software Division\n
|
390
|
+
BabsCo\, Inc.\n
|
391
|
+
....
|
392
|
+
|
393
|
+
demonstrating the `\n` literal formatted line break technique, the
|
394
|
+
`CRLF`-followed-by-space line folding technique, and the backslash
|
395
|
+
escape technique.
|
396
|
+
|
397
|
+
[[section4_2]]
|
398
|
+
=== URI
|
399
|
+
|
400
|
+
"uri": The "uri" value type should be used to identify values that
|
401
|
+
are referenced by a Uniform Resource Identifier (URI) instead of
|
402
|
+
encoded in-line. These value references might be used if the value
|
403
|
+
is too large, or otherwise undesirable to include directly. The
|
404
|
+
format for the URI is as defined in <<RFC3986, 3 of>>. Note
|
405
|
+
that the value of a property of type "uri" is what the URI points to,
|
406
|
+
not the URI itself.
|
407
|
+
|
408
|
+
Examples for "uri":
|
409
|
+
|
410
|
+
....
|
411
|
+
http://www.example.com/my/picture.jpg
|
412
|
+
ldap://ldap.example.com/cn=babs%20jensen
|
413
|
+
....
|
414
|
+
|
415
|
+
[[section4_3]]
|
416
|
+
=== DATE, TIME, DATE-TIME, DATE-AND-OR-TIME, and TIMESTAMP
|
417
|
+
|
418
|
+
"date", "time", "date-time", "date-and-or-time", and "timestamp":
|
419
|
+
Each of these value types is based on the definitions in
|
420
|
+
cite:[ISO.8601.2004]. Multiple such values can be specified using the
|
421
|
+
comma-separated notation.
|
422
|
+
|
423
|
+
Only the basic format is supported.
|
424
|
+
|
425
|
+
[[section4_3_1]]
|
426
|
+
==== DATE
|
427
|
+
|
428
|
+
A calendar date as specified in <<ISO.8601.2004, 4.1.2 comma>>.
|
429
|
+
|
430
|
+
Reduced accuracy, as specified in <<ISO.8601.2004, 4.1.2.3 comma>> a)
|
431
|
+
and b), but not c), is permitted.
|
432
|
+
|
433
|
+
Expanded representation, as specified in <<ISO.8601.2004,
|
434
|
+
4.1.4 comma>>, is forbidden.
|
435
|
+
|
436
|
+
Truncated representation, as specified in <<ISO.8601.2000,
|
437
|
+
5.2.1.3 comma>> d), e), and f), is permitted.
|
438
|
+
|
439
|
+
Examples for "date":
|
440
|
+
|
441
|
+
....
|
442
|
+
19850412
|
443
|
+
1985-04
|
444
|
+
1985
|
445
|
+
--0412
|
446
|
+
---12
|
447
|
+
....
|
448
|
+
|
449
|
+
Note the use of `YYYY-MM` in the second example above. `YYYYMM` is
|
450
|
+
disallowed to prevent confusion with `YYMMDD`. Note also that
|
451
|
+
`YYYY-MM-DD` is disallowed since we are using the basic format instead
|
452
|
+
of the extended format.
|
453
|
+
|
454
|
+
[[section4_3_2]]
|
455
|
+
==== TIME
|
456
|
+
|
457
|
+
A time of day as specified in <<ISO.8601.2004, 4.2 comma>>.
|
458
|
+
|
459
|
+
Reduced accuracy, as specified in <<ISO.8601.2004, 4.2.2.3 comma>>,
|
460
|
+
is permitted.
|
461
|
+
|
462
|
+
Representation with decimal fraction, as specified in
|
463
|
+
<<ISO.8601.2004, 4.2.2.4 comma>>, is forbidden.
|
464
|
+
|
465
|
+
The midnight hour is always represented by `00`, never `24` (see
|
466
|
+
<<ISO.8601.2004, 4.2.3 comma>>).
|
467
|
+
|
468
|
+
Truncated representation, as specified in <<ISO.8601.2000,
|
469
|
+
5.3.1.4 comma>> a), b), and c), is permitted.
|
470
|
+
|
471
|
+
Examples for "time":
|
472
|
+
|
473
|
+
....
|
474
|
+
102200
|
475
|
+
1022
|
476
|
+
10
|
477
|
+
-2200
|
478
|
+
--00
|
479
|
+
102200Z
|
480
|
+
102200-0800
|
481
|
+
....
|
482
|
+
|
483
|
+
[[section4_3_3]]
|
484
|
+
==== DATE-TIME
|
485
|
+
|
486
|
+
A date and time of day combination as specified in <<ISO.8601.2004,
|
487
|
+
4.3 comma>>.
|
488
|
+
|
489
|
+
Truncation of the date part, as specified in <<ISO.8601.2000,
|
490
|
+
5.4.2 comma>> c), is permitted.
|
491
|
+
|
492
|
+
Examples for "date-time":
|
493
|
+
|
494
|
+
....
|
495
|
+
19961022T140000
|
496
|
+
--1022T1400
|
497
|
+
---22T14
|
498
|
+
....
|
499
|
+
|
500
|
+
[[section4_3_4]]
|
501
|
+
==== DATE-AND-OR-TIME
|
502
|
+
|
503
|
+
Either a `DATE-TIME`, a `DATE`, or a `TIME` value. To allow unambiguous
|
504
|
+
interpretation, a stand-alone `TIME` value is always preceded by a `"T"`.
|
505
|
+
|
506
|
+
Examples for "date-and-or-time":
|
507
|
+
|
508
|
+
....
|
509
|
+
19961022T140000
|
510
|
+
--1022T1400
|
511
|
+
---22T14
|
512
|
+
19850412
|
513
|
+
1985-04
|
514
|
+
1985
|
515
|
+
--0412
|
516
|
+
---12
|
517
|
+
T102200
|
518
|
+
T1022
|
519
|
+
T10
|
520
|
+
T-2200
|
521
|
+
T--00
|
522
|
+
T102200Z
|
523
|
+
T102200-0800
|
524
|
+
....
|
525
|
+
|
526
|
+
[[section4_3_5]]
|
527
|
+
==== TIMESTAMP
|
528
|
+
|
529
|
+
A complete date and time of day combination as specified in
|
530
|
+
<<ISO.8601.2004, 4.3.2 comma>>.
|
531
|
+
|
532
|
+
Examples for "timestamp":
|
533
|
+
|
534
|
+
....
|
535
|
+
19961022T140000
|
536
|
+
19961022T140000Z
|
537
|
+
19961022T140000-05
|
538
|
+
19961022T140000-0500
|
539
|
+
....
|
540
|
+
|
541
|
+
[[section4_4]]
|
542
|
+
=== BOOLEAN
|
543
|
+
|
544
|
+
"boolean": The "boolean" value type is used to express boolean
|
545
|
+
values. These values are case-insensitive.
|
546
|
+
|
547
|
+
Examples:
|
548
|
+
|
549
|
+
....
|
550
|
+
TRUE
|
551
|
+
false
|
552
|
+
True
|
553
|
+
....
|
554
|
+
|
555
|
+
|
556
|
+
[[section4_5]]
|
557
|
+
=== INTEGER
|
558
|
+
|
559
|
+
"integer": The "integer" value type is used to express signed
|
560
|
+
integers in decimal format. If sign is not specified, the value is
|
561
|
+
assumed positive `"+"`. Multiple "integer" values can be specified
|
562
|
+
using the comma-separated notation. The maximum value is
|
563
|
+
9223372036854775807, and the minimum value is -9223372036854775808.
|
564
|
+
These limits correspond to a signed 64-bit integer using two's-
|
565
|
+
complement arithmetic.
|
566
|
+
|
567
|
+
Examples:
|
568
|
+
|
569
|
+
....
|
570
|
+
1234567890
|
571
|
+
-1234556790
|
572
|
+
+1234556790,432109876
|
573
|
+
....
|
574
|
+
|
575
|
+
[[section4_6]]
|
576
|
+
=== FLOAT
|
577
|
+
|
578
|
+
"float": The "float" value type is used to express real numbers. If
|
579
|
+
sign is not specified, the value is assumed positive `"+"`. Multiple
|
580
|
+
"float" values can be specified using the comma-separated notation.
|
581
|
+
Implementations [bcp14]#MUST# support a precision equal or better than that of
|
582
|
+
the IEEE "binary64" format cite:[IEEE.754.2008].
|
583
|
+
|
584
|
+
NOTE: Scientific notation is disallowed. Implementers wishing to
|
585
|
+
use their favorite language's `%f` formatting should be careful.
|
586
|
+
|
587
|
+
Examples:
|
588
|
+
|
589
|
+
....
|
590
|
+
20.30
|
591
|
+
1000000.0000001
|
592
|
+
1.333,3.14
|
593
|
+
....
|
594
|
+
|
595
|
+
[[section4_7]]
|
596
|
+
=== UTC-OFFSET
|
597
|
+
|
598
|
+
"utc-offset": The "utc-offset" value type specifies that the property
|
599
|
+
value is a signed offset from UTC. This value type can be specified
|
600
|
+
in the `TZ` property.
|
601
|
+
|
602
|
+
The value type is an offset from Coordinated Universal Time (UTC).
|
603
|
+
It is specified as a positive or negative difference in units of
|
604
|
+
hours and minutes (e.g., `+hhmm`). The time is specified as a 24-hour
|
605
|
+
clock. Hour values are from `00` to `23`, and minute values are from `00`
|
606
|
+
to `59`. Hour and minutes are 2 digits with high-order zeroes required
|
607
|
+
to maintain digit count. The basic format for ISO 8601 UTC offsets
|
608
|
+
[bcp14]#MUST# be used.
|
609
|
+
|
610
|
+
[[section4_8]]
|
611
|
+
=== LANGUAGE-TAG
|
612
|
+
|
613
|
+
"language-tag": A single language tag, as defined in cite:[RFC5646].
|
614
|
+
|
615
|
+
[[section5]]
|
616
|
+
== Property Parameters
|
617
|
+
|
618
|
+
A property can have attributes associated with it. These "property
|
619
|
+
parameters" contain meta-information about the property or the
|
620
|
+
property value. In some cases, the property parameter can be multi-
|
621
|
+
valued in which case the property parameter value elements are
|
622
|
+
separated by a `COMMA` (`U+002C`).
|
623
|
+
|
624
|
+
Property parameter value elements that contain the `COLON` (`U+003A`),
|
625
|
+
`SEMICOLON` (`U+003B`), or `COMMA` (`U+002C`) character separators [bcp14]#MUST# be
|
626
|
+
specified as quoted-string text values. Property parameter values
|
627
|
+
[bcp14]#MUST NOT# contain the `DQUOTE` (`U+0022`) character. The `DQUOTE` character
|
628
|
+
is used as a delimiter for parameter values that contain restricted
|
629
|
+
characters or URI text.
|
630
|
+
|
631
|
+
Applications [bcp14]#MUST# ignore x-param and iana-param values they don't
|
632
|
+
recognize.
|
633
|
+
|
634
|
+
[[section5_1]]
|
635
|
+
=== LANGUAGE
|
636
|
+
|
637
|
+
The `LANGUAGE` property parameter is used to identify data in multiple
|
638
|
+
languages. There is no concept of "default" language, except as
|
639
|
+
specified by any "Content-Language" MIME header parameter that is
|
640
|
+
present cite:[RFC3282]. The value of the LANGUAGE property parameter is a
|
641
|
+
language tag as defined in <<RFC5646,2 of>>.
|
642
|
+
|
643
|
+
Examples:
|
644
|
+
|
645
|
+
....
|
646
|
+
ROLE;LANGUAGE=tr:hoca
|
647
|
+
....
|
648
|
+
|
649
|
+
ABNF:
|
650
|
+
|
651
|
+
[source,abnf]
|
652
|
+
----
|
653
|
+
language-param = "LANGUAGE=" Language-Tag
|
654
|
+
; Language-Tag is defined in section 2.1 of RFC 5646
|
655
|
+
----
|
656
|
+
|
657
|
+
[[section5_2]]
|
658
|
+
=== VALUE
|
659
|
+
|
660
|
+
The `VALUE` parameter is [bcp14]#OPTIONAL#, used to identify the value type
|
661
|
+
(data type) and format of the value. The use of these predefined
|
662
|
+
formats is encouraged even if the value parameter is not explicitly
|
663
|
+
used. By defining a standard set of value types and their formats,
|
664
|
+
existing parsing and processing code can be leveraged. The
|
665
|
+
predefined data type values [bcp14]#MUST NOT# be repeated in `COMMA`-separated
|
666
|
+
value lists except within the `N`, `NICKNAME`, `ADR`, and `CATEGORIES`
|
667
|
+
properties.
|
668
|
+
|
669
|
+
ABNF:
|
670
|
+
|
671
|
+
[source,abnf]
|
672
|
+
----
|
673
|
+
value-param = "VALUE=" value-type
|
674
|
+
|
675
|
+
value-type = "text"
|
676
|
+
/ "uri"
|
677
|
+
/ "date"
|
678
|
+
/ "time"
|
679
|
+
/ "date-time"
|
680
|
+
/ "date-and-or-time"
|
681
|
+
/ "timestamp"
|
682
|
+
/ "boolean"
|
683
|
+
/ "integer"
|
684
|
+
/ "float"
|
685
|
+
/ "utc-offset"
|
686
|
+
/ "language-tag"
|
687
|
+
/ iana-token ; registered as described in section 12
|
688
|
+
/ x-name
|
689
|
+
----
|
690
|
+
|
691
|
+
[[section5_3]]
|
692
|
+
=== PREF
|
693
|
+
|
694
|
+
The PREF parameter is [bcp14]#OPTIONAL# and is used to indicate that the
|
695
|
+
corresponding instance of a property is preferred by the vCard
|
696
|
+
author. Its value [bcp14]#MUST# be an integer between 1 and 100 that
|
697
|
+
quantifies the level of preference. Lower values correspond to a
|
698
|
+
higher level of preference, with 1 being most preferred.
|
699
|
+
|
700
|
+
When the parameter is absent, the default [bcp14]#MUST# be to interpret the
|
701
|
+
property instance as being least preferred.
|
702
|
+
|
703
|
+
Note that the value of this parameter is to be interpreted only in
|
704
|
+
relation to values assigned to other instances of the same property
|
705
|
+
in the same vCard. A given value, or the absence of a value, [bcp14]#MUST NOT#
|
706
|
+
be interpreted on its own.
|
707
|
+
|
708
|
+
This parameter [bcp14]#MAY# be applied to any property that allows multiple
|
709
|
+
instances.
|
710
|
+
|
711
|
+
ABNF:
|
712
|
+
|
713
|
+
[source,abnf]
|
714
|
+
----
|
715
|
+
pref-param = "PREF=" (1*2DIGIT / "100")
|
716
|
+
; An integer between 1 and 100.
|
717
|
+
----
|
718
|
+
|
719
|
+
|
720
|
+
[[section5_4]]
|
721
|
+
=== ALTID
|
722
|
+
|
723
|
+
The `ALTID` parameter is used to "tag" property instances as being
|
724
|
+
alternative representations of the same logical property. For
|
725
|
+
example, translations of a property in multiple languages generates
|
726
|
+
multiple property instances having different `LANGUAGE` (<<section5_1,Section 5.1>>)
|
727
|
+
parameter that are tagged with the same `ALTID` value.
|
728
|
+
|
729
|
+
This parameter's value is treated as an opaque string. Its sole
|
730
|
+
purpose is to be compared for equality against other `ALTID` parameter
|
731
|
+
values.
|
732
|
+
|
733
|
+
Two property instances are considered alternative representations of
|
734
|
+
the same logical property if and only if their names as well as the
|
735
|
+
value of their `ALTID` parameters are identical. Property instances
|
736
|
+
without the `ALTID` parameter [bcp14]#MUST NOT# be considered an alternative
|
737
|
+
representation of any other property instance. Values for the `ALTID`
|
738
|
+
parameter are not globally unique: they [bcp14]#MAY# be reused for different
|
739
|
+
property names.
|
740
|
+
|
741
|
+
Property instances having the same `ALTID` parameter value count as 1
|
742
|
+
toward cardinality. Therefore, since `N` (<<section6_2_2,Section 6.2.2>>) has
|
743
|
+
cardinality *1 and TITLE (<<section6_6_1,Section 6.6.1>>) has cardinality *, these
|
744
|
+
three examples would be legal:
|
745
|
+
|
746
|
+
....
|
747
|
+
N;ALTID=1;LANGUAGE=jp:<U+5C71><U+7530>;<U+592A><U+90CE>;;;
|
748
|
+
N;ALTID=1;LANGUAGE=en:Yamada;Taro;;;
|
749
|
+
(<U+XXXX> denotes a UTF8-encoded Unicode character.)
|
750
|
+
....
|
751
|
+
|
752
|
+
....
|
753
|
+
TITLE;ALTID=1;LANGUAGE=fr:Patron
|
754
|
+
TITLE;ALTID=1;LANGUAGE=en:Boss
|
755
|
+
....
|
756
|
+
|
757
|
+
....
|
758
|
+
TITLE;ALTID=1;LANGUAGE=fr:Patron
|
759
|
+
TITLE;ALTID=1;LANGUAGE=en:Boss
|
760
|
+
TITLE;ALTID=2;LANGUAGE=en:Chief vCard Evangelist
|
761
|
+
....
|
762
|
+
|
763
|
+
while this one would not:
|
764
|
+
|
765
|
+
....
|
766
|
+
N;ALTID=1;LANGUAGE=jp:<U+5C71><U+7530>;<U+592A><U+90CE>;;;
|
767
|
+
N:Yamada;Taro;;;
|
768
|
+
....
|
769
|
+
(Two instances of the `N` property.)
|
770
|
+
|
771
|
+
and these three would be legal but questionable:
|
772
|
+
|
773
|
+
....
|
774
|
+
TITLE;ALTID=1;LANGUAGE=fr:Patron
|
775
|
+
TITLE;ALTID=2;LANGUAGE=en:Boss
|
776
|
+
....
|
777
|
+
(Should probably have the same `ALTID` value.)
|
778
|
+
|
779
|
+
....
|
780
|
+
TITLE;ALTID=1;LANGUAGE=fr:Patron
|
781
|
+
TITLE:LANGUAGE=en:Boss
|
782
|
+
....
|
783
|
+
(Second line should probably have `ALTID=1`.)
|
784
|
+
|
785
|
+
....
|
786
|
+
N;ALTID=1;LANGUAGE=jp:<U+5C71><U+7530>;<U+592A><U+90CE>;;;
|
787
|
+
N;ALTID=1;LANGUAGE=en:Yamada;Taro;;;
|
788
|
+
N;ALTID=1;LANGUAGE=en:Smith;John;;;
|
789
|
+
....
|
790
|
+
(The last line should probably have `ALTID=2`. But that would be
|
791
|
+
illegal because N has cardinality *1.)
|
792
|
+
|
793
|
+
The `ALTID` property [bcp14]#MAY# also be used in may contexts other than with
|
794
|
+
the `LANGUAGE` parameter. Here's an example with two representations
|
795
|
+
of the same photo in different file formats:
|
796
|
+
|
797
|
+
....
|
798
|
+
PHOTO;ALTID=1:data:image/jpeg;base64,...
|
799
|
+
PHOTO;ALTID=1;data:image/jp2;base64,...
|
800
|
+
....
|
801
|
+
|
802
|
+
ABNF:
|
803
|
+
|
804
|
+
[source,abnf]
|
805
|
+
----
|
806
|
+
altid-param = "ALTID=" param-value
|
807
|
+
----
|
808
|
+
|
809
|
+
[[section5_5]]
|
810
|
+
=== PID
|
811
|
+
|
812
|
+
The `PID` parameter is used to identify a specific property among
|
813
|
+
multiple instances. It plays a role analogous to the `UID` property
|
814
|
+
(<<section6_7_6,Section 6.7.6>>) on a per-property instead of per-vCard basis. It [bcp14]#MAY#
|
815
|
+
appear more than once in a given property. It [bcp14]#MUST NOT# appear on
|
816
|
+
properties that may have only one instance per vCard. Its value is
|
817
|
+
either a single small positive integer or a pair of small positive
|
818
|
+
integers separated by a dot. Multiple values may be encoded in a
|
819
|
+
single `PID` parameter by separating the values with a comma `","`. See
|
820
|
+
<<section7,Section 7>> for more details on its usage.
|
821
|
+
|
822
|
+
ABNF:
|
823
|
+
|
824
|
+
[source,abnf]
|
825
|
+
----
|
826
|
+
pid-param = "PID=" pid-value *("," pid-value)
|
827
|
+
pid-value = 1*DIGIT ["." 1*DIGIT]
|
828
|
+
----
|
829
|
+
|
830
|
+
[[section5_6]]
|
831
|
+
=== TYPE
|
832
|
+
|
833
|
+
The `TYPE` parameter has multiple, different uses. In general, it is a
|
834
|
+
way of specifying class characteristics of the associated property.
|
835
|
+
Most of the time, its value is a comma-separated subset of a
|
836
|
+
predefined enumeration. In this document, the following properties
|
837
|
+
make use of this parameter: `FN`, `NICKNAME`, `PHOTO`, `ADR`, `TEL`, `EMAIL`,
|
838
|
+
`IMPP`, `LANG`, `TZ`, `GEO`, `TITLE`, `ROLE`, `LOGO`, `ORG`, `RELATED`, `CATEGORIES`,
|
839
|
+
`NOTE`, `SOUND`, `URL`, `KEY`, `FBURL`, `CALADRURI`, and `CALURI`. The `TYPE`
|
840
|
+
parameter [bcp14]#MUST NOT# be applied on other properties defined in this
|
841
|
+
document.
|
842
|
+
|
843
|
+
The "work" and "home" values act like tags. The "work" value implies
|
844
|
+
that the property is related to an individual's work place, while the
|
845
|
+
"home" value implies that the property is related to an individual's
|
846
|
+
personal life. When neither "work" nor "home" is present, it is
|
847
|
+
implied that the property is related to both an individual's work
|
848
|
+
place and personal life in the case that the `KIND` property's value is
|
849
|
+
"individual", or to none in other cases.
|
850
|
+
|
851
|
+
ABNF:
|
852
|
+
|
853
|
+
[source,abnf]
|
854
|
+
----
|
855
|
+
type-param = "TYPE=" type-value *("," type-value)
|
856
|
+
|
857
|
+
type-value = "work" / "home" / type-param-tel
|
858
|
+
/ type-param-related / iana-token / x-name
|
859
|
+
; This is further defined in individual property sections.
|
860
|
+
----
|
861
|
+
|
862
|
+
[[section5_7]]
|
863
|
+
=== MEDIATYPE
|
864
|
+
|
865
|
+
The `MEDIATYPE` parameter is used with properties whose value is a URI.
|
866
|
+
Its use is [bcp14]#OPTIONAL#. It provides a hint to the vCard consumer
|
867
|
+
application about the media type cite:[RFC2046] of the resource identified
|
868
|
+
by the URI. Some URI schemes do not need this parameter. For
|
869
|
+
example, the "data" scheme allows the media type to be explicitly
|
870
|
+
indicated as part of the URI cite:[RFC2397]. Another scheme, "http",
|
871
|
+
provides the media type as part of the URI resolution process, with
|
872
|
+
the Content-Type HTTP header cite:[RFC2616]. The `MEDIATYPE` parameter is
|
873
|
+
intended to be used with URI schemes that do not provide such
|
874
|
+
functionality (e.g., "ftp" cite:[RFC1738]).
|
875
|
+
|
876
|
+
ABNF:
|
877
|
+
|
878
|
+
[source,abnf]
|
879
|
+
----
|
880
|
+
mediatype-param = "MEDIATYPE=" mediatype
|
881
|
+
mediatype = type-name "/" subtype-name *( ";" attribute "=" value )
|
882
|
+
; "attribute" and "value" are from cite:[RFC2045]
|
883
|
+
; "type-name" and "subtype-name" are from cite:[RFC4288]
|
884
|
+
----
|
885
|
+
|
886
|
+
[[section5_8]]
|
887
|
+
=== CALSCALE
|
888
|
+
|
889
|
+
The `CALSCALE` parameter is identical to the `CALSCALE` property in
|
890
|
+
iCalendar (see <<RFC5545,3.7.1 of>>). It is used to define the
|
891
|
+
calendar system in which a date or date-time value is expressed. The
|
892
|
+
only value specified by iCalendar is "gregorian", which stands for
|
893
|
+
the Gregorian system. It is the default when the parameter is
|
894
|
+
absent. Additional values may be defined in extension documents and
|
895
|
+
registered with IANA (see <<section10_3_4,Section 10.3.4>>). A vCard implementation
|
896
|
+
[bcp14]#MUST# ignore properties with a `CALSCALE` parameter value that it does
|
897
|
+
not understand.
|
898
|
+
|
899
|
+
ABNF:
|
900
|
+
|
901
|
+
[source,abnf]
|
902
|
+
----
|
903
|
+
calscale-param = "CALSCALE=" calscale-value
|
904
|
+
|
905
|
+
calscale-value = "gregorian" / iana-token / x-name
|
906
|
+
----
|
907
|
+
|
908
|
+
[[section5_9]]
|
909
|
+
=== SORT-AS
|
910
|
+
|
911
|
+
The "sort-as" parameter is used to specify the string to be used for
|
912
|
+
national-language-specific sorting. Without this information,
|
913
|
+
sorting algorithms could incorrectly sort this vCard within a
|
914
|
+
sequence of sorted vCards. When this property is present in a vCard,
|
915
|
+
then the given strings are used for sorting the vCard.
|
916
|
+
|
917
|
+
This parameter's value is a comma-separated list that [bcp14]#MUST# have as
|
918
|
+
many or fewer elements as the corresponding property value has
|
919
|
+
components. This parameter's value is case-sensitive.
|
920
|
+
|
921
|
+
ABNF:
|
922
|
+
|
923
|
+
[source,abnf]
|
924
|
+
----
|
925
|
+
sort-as-param = "SORT-AS=" sort-as-value
|
926
|
+
|
927
|
+
sort-as-value = param-value *("," param-value)
|
928
|
+
----
|
929
|
+
|
930
|
+
Examples: For the case of surname and given name sorting, the
|
931
|
+
following examples define common sort string usage with the `N`
|
932
|
+
property.
|
933
|
+
|
934
|
+
....
|
935
|
+
FN:Rene van der Harten
|
936
|
+
N;SORT-AS="Harten,Rene":van der Harten;Rene,J.;Sir;R.D.O.N.
|
937
|
+
....
|
938
|
+
|
939
|
+
....
|
940
|
+
FN:Robert Pau Shou Chang
|
941
|
+
N;SORT-AS="Pau Shou Chang,Robert":Shou Chang;Robert,Pau;;
|
942
|
+
....
|
943
|
+
|
944
|
+
....
|
945
|
+
FN:Osamu Koura
|
946
|
+
N;SORT-AS="Koura,Osamu":Koura;Osamu;;
|
947
|
+
....
|
948
|
+
|
949
|
+
....
|
950
|
+
FN:Oscar del Pozo
|
951
|
+
N;SORT-AS="Pozo,Oscar":del Pozo Triscon;Oscar;;
|
952
|
+
....
|
953
|
+
|
954
|
+
....
|
955
|
+
FN:Chistine d'Aboville
|
956
|
+
N;SORT-AS="Aboville,Christine":d'Aboville;Christine;;
|
957
|
+
....
|
958
|
+
|
959
|
+
....
|
960
|
+
FN:H. James de Mann
|
961
|
+
N;SORT-AS="Mann,James":de Mann;Henry,James;;
|
962
|
+
....
|
963
|
+
|
964
|
+
If sorted by surname, the results would be:
|
965
|
+
|
966
|
+
....
|
967
|
+
Christine d'Aboville
|
968
|
+
Rene van der Harten
|
969
|
+
Osamu Koura
|
970
|
+
H. James de Mann
|
971
|
+
Robert Pau Shou Chang
|
972
|
+
Oscar del Pozo
|
973
|
+
....
|
974
|
+
|
975
|
+
If sorted by given name, the results would be:
|
976
|
+
|
977
|
+
....
|
978
|
+
Christine d'Aboville
|
979
|
+
H. James de Mann
|
980
|
+
Osamu Koura
|
981
|
+
Oscar del Pozo
|
982
|
+
Rene van der Harten
|
983
|
+
Robert Pau Shou Chang
|
984
|
+
....
|
985
|
+
|
986
|
+
[[section5_10]]
|
987
|
+
=== GEO
|
988
|
+
|
989
|
+
The `GEO` parameter can be used to indicate global positioning
|
990
|
+
information that is specific to an address. Its value is the same as
|
991
|
+
that of the `GEO` property (see <<section6_5_2,Section 6.5.2>>).
|
992
|
+
|
993
|
+
ABNF:
|
994
|
+
|
995
|
+
[source,abnf]
|
996
|
+
----
|
997
|
+
geo-parameter = "GEO=" DQUOTE URI DQUOTE
|
998
|
+
----
|
999
|
+
|
1000
|
+
[[section5_11]]
|
1001
|
+
=== TZ
|
1002
|
+
|
1003
|
+
The `TZ` parameter can be used to indicate time zone information that
|
1004
|
+
is specific to an address. Its value is the same as that of the `TZ`
|
1005
|
+
property.
|
1006
|
+
|
1007
|
+
ABNF:
|
1008
|
+
|
1009
|
+
[source,abnf]
|
1010
|
+
----
|
1011
|
+
tz-parameter = "TZ=" (param-value / DQUOTE URI DQUOTE)
|
1012
|
+
----
|
1013
|
+
|
1014
|
+
[[section6]]
|
1015
|
+
== vCard Properties
|
1016
|
+
|
1017
|
+
What follows is an enumeration of the standard vCard properties.
|
1018
|
+
|
1019
|
+
[[section6_1]]
|
1020
|
+
=== General Properties
|
1021
|
+
|
1022
|
+
[[section6_1_1]]
|
1023
|
+
==== BEGIN
|
1024
|
+
|
1025
|
+
Purpose:: To denote the beginning of a syntactic entity within a
|
1026
|
+
text/vcard content-type.
|
1027
|
+
|
1028
|
+
Value type:: text
|
1029
|
+
|
1030
|
+
Cardinality:: 1
|
1031
|
+
|
1032
|
+
Special notes:: The content entity [bcp14]#MUST# begin with the BEGIN property
|
1033
|
+
with a value of `"VCARD"`. The value is case-insensitive.
|
1034
|
+
|
1035
|
+
The `BEGIN` property is used in conjunction with the `END` property to
|
1036
|
+
delimit an entity containing a related set of properties within a
|
1037
|
+
text/vcard content-type. This construct can be used instead of
|
1038
|
+
including multiple vCards as body parts inside of a multipart/
|
1039
|
+
alternative MIME message. It is provided for applications that
|
1040
|
+
wish to define content that can contain multiple entities within
|
1041
|
+
the same text/vcard content-type or to define content that can be
|
1042
|
+
identifiable outside of a MIME environment.
|
1043
|
+
|
1044
|
+
ABNF::
|
1045
|
+
|
1046
|
+
[source,abnf]
|
1047
|
+
----
|
1048
|
+
BEGIN-param = 0" " ; no parameter allowed
|
1049
|
+
BEGIN-value = "VCARD"
|
1050
|
+
----
|
1051
|
+
|
1052
|
+
Example:
|
1053
|
+
|
1054
|
+
....
|
1055
|
+
BEGIN:VCARD
|
1056
|
+
....
|
1057
|
+
|
1058
|
+
[[section6_1_2]]
|
1059
|
+
==== END
|
1060
|
+
|
1061
|
+
Purpose:: To denote the end of a syntactic entity within a text/vcard
|
1062
|
+
content-type.
|
1063
|
+
|
1064
|
+
Value type:: text
|
1065
|
+
|
1066
|
+
Cardinality:: 1
|
1067
|
+
|
1068
|
+
Special notes:: The content entity [bcp14]#MUST# end with the `END` type with a
|
1069
|
+
value of `"VCARD"`. The value is case-insensitive.
|
1070
|
+
+
|
1071
|
+
The `END` property is used in conjunction with the `BEGIN` property to
|
1072
|
+
delimit an entity containing a related set of properties within a
|
1073
|
+
text/vcard content-type. This construct can be used instead of or
|
1074
|
+
in addition to wrapping separate sets of information inside
|
1075
|
+
additional MIME headers. It is provided for applications that
|
1076
|
+
wish to define content that can contain multiple entities within
|
1077
|
+
the same text/vcard content-type or to define content that can be
|
1078
|
+
identifiable outside of a MIME environment.
|
1079
|
+
|
1080
|
+
ABNF::
|
1081
|
+
+
|
1082
|
+
[source,abnf]
|
1083
|
+
----
|
1084
|
+
END-param = 0" " ; no parameter allowed
|
1085
|
+
END-value = "VCARD"
|
1086
|
+
----
|
1087
|
+
|
1088
|
+
Example::
|
1089
|
+
+
|
1090
|
+
....
|
1091
|
+
END:VCARD
|
1092
|
+
....
|
1093
|
+
|
1094
|
+
[[section6_1_3]]
|
1095
|
+
==== SOURCE
|
1096
|
+
|
1097
|
+
Purpose:: To identify the source of directory information contained
|
1098
|
+
in the content type.
|
1099
|
+
|
1100
|
+
Value type:: uri
|
1101
|
+
|
1102
|
+
Cardinality:: *
|
1103
|
+
|
1104
|
+
Special notes:: The `SOURCE` property is used to provide the means by
|
1105
|
+
which applications knowledgable in the given directory service
|
1106
|
+
protocol can obtain additional or more up-to-date information from
|
1107
|
+
the directory service. It contains a URI as defined in cite:[RFC3986]
|
1108
|
+
and/or other information referencing the vCard to which the
|
1109
|
+
information pertains. When directory information is available
|
1110
|
+
from more than one source, the sending entity can pick what it
|
1111
|
+
considers to be the best source, or multiple `SOURCE` properties can
|
1112
|
+
be included.
|
1113
|
+
|
1114
|
+
ABNF::
|
1115
|
+
+
|
1116
|
+
[source,abnf]
|
1117
|
+
----
|
1118
|
+
SOURCE-param = "VALUE=uri" / pid-param / pref-param / altid-param
|
1119
|
+
/ mediatype-param / any-param
|
1120
|
+
SOURCE-value = URI
|
1121
|
+
----
|
1122
|
+
|
1123
|
+
Examples::
|
1124
|
+
+
|
1125
|
+
....
|
1126
|
+
SOURCE:ldap://ldap.example.com/cn=Babs%20Jensen,%20o=Babsco,%20c=US
|
1127
|
+
SOURCE:http://directory.example.com/addressbooks/jdoe/
|
1128
|
+
Jean%20Dupont.vcf
|
1129
|
+
....
|
1130
|
+
|
1131
|
+
[[section6_1_4]]
|
1132
|
+
==== KIND
|
1133
|
+
|
1134
|
+
Purpose:: To specify the kind of object the vCard represents.
|
1135
|
+
|
1136
|
+
Value type:: A single text value.
|
1137
|
+
|
1138
|
+
Cardinality:: *1
|
1139
|
+
|
1140
|
+
Special notes:: The value may be one of the following:
|
1141
|
+
+
|
1142
|
+
* "individual" for a vCard representing a single person or entity.
|
1143
|
+
This is the default kind of vCard.
|
1144
|
+
* "group" for a vCard representing a group of persons or entities.
|
1145
|
+
The group's member entities can be other vCards or other types
|
1146
|
+
of entities, such as email addresses or web sites. A group
|
1147
|
+
vCard will usually contain `MEMBER` properties to specify the
|
1148
|
+
members of the group, but it is not required to. A group vCard
|
1149
|
+
without `MEMBER` properties can be considered an abstract
|
1150
|
+
grouping, or one whose members are known empirically (perhaps
|
1151
|
+
"IETF Participants" or "Republican U.S. Senators").
|
1152
|
+
+
|
1153
|
+
All properties in a group vCard apply to the group as a whole,
|
1154
|
+
and not to any particular `MEMBER`. For example, an `EMAIL`
|
1155
|
+
property might specify the address of a mailing list associated
|
1156
|
+
with the group, and an IMPP property might refer to a group
|
1157
|
+
chat room.
|
1158
|
+
* "org" for a vCard representing an organization. An organization
|
1159
|
+
vCard will not (in fact, [bcp14]#MUST NOT#) contain `MEMBER` properties,
|
1160
|
+
and so these are something of a cross between "individual" and
|
1161
|
+
"group". An organization is a single entity, but not a person.
|
1162
|
+
It might represent a business or government, a department or
|
1163
|
+
division within a business or government, a club, an
|
1164
|
+
association, or the like.
|
1165
|
+
+
|
1166
|
+
All properties in an organization vCard apply to the
|
1167
|
+
organization as a whole, as is the case with a group vCard.
|
1168
|
+
For example, an `EMAIL` property might specify the address of a
|
1169
|
+
* "location" for a named geographical place. A location vCard will
|
1170
|
+
usually contain a `GEO` property, but it is not required to. A
|
1171
|
+
location vCard without a `GEO` property can be considered an
|
1172
|
+
abstract location, or one whose definition is known empirically
|
1173
|
+
(perhaps "New England" or "The Seashore").
|
1174
|
+
+
|
1175
|
+
All properties in a location vCard apply to the location
|
1176
|
+
itself, and not with any entity that might exist at that
|
1177
|
+
location. For example, in a vCard for an office building, an
|
1178
|
+
`ADR` property might give the mailing address for the building,
|
1179
|
+
and a `TEL` property might specify the telephone number of the
|
1180
|
+
receptionist.
|
1181
|
+
* An x-name. vCards [bcp14]#MAY# include private or experimental values for
|
1182
|
+
`KIND`. Remember that x-name values are not intended for general
|
1183
|
+
use and are unlikely to interoperate.
|
1184
|
+
* An iana-token. Additional values may be registered with IANA (see
|
1185
|
+
<<section10_3_4,Section 10.3.4>>). A new value's specification document [bcp14]#MUST#
|
1186
|
+
specify which properties make sense for that new kind of vCard
|
1187
|
+
and which do not.
|
1188
|
+
|
1189
|
+
+
|
1190
|
+
Implementations [bcp14]#MUST# support the specific string values defined
|
1191
|
+
above. If this property is absent, "individual" [bcp14]#MUST# be assumed
|
1192
|
+
as the default. If this property is present but the
|
1193
|
+
implementation does not understand its value (the value is an
|
1194
|
+
x-name or iana-token that the implementation does not support),
|
1195
|
+
the implementation [bcp14]#SHOULD# act in a neutral way, which usually
|
1196
|
+
means treating the vCard as though its kind were "individual".
|
1197
|
+
The presence of `MEMBER` properties [bcp14]#MAY#, however, be taken as an
|
1198
|
+
indication that the unknown kind is an extension of "group".
|
1199
|
+
|
1200
|
+
Clients often need to visually distinguish contacts based on what
|
1201
|
+
they represent, and the `KIND` property provides a direct way for
|
1202
|
+
them to do so. For example, when displaying contacts in a list,
|
1203
|
+
an icon could be displayed next to each one, using distinctive
|
1204
|
+
icons for the different kinds; a client might use an outline of a
|
1205
|
+
single person to represent an "individual", an outline of multiple
|
1206
|
+
people to represent a "group", and so on. Alternatively, or in
|
1207
|
+
addition, a client might choose to segregate different kinds of
|
1208
|
+
vCards to different panes, tabs, or selections in the user
|
1209
|
+
interface.
|
1210
|
+
|
1211
|
+
Some clients might also make functional distinctions among the
|
1212
|
+
kinds, ignoring "location" vCards for some purposes and
|
1213
|
+
considering only "location" vCards for others.
|
1214
|
+
|
1215
|
+
When designing those sorts of visual and functional distinctions,
|
1216
|
+
client implementations have to decide how to fit unsupported kinds
|
1217
|
+
into the scheme. What icon is used for them? The one for
|
1218
|
+
"individual"? A unique one, such as an icon of a question mark?
|
1219
|
+
Which tab do they go into? It is beyond the scope of this
|
1220
|
+
specification to answer these questions, but these are things
|
1221
|
+
implementers need to consider.
|
1222
|
+
|
1223
|
+
ABNF::
|
1224
|
+
+
|
1225
|
+
[source,abnf]
|
1226
|
+
----
|
1227
|
+
KIND-param = "VALUE=text" / any-param
|
1228
|
+
KIND-value = "individual" / "group" / "org" / "location"
|
1229
|
+
/ iana-token / x-name
|
1230
|
+
----
|
1231
|
+
|
1232
|
+
Example::
|
1233
|
+
+
|
1234
|
+
This represents someone named Jane Doe working in the marketing
|
1235
|
+
department of the North American division of ABC Inc.
|
1236
|
+
+
|
1237
|
+
....
|
1238
|
+
BEGIN:VCARD
|
1239
|
+
VERSION:4.0
|
1240
|
+
KIND:individual
|
1241
|
+
FN:Jane Doe
|
1242
|
+
ORG:ABC\, Inc.;North American Division;Marketing
|
1243
|
+
END:VCARD
|
1244
|
+
....
|
1245
|
+
+
|
1246
|
+
This represents the department itself, commonly known as ABC
|
1247
|
+
Marketing.
|
1248
|
+
+
|
1249
|
+
....
|
1250
|
+
BEGIN:VCARD
|
1251
|
+
VERSION:4.0
|
1252
|
+
KIND:org
|
1253
|
+
FN:ABC Marketing
|
1254
|
+
ORG:ABC\, Inc.;North American Division;Marketing
|
1255
|
+
END:VCARD
|
1256
|
+
....
|
1257
|
+
|
1258
|
+
[[section6_1_5]]
|
1259
|
+
==== XML
|
1260
|
+
|
1261
|
+
Purpose:: To include extended XML-encoded vCard data in a plain
|
1262
|
+
vCard.
|
1263
|
+
|
1264
|
+
Value type:: A single text value.
|
1265
|
+
|
1266
|
+
Cardinality:: *
|
1267
|
+
|
1268
|
+
Special notes:: The content of this property is a single XML 1.0
|
1269
|
+
cite:[W3C.REC-xml-20081126] element whose namespace [bcp14]#MUST# be explicitly
|
1270
|
+
specified using the xmlns attribute and [bcp14]#MUST NOT# be the vCard 4
|
1271
|
+
namespace (`"urn:ietf:params:xml:ns:vcard-4.0"`). (This implies
|
1272
|
+
that it cannot duplicate a standard vCard property.) The element
|
1273
|
+
is to be interpreted as if it was contained in a <vcard> element,
|
1274
|
+
as defined in cite:[RFC6351].
|
1275
|
+
+
|
1276
|
+
The fragment is subject to normal line folding and escaping, i.e.,
|
1277
|
+
replace all backslashes with `"\\"`, then replace all newlines with
|
1278
|
+
`"\n"`, then fold long lines.
|
1279
|
+
+
|
1280
|
+
Support for this property is [bcp14]#OPTIONAL#, but implementations of this
|
1281
|
+
specification [bcp14]#MUST# preserve instances of this property when
|
1282
|
+
propagating vCards.
|
1283
|
+
+
|
1284
|
+
See cite:[RFC6351] for more information on the intended use of this
|
1285
|
+
property.
|
1286
|
+
|
1287
|
+
ABNF::
|
1288
|
+
+
|
1289
|
+
[source,abnf]
|
1290
|
+
----
|
1291
|
+
XML-param = "VALUE=text" / altid-param
|
1292
|
+
XML-value = text
|
1293
|
+
----
|
1294
|
+
|
1295
|
+
[[section6_2]]
|
1296
|
+
=== Identification Properties
|
1297
|
+
|
1298
|
+
These types are used to capture information associated with the
|
1299
|
+
identification and naming of the entity associated with the vCard.
|
1300
|
+
|
1301
|
+
[[section6_2_1]]
|
1302
|
+
==== FN
|
1303
|
+
|
1304
|
+
Purpose:: To specify the formatted text corresponding to the name of
|
1305
|
+
the object the vCard represents.
|
1306
|
+
|
1307
|
+
Value type:: A single text value.
|
1308
|
+
|
1309
|
+
Cardinality:: 1*
|
1310
|
+
|
1311
|
+
Special notes:: This property is based on the semantics of the X.520
|
1312
|
+
Common Name attribute cite:[CCITT.X520.1988]. The property [bcp14]#MUST# be
|
1313
|
+
present in the vCard object.
|
1314
|
+
|
1315
|
+
ABNF:
|
1316
|
+
+
|
1317
|
+
[source,abnf]
|
1318
|
+
----
|
1319
|
+
FN-param = "VALUE=text" / type-param / language-param / altid-param
|
1320
|
+
/ pid-param / pref-param / any-param
|
1321
|
+
FN-value = text
|
1322
|
+
----
|
1323
|
+
|
1324
|
+
Example:
|
1325
|
+
+
|
1326
|
+
....
|
1327
|
+
FN:Mr. John Q. Public\, Esq.
|
1328
|
+
....
|
1329
|
+
|
1330
|
+
[[section6_2_2]]
|
1331
|
+
==== N
|
1332
|
+
|
1333
|
+
Purpose:: To specify the components of the name of the object the
|
1334
|
+
vCard represents.
|
1335
|
+
|
1336
|
+
Value type:: A single structured text value. Each component can have
|
1337
|
+
multiple values.
|
1338
|
+
|
1339
|
+
Cardinality:: *1
|
1340
|
+
|
1341
|
+
Special note:: The structured property value corresponds, in
|
1342
|
+
sequence, to the Family Names (also known as surnames), Given
|
1343
|
+
Names, Additional Names, Honorific Prefixes, and Honorific
|
1344
|
+
Suffixes. The text components are separated by the `SEMICOLON`
|
1345
|
+
character (`U+003B`). Individual text components can include
|
1346
|
+
multiple text values separated by the `COMMA` character (`U+002C`).
|
1347
|
+
This property is based on the semantics of the X.520 individual
|
1348
|
+
name attributes cite:[CCITT.X520.1988]. The property [bcp14]#SHOULD# be present
|
1349
|
+
in the vCard object when the name of the object the vCard
|
1350
|
+
represents follows the X.520 model.
|
1351
|
+
+
|
1352
|
+
The `SORT-AS` parameter [bcp14]#MAY# be applied to this property.
|
1353
|
+
|
1354
|
+
|
1355
|
+
ABNF::
|
1356
|
+
+
|
1357
|
+
[source,abnf]
|
1358
|
+
----
|
1359
|
+
N-param = "VALUE=text" / sort-as-param / language-param
|
1360
|
+
/ altid-param / any-param
|
1361
|
+
N-value = list-component 4(";" list-component)
|
1362
|
+
----
|
1363
|
+
|
1364
|
+
Examples:
|
1365
|
+
+
|
1366
|
+
....
|
1367
|
+
N:Public;John;Quinlan;Mr.;Esq.
|
1368
|
+
|
1369
|
+
N:Stevenson;John;Philip,Paul;Dr.;Jr.,M.D.,A.C.P.
|
1370
|
+
....
|
1371
|
+
|
1372
|
+
[[section6_2_3]]
|
1373
|
+
==== NICKNAME
|
1374
|
+
|
1375
|
+
Purpose:: To specify the text corresponding to the nickname of the
|
1376
|
+
object the vCard represents.
|
1377
|
+
|
1378
|
+
Value type:: One or more text values separated by a `COMMA` character
|
1379
|
+
(`U+002C`).
|
1380
|
+
|
1381
|
+
Cardinality:: *
|
1382
|
+
|
1383
|
+
Special note:: The nickname is the descriptive name given instead of
|
1384
|
+
or in addition to the one belonging to the object the vCard
|
1385
|
+
represents. It can also be used to specify a familiar form of a
|
1386
|
+
proper name specified by the FN or N properties.
|
1387
|
+
|
1388
|
+
ABNF::
|
1389
|
+
+
|
1390
|
+
[source,abnf]
|
1391
|
+
----
|
1392
|
+
NICKNAME-param = "VALUE=text" / type-param / language-param
|
1393
|
+
/ altid-param / pid-param / pref-param / any-param
|
1394
|
+
NICKNAME-value = text-list
|
1395
|
+
----
|
1396
|
+
|
1397
|
+
Examples:
|
1398
|
+
+
|
1399
|
+
....
|
1400
|
+
NICKNAME:Robbie
|
1401
|
+
|
1402
|
+
NICKNAME:Jim,Jimmie
|
1403
|
+
|
1404
|
+
NICKNAME;TYPE=work:Boss
|
1405
|
+
....
|
1406
|
+
|
1407
|
+
[[section6_2_4]]
|
1408
|
+
==== PHOTO
|
1409
|
+
|
1410
|
+
Purpose:: To specify an image or photograph information that
|
1411
|
+
annotates some aspect of the object the vCard represents.
|
1412
|
+
|
1413
|
+
Value type:: A single URI.
|
1414
|
+
|
1415
|
+
Cardinality:: *
|
1416
|
+
|
1417
|
+
ABNF::
|
1418
|
+
+
|
1419
|
+
[source,abnf]
|
1420
|
+
----
|
1421
|
+
PHOTO-param = "VALUE=uri" / altid-param / type-param
|
1422
|
+
/ mediatype-param / pref-param / pid-param / any-param
|
1423
|
+
PHOTO-value = URI
|
1424
|
+
----
|
1425
|
+
|
1426
|
+
Examples::
|
1427
|
+
+
|
1428
|
+
....
|
1429
|
+
PHOTO:http://www.example.com/pub/photos/jqpublic.gif
|
1430
|
+
|
1431
|
+
PHOTO:data:image/jpeg;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhv
|
1432
|
+
AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
|
1433
|
+
ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
|
1434
|
+
<...remainder of base64-encoded data...>
|
1435
|
+
....
|
1436
|
+
|
1437
|
+
[[section6_2_5]]
|
1438
|
+
==== BDAY
|
1439
|
+
|
1440
|
+
Purpose:: To specify the birth date of the object the vCard
|
1441
|
+
represents.
|
1442
|
+
|
1443
|
+
Value type:: The default is a single date-and-or-time value. It can
|
1444
|
+
also be reset to a single text value.
|
1445
|
+
|
1446
|
+
Cardinality:" *1
|
1447
|
+
|
1448
|
+
ABNF:
|
1449
|
+
+
|
1450
|
+
[source,abnf]
|
1451
|
+
----
|
1452
|
+
BDAY-param = BDAY-param-date / BDAY-param-text
|
1453
|
+
BDAY-value = date-and-or-time / text
|
1454
|
+
; Value and parameter [bcp14]#MUST# match.
|
1455
|
+
|
1456
|
+
BDAY-param-date = "VALUE=date-and-or-time"
|
1457
|
+
BDAY-param-text = "VALUE=text" / language-param
|
1458
|
+
|
1459
|
+
BDAY-param =/ altid-param / calscale-param / any-param
|
1460
|
+
; calscale-param can only be present when BDAY-value is
|
1461
|
+
; date-and-or-time and actually contains a date or date-time.
|
1462
|
+
----
|
1463
|
+
|
1464
|
+
Examples::
|
1465
|
+
+
|
1466
|
+
....
|
1467
|
+
BDAY:19960415
|
1468
|
+
BDAY:--0415
|
1469
|
+
BDAY;19531015T231000Z
|
1470
|
+
BDAY;VALUE=text:circa 1800
|
1471
|
+
....
|
1472
|
+
|
1473
|
+
[[section6_2_6]]
|
1474
|
+
==== ANNIVERSARY
|
1475
|
+
|
1476
|
+
Purpose:: The date of marriage, or equivalent, of the object the
|
1477
|
+
vCard represents.
|
1478
|
+
|
1479
|
+
Value type:: The default is a single date-and-or-time value. It can
|
1480
|
+
also be reset to a single text value.
|
1481
|
+
|
1482
|
+
Cardinality:: *1
|
1483
|
+
|
1484
|
+
ABNF:
|
1485
|
+
+
|
1486
|
+
[source,abnf]
|
1487
|
+
----
|
1488
|
+
ANNIVERSARY-param = "VALUE=" ("date-and-or-time" / "text")
|
1489
|
+
ANNIVERSARY-value = date-and-or-time / text
|
1490
|
+
; Value and parameter [bcp14]#MUST# match.
|
1491
|
+
|
1492
|
+
ANNIVERSARY-param =/ altid-param / calscale-param / any-param
|
1493
|
+
; calscale-param can only be present when ANNIVERSARY-value is
|
1494
|
+
; date-and-or-time and actually contains a date or date-time.
|
1495
|
+
----
|
1496
|
+
|
1497
|
+
Examples:
|
1498
|
+
+
|
1499
|
+
....
|
1500
|
+
ANNIVERSARY:19960415
|
1501
|
+
....
|
1502
|
+
|
1503
|
+
|
1504
|
+
[[section6_2_7]]
|
1505
|
+
==== GENDER
|
1506
|
+
|
1507
|
+
Purpose:: To specify the components of the sex and gender identity of
|
1508
|
+
the object the vCard represents.
|
1509
|
+
|
1510
|
+
Value type:: A single structured value with two components. Each
|
1511
|
+
component has a single text value.
|
1512
|
+
|
1513
|
+
Cardinality:: *1
|
1514
|
+
|
1515
|
+
Special notes:: The components correspond, in sequence, to the sex
|
1516
|
+
(biological), and gender identity. Each component is optional.
|
1517
|
+
|
1518
|
+
Sex component::: A single letter. `M` stands for "male", `F` stands
|
1519
|
+
for "female", `O` stands for "other", `N` stands for "none or not
|
1520
|
+
applicable", `U` stands for "unknown".
|
1521
|
+
|
1522
|
+
Gender identity component::: Free-form text.
|
1523
|
+
|
1524
|
+
ABNF::
|
1525
|
+
+
|
1526
|
+
[source,abnf]
|
1527
|
+
----
|
1528
|
+
GENDER-param = "VALUE=text" / any-param
|
1529
|
+
GENDER-value = sex [";" text]
|
1530
|
+
|
1531
|
+
sex = "" / "M" / "F" / "O" / "N" / "U"
|
1532
|
+
----
|
1533
|
+
|
1534
|
+
Examples:
|
1535
|
+
+
|
1536
|
+
....
|
1537
|
+
GENDER:M
|
1538
|
+
GENDER:F
|
1539
|
+
GENDER:M;Fellow
|
1540
|
+
GENDER:F;grrrl
|
1541
|
+
GENDER:O;intersex
|
1542
|
+
GENDER:;it's complicated
|
1543
|
+
....
|
1544
|
+
|
1545
|
+
[[section6_3]]
|
1546
|
+
=== Delivery Addressing Properties
|
1547
|
+
|
1548
|
+
These types are concerned with information related to the delivery
|
1549
|
+
addressing or label for the vCard object.
|
1550
|
+
|
1551
|
+
[[section6_3_1]]
|
1552
|
+
==== ADR
|
1553
|
+
|
1554
|
+
Purpose:: To specify the components of the delivery address for the
|
1555
|
+
vCard object.
|
1556
|
+
|
1557
|
+
Value type:: A single structured text value, separated by the
|
1558
|
+
`SEMICOLON` character (`U+003B`).
|
1559
|
+
|
1560
|
+
Cardinality:: *
|
1561
|
+
|
1562
|
+
Special notes:: The structured type value consists of a sequence of
|
1563
|
+
address components. The component values [bcp14]#MUST# be specified in
|
1564
|
+
their corresponding position. The structured type value
|
1565
|
+
corresponds, in sequence, to
|
1566
|
+
+
|
1567
|
+
* the post office box;
|
1568
|
+
* the extended address (e.g., apartment or suite number);
|
1569
|
+
* the street address;
|
1570
|
+
* the locality (e.g., city);
|
1571
|
+
* the region (e.g., state or province);
|
1572
|
+
* the postal code;
|
1573
|
+
* the country name (full name in the language specified in
|
1574
|
+
<<section5_1,Section 5.1>>).
|
1575
|
+
|
1576
|
+
+
|
1577
|
+
When a component value is missing, the associated component
|
1578
|
+
separator [bcp14]#MUST# still be specified.
|
1579
|
+
|
1580
|
+
Experience with vCard 3 has shown that the first two components
|
1581
|
+
(post office box and extended address) are plagued with many
|
1582
|
+
interoperability issues. To ensure maximal interoperability,
|
1583
|
+
their values [bcp14]#SHOULD# be empty.
|
1584
|
+
|
1585
|
+
The text components are separated by the `SEMICOLON` character
|
1586
|
+
(`U+003B`). Where it makes semantic sense, individual text
|
1587
|
+
components can include multiple text values (e.g., a "street"
|
1588
|
+
component with multiple lines) separated by the `COMMA` character
|
1589
|
+
(`U+002C`).
|
1590
|
+
|
1591
|
+
The property can include the `"PREF"` parameter to indicate the
|
1592
|
+
preferred delivery address when more than one address is
|
1593
|
+
specified.
|
1594
|
+
|
1595
|
+
The `GEO` and `TZ` parameters [bcp14]#MAY# be used with this property.
|
1596
|
+
|
1597
|
+
The property can also include a `"LABEL"` parameter to present a
|
1598
|
+
delivery address label for the address. Its value is a plain-text
|
1599
|
+
string representing the formatted address. Newlines are encoded
|
1600
|
+
as `\n`, as they are for property values.
|
1601
|
+
|
1602
|
+
ABNF::
|
1603
|
+
+
|
1604
|
+
[source,abnf]
|
1605
|
+
----
|
1606
|
+
label-param = "LABEL=" param-value
|
1607
|
+
|
1608
|
+
ADR-param = "VALUE=text" / label-param / language-param
|
1609
|
+
/ geo-parameter / tz-parameter / altid-param / pid-param
|
1610
|
+
/ pref-param / type-param / any-param
|
1611
|
+
|
1612
|
+
ADR-value = ADR-component-pobox ";" ADR-component-ext ";"
|
1613
|
+
ADR-component-street ";" ADR-component-locality ";"
|
1614
|
+
ADR-component-region ";" ADR-component-code ";"
|
1615
|
+
ADR-component-country
|
1616
|
+
ADR-component-pobox = list-component
|
1617
|
+
ADR-component-ext = list-component
|
1618
|
+
ADR-component-street = list-component
|
1619
|
+
ADR-component-locality = list-component
|
1620
|
+
ADR-component-region = list-component
|
1621
|
+
ADR-component-code = list-component
|
1622
|
+
ADR-component-country = list-component
|
1623
|
+
----
|
1624
|
+
|
1625
|
+
Example:: In this example, the post office box and the extended
|
1626
|
+
address are absent.
|
1627
|
+
+
|
1628
|
+
....
|
1629
|
+
ADR;GEO="geo:12.3457,78.910";LABEL="Mr. John Q. Public, Esq.\n
|
1630
|
+
Mail Drop: TNE QB\n123 Main Street\nAny Town, CA 91921-1234\n
|
1631
|
+
U.S.A.":;;123 Main Street;Any Town;CA;91921-1234;U.S.A.
|
1632
|
+
....
|
1633
|
+
|
1634
|
+
[[section6_4]]
|
1635
|
+
=== Communications Properties
|
1636
|
+
|
1637
|
+
These properties describe information about how to communicate with
|
1638
|
+
the object the vCard represents.
|
1639
|
+
|
1640
|
+
[[section6_4_1]]
|
1641
|
+
==== TEL
|
1642
|
+
|
1643
|
+
Purpose:: To specify the telephone number for telephony communication
|
1644
|
+
with the object the vCard represents.
|
1645
|
+
|
1646
|
+
Value type:: By default, it is a single free-form text value (for
|
1647
|
+
backward compatibility with vCard 3), but it [bcp14]#SHOULD# be reset to a
|
1648
|
+
URI value. It is expected that the URI scheme will be "tel", as
|
1649
|
+
specified in cite:[RFC3966], but other schemes [bcp14]#MAY# be used.
|
1650
|
+
|
1651
|
+
Cardinality:: *
|
1652
|
+
|
1653
|
+
Special notes:: This property is based on the X.520 Telephone Number
|
1654
|
+
attribute cite:[CCITT.X520.1988].
|
1655
|
+
+
|
1656
|
+
The property can include the "PREF" parameter to indicate a
|
1657
|
+
preferred-use telephone number.
|
1658
|
+
+
|
1659
|
+
The property can include the parameter "TYPE" to specify intended
|
1660
|
+
use for the telephone number. The predefined values for the TYPE
|
1661
|
+
parameter are:
|
1662
|
+
|
1663
|
+
<!-- can't nest tables in definition lists -->
|
1664
|
+
[cols="2"]
|
1665
|
+
|===
|
1666
|
+
| Value | Description
|
1667
|
+
|
1668
|
+
| text | Indicates that the telephone number supports text messages (SMS).
|
1669
|
+
| voice | Indicates a voice telephone number.
|
1670
|
+
| fax | Indicates a facsimile telephone number.
|
1671
|
+
| cell | Indicates a cellular or mobile telephone number.
|
1672
|
+
| video | Indicates a video conferencing telephone number.
|
1673
|
+
| pager | Indicates a paging device telephone number.
|
1674
|
+
| textphone
|
1675
|
+
| Indicates a telecommunication device for people with hearing or speech difficulties.
|
1676
|
+
|===
|
1677
|
+
|
1678
|
+
The default type is "voice". These type parameter values can be
|
1679
|
+
specified as a parameter list (e.g., `TYPE=text;TYPE=voice`) or as a
|
1680
|
+
value list (e.g., `TYPE="text,voice"`). The default can be
|
1681
|
+
overridden to another set of values by specifying one or more
|
1682
|
+
alternate values. For example, the default TYPE of "voice" can be
|
1683
|
+
reset to a `VOICE` and `FAX` telephone number by the value list
|
1684
|
+
`TYPE="voice,fax"`.
|
1685
|
+
|
1686
|
+
If this property's value is a URI that can also be used for
|
1687
|
+
instant messaging, the `IMPP` (<<section6_4_3,Section 6.4.3>>) property [bcp14]#SHOULD# be
|
1688
|
+
used in addition to this property.
|
1689
|
+
|
1690
|
+
ABNF::
|
1691
|
+
+
|
1692
|
+
[source,abnf]
|
1693
|
+
----
|
1694
|
+
TEL-param = TEL-text-param / TEL-uri-param
|
1695
|
+
TEL-value = TEL-text-value / TEL-uri-value
|
1696
|
+
; Value and parameter [bcp14]#MUST# match.
|
1697
|
+
|
1698
|
+
TEL-text-param = "VALUE=text"
|
1699
|
+
TEL-text-value = text
|
1700
|
+
|
1701
|
+
TEL-uri-param = "VALUE=uri" / mediatype-param
|
1702
|
+
TEL-uri-value = URI
|
1703
|
+
|
1704
|
+
TEL-param =/ type-param / pid-param / pref-param / altid-param
|
1705
|
+
/ any-param
|
1706
|
+
|
1707
|
+
type-param-tel = "text" / "voice" / "fax" / "cell" / "video"
|
1708
|
+
/ "pager" / "textphone" / iana-token / x-name
|
1709
|
+
; type-param-tel [bcp14]#MUST NOT# be used with a property other than TEL.
|
1710
|
+
|
1711
|
+
----
|
1712
|
+
|
1713
|
+
Example::
|
1714
|
+
+
|
1715
|
+
....
|
1716
|
+
TEL;VALUE=uri;PREF=1;TYPE="voice,home":tel:+1-555-555-5555;ext=5555
|
1717
|
+
TEL;VALUE=uri;TYPE=home:tel:+33-01-23-45-67
|
1718
|
+
....
|
1719
|
+
|
1720
|
+
[[section6_4_2]]
|
1721
|
+
==== EMAIL
|
1722
|
+
|
1723
|
+
Purpose:: To specify the electronic mail address for communication
|
1724
|
+
with the object the vCard represents.
|
1725
|
+
|
1726
|
+
Value type:: A single text value.
|
1727
|
+
|
1728
|
+
Cardinality:: *
|
1729
|
+
|
1730
|
+
Special notes:: The property can include tye `"PREF"` parameter to
|
1731
|
+
indicate a preferred-use email address when more than one is
|
1732
|
+
specified.
|
1733
|
+
+
|
1734
|
+
Even though the value is free-form UTF-8 text, it is likely to be
|
1735
|
+
interpreted by a Mail User Agent (MUA) as an "addr-spec", as
|
1736
|
+
defined in <<RFC5322,3.4.1 comma>>. Readers should also be aware
|
1737
|
+
of the current work toward internationalized email addresses
|
1738
|
+
cite:[RFC5335bis].
|
1739
|
+
|
1740
|
+
ABNF::
|
1741
|
+
+
|
1742
|
+
[source,abnf]
|
1743
|
+
----
|
1744
|
+
EMAIL-param = "VALUE=text" / pid-param / pref-param / type-param
|
1745
|
+
/ altid-param / any-param
|
1746
|
+
EMAIL-value = text
|
1747
|
+
----
|
1748
|
+
|
1749
|
+
Example::
|
1750
|
+
+
|
1751
|
+
....
|
1752
|
+
EMAIL;TYPE=work:jqpublic@xyz.example.com
|
1753
|
+
|
1754
|
+
EMAIL;PREF=1:jane_doe@example.com
|
1755
|
+
....
|
1756
|
+
|
1757
|
+
[[section6_4_3]]
|
1758
|
+
==== IMPP
|
1759
|
+
|
1760
|
+
Purpose:: To specify the URI for instant messaging and presence
|
1761
|
+
protocol communications with the object the vCard represents.
|
1762
|
+
|
1763
|
+
Value type:: A single URI.
|
1764
|
+
|
1765
|
+
Cardinality:: *
|
1766
|
+
|
1767
|
+
Special notes:: The property may include the `"PREF"` parameter to
|
1768
|
+
indicate that this is a preferred address and has the same
|
1769
|
+
semantics as the `"PREF"` parameter in a `TEL` property.
|
1770
|
+
+
|
1771
|
+
If this property's value is a URI that can be used for voice
|
1772
|
+
and/or video, the TEL property (<<section6_4_1,Section 6.4.1>>) [bcp14]#SHOULD# be used in
|
1773
|
+
addition to this property.
|
1774
|
+
+
|
1775
|
+
This property is adapted from cite:[RFC4770], which is made obsolete by
|
1776
|
+
this document.
|
1777
|
+
|
1778
|
+
ABNF::
|
1779
|
+
+
|
1780
|
+
[source,abnf]
|
1781
|
+
----
|
1782
|
+
IMPP-param = "VALUE=uri" / pid-param / pref-param / type-param
|
1783
|
+
/ mediatype-param / altid-param / any-param
|
1784
|
+
IMPP-value = URI
|
1785
|
+
----
|
1786
|
+
|
1787
|
+
Example::
|
1788
|
+
+
|
1789
|
+
....
|
1790
|
+
IMPP;PREF=1:xmpp:alice@example.com
|
1791
|
+
....
|
1792
|
+
|
1793
|
+
[[section6_4_4]]
|
1794
|
+
==== LANG
|
1795
|
+
|
1796
|
+
Purpose:: To specify the language(s) that may be used for contacting
|
1797
|
+
the entity associated with the vCard.
|
1798
|
+
|
1799
|
+
Value type:: A single language-tag value.
|
1800
|
+
|
1801
|
+
Cardinality:: *
|
1802
|
+
|
1803
|
+
ABNF::
|
1804
|
+
+
|
1805
|
+
[source,abnf]
|
1806
|
+
----
|
1807
|
+
LANG-param = "VALUE=language-tag" / pid-param / pref-param
|
1808
|
+
/ altid-param / type-param / any-param
|
1809
|
+
LANG-value = Language-Tag
|
1810
|
+
----
|
1811
|
+
|
1812
|
+
Example::
|
1813
|
+
+
|
1814
|
+
....
|
1815
|
+
LANG;TYPE=work;PREF=1:en
|
1816
|
+
LANG;TYPE=work;PREF=2:fr
|
1817
|
+
LANG;TYPE=home:fr
|
1818
|
+
....
|
1819
|
+
|
1820
|
+
[[section6_5]]
|
1821
|
+
=== Geographical Properties
|
1822
|
+
|
1823
|
+
These properties are concerned with information associated with
|
1824
|
+
geographical positions or regions associated with the object the
|
1825
|
+
vCard represents.
|
1826
|
+
|
1827
|
+
[[section6_5_1]]
|
1828
|
+
==== TZ
|
1829
|
+
|
1830
|
+
Purpose:: To specify information related to the time zone of the
|
1831
|
+
object the vCard represents.
|
1832
|
+
|
1833
|
+
Value type:: The default is a single text value. It can also be
|
1834
|
+
reset to a single URI or utc-offset value.
|
1835
|
+
|
1836
|
+
Cardinality:: *
|
1837
|
+
|
1838
|
+
Special notes:: It is expected that names from the public-domain
|
1839
|
+
Olson database cite:[TZ-DB] will be used, but this is not a
|
1840
|
+
restriction. See also cite:[IANA-TZ].
|
1841
|
+
+
|
1842
|
+
Efforts are currently being directed at creating a standard URI
|
1843
|
+
scheme for expressing time zone information. Usage of such a
|
1844
|
+
scheme would ensure a high level of interoperability between
|
1845
|
+
implementations that support it.
|
1846
|
+
+
|
1847
|
+
Note that utc-offset values [bcp14]#SHOULD NOT# be used because the UTC
|
1848
|
+
offset varies with time -- not just because of the usual daylight
|
1849
|
+
saving time shifts that occur in may regions, but often entire
|
1850
|
+
regions will "re-base" their overall offset. The actual offset
|
1851
|
+
may be +/- 1 hour (or perhaps a little more) than the one given.
|
1852
|
+
|
1853
|
+
ABNF::
|
1854
|
+
+
|
1855
|
+
[source,abnf]
|
1856
|
+
----
|
1857
|
+
TZ-param = "VALUE=" ("text" / "uri" / "utc-offset")
|
1858
|
+
TZ-value = text / URI / utc-offset
|
1859
|
+
; Value and parameter [bcp14]#MUST# match.
|
1860
|
+
|
1861
|
+
TZ-param =/ altid-param / pid-param / pref-param / type-param
|
1862
|
+
/ mediatype-param / any-param
|
1863
|
+
----
|
1864
|
+
|
1865
|
+
Examples::
|
1866
|
+
+
|
1867
|
+
....
|
1868
|
+
TZ:Raleigh/North America
|
1869
|
+
|
1870
|
+
TZ;VALUE=utc-offset:-0500
|
1871
|
+
; Note: utc-offset format is NOT RECOMMENDED.
|
1872
|
+
....
|
1873
|
+
|
1874
|
+
[[section6_5_2]]
|
1875
|
+
==== GEO
|
1876
|
+
|
1877
|
+
Purpose:: To specify information related to the global positioning of
|
1878
|
+
the object the vCard represents.
|
1879
|
+
|
1880
|
+
Value type:: A single URI.
|
1881
|
+
|
1882
|
+
Cardinality": *
|
1883
|
+
|
1884
|
+
Special notes:: The "geo" URI scheme cite:[RFC5870] is particularly well
|
1885
|
+
suited for this property, but other schemes [bcp14]#MAY# be used.
|
1886
|
+
|
1887
|
+
|
1888
|
+
ABNF::
|
1889
|
+
+
|
1890
|
+
[source,abnf]
|
1891
|
+
----
|
1892
|
+
GEO-param = "VALUE=uri" / pid-param / pref-param / type-param
|
1893
|
+
/ mediatype-param / altid-param / any-param
|
1894
|
+
GEO-value = URI
|
1895
|
+
----
|
1896
|
+
|
1897
|
+
Example::
|
1898
|
+
+
|
1899
|
+
....
|
1900
|
+
GEO:geo:37.386013,-122.082932
|
1901
|
+
....
|
1902
|
+
|
1903
|
+
[[section6_6]]
|
1904
|
+
== Organizational Properties
|
1905
|
+
|
1906
|
+
These properties are concerned with information associated with
|
1907
|
+
characteristics of the organization or organizational units of the
|
1908
|
+
object that the vCard represents.
|
1909
|
+
|
1910
|
+
[[section6_6_1]]
|
1911
|
+
=== TITLE
|
1912
|
+
|
1913
|
+
Purpose:: To specify the position or job of the object the vCard
|
1914
|
+
represents.
|
1915
|
+
|
1916
|
+
Value type:: A single text value.
|
1917
|
+
|
1918
|
+
Cardinality: *
|
1919
|
+
|
1920
|
+
Special notes:: This property is based on the X.520 Title attribute
|
1921
|
+
cite:[CCITT.X520.1988].
|
1922
|
+
|
1923
|
+
ABNF::
|
1924
|
+
+
|
1925
|
+
[source,abnf]
|
1926
|
+
----
|
1927
|
+
TITLE-param = "VALUE=text" / language-param / pid-param
|
1928
|
+
/ pref-param / altid-param / type-param / any-param
|
1929
|
+
TITLE-value = text
|
1930
|
+
----
|
1931
|
+
|
1932
|
+
Example::
|
1933
|
+
+
|
1934
|
+
....
|
1935
|
+
TITLE:Research Scientist
|
1936
|
+
....
|
1937
|
+
|
1938
|
+
[[section6_6_2]]
|
1939
|
+
==== ROLE
|
1940
|
+
|
1941
|
+
Purpose:: To specify the function or part played in a particular
|
1942
|
+
situation by the object the vCard represents.
|
1943
|
+
|
1944
|
+
Value type:: A single text value.
|
1945
|
+
|
1946
|
+
Cardinality:: *
|
1947
|
+
|
1948
|
+
Special notes: This property is based on the X.520 Business Category
|
1949
|
+
explanatory attribute cite:[CCITT.X520.1988]. This property is
|
1950
|
+
included as an organizational type to avoid confusion with the
|
1951
|
+
semantics of the `TITLE` property and incorrect usage of that
|
1952
|
+
property when the semantics of this property is intended.
|
1953
|
+
|
1954
|
+
ABNF::
|
1955
|
+
+
|
1956
|
+
[source,abnf]
|
1957
|
+
----
|
1958
|
+
ROLE-param = "VALUE=text" / language-param / pid-param / pref-param
|
1959
|
+
/ type-param / altid-param / any-param
|
1960
|
+
ROLE-value = text
|
1961
|
+
----
|
1962
|
+
|
1963
|
+
Example::
|
1964
|
+
+
|
1965
|
+
....
|
1966
|
+
ROLE:Project Leader
|
1967
|
+
....
|
1968
|
+
|
1969
|
+
[[section6_6_3]]
|
1970
|
+
==== LOGO
|
1971
|
+
|
1972
|
+
Purpose:: To specify a graphic image of a logo associated with the
|
1973
|
+
object the vCard represents.
|
1974
|
+
|
1975
|
+
Value type:: A single URI.
|
1976
|
+
|
1977
|
+
Cardinality:: *
|
1978
|
+
|
1979
|
+
ABNF::
|
1980
|
+
+
|
1981
|
+
[source,abnf]
|
1982
|
+
----
|
1983
|
+
LOGO-param = "VALUE=uri" / language-param / pid-param / pref-param
|
1984
|
+
/ type-param / mediatype-param / altid-param / any-param
|
1985
|
+
LOGO-value = URI
|
1986
|
+
----
|
1987
|
+
|
1988
|
+
Examples::
|
1989
|
+
+
|
1990
|
+
....
|
1991
|
+
LOGO:http://www.example.com/pub/logos/abccorp.jpg
|
1992
|
+
|
1993
|
+
LOGO:data:image/jpeg;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIhvc
|
1994
|
+
AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
|
1995
|
+
ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
|
1996
|
+
<...the remainder of base64-encoded data...>
|
1997
|
+
....
|
1998
|
+
|
1999
|
+
[[section6_6_4]]
|
2000
|
+
==== ORG
|
2001
|
+
|
2002
|
+
Purpose:: To specify the organizational name and units associated
|
2003
|
+
with the vCard.
|
2004
|
+
|
2005
|
+
Value type:: A single structured text value consisting of components
|
2006
|
+
separated by the `SEMICOLON` character (`U+003B`).
|
2007
|
+
|
2008
|
+
Cardinality:: *
|
2009
|
+
|
2010
|
+
Special notes: The property is based on the X.520 Organization Name
|
2011
|
+
and Organization Unit attributes cite:[CCITT.X520.1988]. The property
|
2012
|
+
value is a structured type consisting of the organization name,
|
2013
|
+
followed by zero or more levels of organizational unit names.
|
2014
|
+
+
|
2015
|
+
The SORT-AS parameter [bcp14]#MAY# be applied to this property.
|
2016
|
+
|
2017
|
+
ABNF::
|
2018
|
+
+
|
2019
|
+
[source,abnf]
|
2020
|
+
----
|
2021
|
+
ORG-param = "VALUE=text" / sort-as-param / language-param
|
2022
|
+
/ pid-param / pref-param / altid-param / type-param
|
2023
|
+
/ any-param
|
2024
|
+
ORG-value = component *(";" component)
|
2025
|
+
----
|
2026
|
+
|
2027
|
+
Example: A property value consisting of an organizational name,
|
2028
|
+
organizational unit #1 name, and organizational unit #2 name.
|
2029
|
+
+
|
2030
|
+
....
|
2031
|
+
ORG:ABC\, Inc.;North American Division;Marketing
|
2032
|
+
....
|
2033
|
+
|
2034
|
+
[[section6_6_5]
|
2035
|
+
==== MEMBER
|
2036
|
+
|
2037
|
+
Purpose:: To include a member in the group this vCard represents.
|
2038
|
+
|
2039
|
+
Value type:: A single URI. It [bcp14]#MAY# refer to something other than a
|
2040
|
+
vCard object. For example, an email distribution list could
|
2041
|
+
employ the "mailto" URI scheme cite:[RFC6068] for efficiency.
|
2042
|
+
|
2043
|
+
Cardinality:: *
|
2044
|
+
|
2045
|
+
Special notes:: This property [bcp14]#MUST NOT# be present unless the value of
|
2046
|
+
the `KIND` property is "group".
|
2047
|
+
|
2048
|
+
ABNF::
|
2049
|
+
+
|
2050
|
+
[source,abnf]
|
2051
|
+
----
|
2052
|
+
MEMBER-param = "VALUE=uri" / pid-param / pref-param / altid-param
|
2053
|
+
/ mediatype-param / any-param
|
2054
|
+
MEMBER-value = URI
|
2055
|
+
----
|
2056
|
+
|
2057
|
+
Examples::
|
2058
|
+
+
|
2059
|
+
....
|
2060
|
+
BEGIN:VCARD
|
2061
|
+
VERSION:4.0
|
2062
|
+
KIND:group
|
2063
|
+
FN:The Doe family
|
2064
|
+
MEMBER:urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af
|
2065
|
+
MEMBER:urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519
|
2066
|
+
END:VCARD
|
2067
|
+
BEGIN:VCARD
|
2068
|
+
VERSION:4.0
|
2069
|
+
FN:John Doe
|
2070
|
+
UID:urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af
|
2071
|
+
END:VCARD
|
2072
|
+
BEGIN:VCARD
|
2073
|
+
VERSION:4.0
|
2074
|
+
FN:Jane Doe
|
2075
|
+
UID:urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519
|
2076
|
+
END:VCARD
|
2077
|
+
|
2078
|
+
BEGIN:VCARD
|
2079
|
+
VERSION:4.0
|
2080
|
+
KIND:group
|
2081
|
+
FN:Funky distribution list
|
2082
|
+
MEMBER:mailto:subscriber1@example.com
|
2083
|
+
MEMBER:xmpp:subscriber2@example.com
|
2084
|
+
MEMBER:sip:subscriber3@example.com
|
2085
|
+
MEMBER:tel:+1-418-555-5555
|
2086
|
+
END:VCARD
|
2087
|
+
....
|
2088
|
+
|
2089
|
+
[[section6_6_6]]
|
2090
|
+
==== RELATED
|
2091
|
+
|
2092
|
+
Purpose:: To specify a relationship between another entity and the
|
2093
|
+
entity represented by this vCard.
|
2094
|
+
|
2095
|
+
Value type:: A single URI. It can also be reset to a single text
|
2096
|
+
value. The text value can be used to specify textual information.
|
2097
|
+
|
2098
|
+
Cardinality:: *
|
2099
|
+
|
2100
|
+
Special notes:: The TYPE parameter [bcp14]#MAY# be used to characterize the
|
2101
|
+
related entity. It contains a comma-separated list of values that
|
2102
|
+
are registered with IANA as described in <<section10_2,Section 10.2>>. The
|
2103
|
+
registry is pre-populated with the values defined in cite:[xfn]. This
|
2104
|
+
document also specifies two additional values:
|
2105
|
+
|
2106
|
+
agent::: an entity who may sometimes act on behalf of the entity
|
2107
|
+
associated with the vCard.
|
2108
|
+
|
2109
|
+
emergency::: indicates an emergency contact
|
2110
|
+
|
2111
|
+
+
|
2112
|
+
ABNF::
|
2113
|
+
+
|
2114
|
+
[source,abnf]
|
2115
|
+
----
|
2116
|
+
RELATED-param = RELATED-param-uri / RELATED-param-text
|
2117
|
+
RELATED-value = URI / text
|
2118
|
+
; Parameter and value [bcp14]#MUST# match.
|
2119
|
+
|
2120
|
+
RELATED-param-uri = "VALUE=uri" / mediatype-param
|
2121
|
+
RELATED-param-text = "VALUE=text" / language-param
|
2122
|
+
|
2123
|
+
RELATED-param =/ pid-param / pref-param / altid-param / type-param
|
2124
|
+
/ any-param
|
2125
|
+
|
2126
|
+
type-param-related = related-type-value *("," related-type-value)
|
2127
|
+
; type-param-related [bcp14]#MUST NOT# be used with a property other than
|
2128
|
+
; RELATED.
|
2129
|
+
|
2130
|
+
related-type-value = "contact" / "acquaintance" / "friend" / "met"
|
2131
|
+
/ "co-worker" / "colleague" / "co-resident"
|
2132
|
+
/ "neighbor" / "child" / "parent"
|
2133
|
+
/ "sibling" / "spouse" / "kin" / "muse"
|
2134
|
+
/ "crush" / "date" / "sweetheart" / "me"
|
2135
|
+
/ "agent" / "emergency"
|
2136
|
+
----
|
2137
|
+
|
2138
|
+
Examples::
|
2139
|
+
+
|
2140
|
+
....
|
2141
|
+
RELATED;TYPE=friend:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
|
2142
|
+
RELATED;TYPE=contact:http://example.com/directory/jdoe.vcf
|
2143
|
+
RELATED;TYPE=co-worker;VALUE=text:Please contact my assistant Jane
|
2144
|
+
Doe for any inquiries.
|
2145
|
+
....
|
2146
|
+
|
2147
|
+
[[section6_7]]
|
2148
|
+
=== Explanatory Properties
|
2149
|
+
|
2150
|
+
These properties are concerned with additional explanations, such as
|
2151
|
+
that related to informational notes or revisions specific to the
|
2152
|
+
vCard.
|
2153
|
+
|
2154
|
+
[[section6_7_1]]
|
2155
|
+
==== CATEGORIES
|
2156
|
+
|
2157
|
+
Purpose:: To specify application category information about the
|
2158
|
+
vCard, also known as "tags".
|
2159
|
+
|
2160
|
+
Value type:: One or more text values separated by a `COMMA` character
|
2161
|
+
(`U+002C`).
|
2162
|
+
|
2163
|
+
Cardinality:: *
|
2164
|
+
|
2165
|
+
ABNF:
|
2166
|
+
+
|
2167
|
+
[source,abnf]
|
2168
|
+
----
|
2169
|
+
CATEGORIES-param = "VALUE=text" / pid-param / pref-param
|
2170
|
+
/ type-param / altid-param / any-param
|
2171
|
+
CATEGORIES-value = text-list
|
2172
|
+
----
|
2173
|
+
|
2174
|
+
Example::
|
2175
|
+
+
|
2176
|
+
....
|
2177
|
+
CATEGORIES:TRAVEL AGENT
|
2178
|
+
|
2179
|
+
CATEGORIES:INTERNET,IETF,INDUSTRY,INFORMATION TECHNOLOGY
|
2180
|
+
....
|
2181
|
+
|
2182
|
+
[[section6_7_2]]
|
2183
|
+
==== NOTE
|
2184
|
+
|
2185
|
+
Purpose:: To specify supplemental information or a comment that is
|
2186
|
+
associated with the vCard.
|
2187
|
+
|
2188
|
+
Value type:: A single text value.
|
2189
|
+
|
2190
|
+
Cardinality:: *
|
2191
|
+
|
2192
|
+
Special notes: The property is based on the X.520 Description
|
2193
|
+
attribute cite:[CCITT.X520.1988].
|
2194
|
+
|
2195
|
+
ABNF::
|
2196
|
+
+
|
2197
|
+
[source,abnf]
|
2198
|
+
----
|
2199
|
+
NOTE-param = "VALUE=text" / language-param / pid-param / pref-param
|
2200
|
+
/ type-param / altid-param / any-param
|
2201
|
+
NOTE-value = text
|
2202
|
+
----
|
2203
|
+
|
2204
|
+
Example::
|
2205
|
+
+
|
2206
|
+
....
|
2207
|
+
NOTE:This fax number is operational 0800 to 1715
|
2208
|
+
EST\, Mon-Fri.
|
2209
|
+
....
|
2210
|
+
|
2211
|
+
[[section6_7_3]]
|
2212
|
+
==== PRODID
|
2213
|
+
|
2214
|
+
Purpose:: To specify the identifier for the product that created the
|
2215
|
+
vCard object.
|
2216
|
+
|
2217
|
+
Type value:: A single text value.
|
2218
|
+
|
2219
|
+
Cardinality:: *1
|
2220
|
+
|
2221
|
+
Special notes:: Implementations [bcp14]#SHOULD# use a method such as that
|
2222
|
+
specified for Formal Public Identifiers in cite:[ISO9070] or for
|
2223
|
+
Universal Resource Names in cite:[RFC3406] to ensure that the text
|
2224
|
+
value is unique.
|
2225
|
+
|
2226
|
+
ABNF::
|
2227
|
+
+
|
2228
|
+
[source,abnf]
|
2229
|
+
----
|
2230
|
+
PRODID-param = "VALUE=text" / any-param
|
2231
|
+
PRODID-value = text
|
2232
|
+
----
|
2233
|
+
|
2234
|
+
Example::
|
2235
|
+
+
|
2236
|
+
....
|
2237
|
+
PRODID:-//ONLINE DIRECTORY//NONSGML Version 1//EN
|
2238
|
+
....
|
2239
|
+
|
2240
|
+
[[section6_7_4]]
|
2241
|
+
==== REV
|
2242
|
+
|
2243
|
+
Purpose:: To specify revision information about the current vCard.
|
2244
|
+
|
2245
|
+
Value type:: A single timestamp value.
|
2246
|
+
|
2247
|
+
Cardinality:: *1
|
2248
|
+
|
2249
|
+
Special notes:: The value distinguishes the current revision of the
|
2250
|
+
information in this vCard for other renditions of the information.
|
2251
|
+
|
2252
|
+
ABNF::
|
2253
|
+
+
|
2254
|
+
[source,abnf]
|
2255
|
+
----
|
2256
|
+
REV-param = "VALUE=timestamp" / any-param
|
2257
|
+
REV-value = timestamp
|
2258
|
+
----
|
2259
|
+
|
2260
|
+
Example::
|
2261
|
+
+
|
2262
|
+
....
|
2263
|
+
REV:19951031T222710Z
|
2264
|
+
....
|
2265
|
+
|
2266
|
+
[[section6_7_5]]
|
2267
|
+
==== SOUND
|
2268
|
+
|
2269
|
+
Purpose:: To specify a digital sound content information that
|
2270
|
+
annotates some aspect of the vCard. This property is often used
|
2271
|
+
to specify the proper pronunciation of the name property value of
|
2272
|
+
the vCard.
|
2273
|
+
|
2274
|
+
Value type:: A single URI.
|
2275
|
+
|
2276
|
+
Cardinality": *
|
2277
|
+
|
2278
|
+
ABNF:
|
2279
|
+
+
|
2280
|
+
[source,abnf]
|
2281
|
+
----
|
2282
|
+
SOUND-param = "VALUE=uri" / language-param / pid-param / pref-param
|
2283
|
+
/ type-param / mediatype-param / altid-param
|
2284
|
+
/ any-param
|
2285
|
+
SOUND-value = URI
|
2286
|
+
----
|
2287
|
+
|
2288
|
+
Example::
|
2289
|
+
+
|
2290
|
+
....
|
2291
|
+
SOUND:CID:JOHNQPUBLIC.part8.19960229T080000.xyzMail@example.com
|
2292
|
+
|
2293
|
+
SOUND:data:audio/basic;base64,MIICajCCAdOgAwIBAgICBEUwDQYJKoZIh
|
2294
|
+
AQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bm
|
2295
|
+
ljYXRpb25zIENvcnBvcmF0aW9uMRwwGgYDVQQLExNJbmZvcm1hdGlvbiBTeXN0
|
2296
|
+
<...the remainder of base64-encoded data...>
|
2297
|
+
....
|
2298
|
+
|
2299
|
+
[[section6_7_6]]
|
2300
|
+
==== UID
|
2301
|
+
|
2302
|
+
Purpose:: To specify a value that represents a globally unique
|
2303
|
+
identifier corresponding to the entity associated with the vCard.
|
2304
|
+
|
2305
|
+
Value type:: A single URI value. It [bcp14]#MAY# also be reset to free-form
|
2306
|
+
text.
|
2307
|
+
|
2308
|
+
Cardinality:: *1
|
2309
|
+
|
2310
|
+
Special notes:: This property is used to uniquely identify the object
|
2311
|
+
that the vCard represents. The "uuid" URN namespace defined in
|
2312
|
+
cite:[RFC4122] is particularly well suited to this task, but other URI
|
2313
|
+
schemes [bcp14]#MAY# be used. Free-form text [bcp14]#MAY# also be used.
|
2314
|
+
|
2315
|
+
ABNF::
|
2316
|
+
+
|
2317
|
+
[source,abnf]
|
2318
|
+
----
|
2319
|
+
UID-param = UID-uri-param / UID-text-param
|
2320
|
+
UID-value = UID-uri-value / UID-text-value
|
2321
|
+
; Value and parameter [bcp14]#MUST# match.
|
2322
|
+
|
2323
|
+
UID-uri-param = "VALUE=uri"
|
2324
|
+
UID-uri-value = URI
|
2325
|
+
|
2326
|
+
UID-text-param = "VALUE=text"
|
2327
|
+
UID-text-value = text
|
2328
|
+
|
2329
|
+
UID-param =/ any-param
|
2330
|
+
----
|
2331
|
+
|
2332
|
+
Example::
|
2333
|
+
+
|
2334
|
+
....
|
2335
|
+
UID:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
|
2336
|
+
....
|
2337
|
+
|
2338
|
+
[[section6_7_7]]
|
2339
|
+
==== CLIENTPIDMAP
|
2340
|
+
|
2341
|
+
Purpose:: To give a global meaning to a local `PID` source identifier.
|
2342
|
+
|
2343
|
+
Value type:: A semicolon-separated pair of values. The first field
|
2344
|
+
is a small integer corresponding to the second field of a `PID`
|
2345
|
+
parameter instance. The second field is a URI. The "uuid" URN
|
2346
|
+
namespace defined in cite:[RFC4122] is particularly well suited to this
|
2347
|
+
task, but other URI schemes [bcp14]#MAY# be used.
|
2348
|
+
|
2349
|
+
Cardinality:: *
|
2350
|
+
|
2351
|
+
Special notes:: `PID` source identifiers (the source identifier is the
|
2352
|
+
second field in a `PID` parameter instance) are small integers that
|
2353
|
+
only have significance within the scope of a single vCard
|
2354
|
+
instance. Each distinct source identifier present in a vCard [bcp14]#MUST#
|
2355
|
+
have an associated `CLIENTPIDMAP`. See <<section7,Section 7>> for more details
|
2356
|
+
on the usage of `CLIENTPIDMAP`.
|
2357
|
+
+
|
2358
|
+
`PID` source identifiers [bcp14]#MUST# be strictly positive. Zero is not
|
2359
|
+
allowed.
|
2360
|
+
+
|
2361
|
+
As a special exception, the `PID` parameter [bcp14]#MUST NOT# be applied to
|
2362
|
+
this property.
|
2363
|
+
|
2364
|
+
ABNF::
|
2365
|
+
+
|
2366
|
+
[source,abnf]
|
2367
|
+
----
|
2368
|
+
CLIENTPIDMAP-param = any-param
|
2369
|
+
CLIENTPIDMAP-value = 1*DIGIT ";" URI
|
2370
|
+
----
|
2371
|
+
|
2372
|
+
Example::
|
2373
|
+
+
|
2374
|
+
....
|
2375
|
+
TEL;PID=3.1,4.2;VALUE=uri:tel:+1-555-555-5555
|
2376
|
+
EMAIL;PID=4.1,5.2:jdoe@example.com
|
2377
|
+
CLIENTPIDMAP:1;urn:uuid:3df403f4-5924-4bb7-b077-3c711d9eb34b
|
2378
|
+
CLIENTPIDMAP:2;urn:uuid:d89c9c7a-2e1b-4832-82de-7e992d95faa5
|
2379
|
+
....
|
2380
|
+
|
2381
|
+
6.7.8. URL
|
2382
|
+
|
2383
|
+
Purpose:: To specify a uniform resource locator associated with the
|
2384
|
+
object to which the vCard refers. Examples for individuals
|
2385
|
+
include personal web sites, blogs, and social networking site
|
2386
|
+
identifiers.
|
2387
|
+
|
2388
|
+
Cardinality:: *
|
2389
|
+
|
2390
|
+
Value type:: A single uri value.
|
2391
|
+
|
2392
|
+
ABNF:
|
2393
|
+
+
|
2394
|
+
[source,abnf]
|
2395
|
+
----
|
2396
|
+
URL-param = "VALUE=uri" / pid-param / pref-param / type-param
|
2397
|
+
/ mediatype-param / altid-param / any-param
|
2398
|
+
URL-value = URI
|
2399
|
+
----
|
2400
|
+
|
2401
|
+
Example::
|
2402
|
+
+
|
2403
|
+
....
|
2404
|
+
URL:http://example.org/restaurant.french/~chezchic.html
|
2405
|
+
....
|
2406
|
+
|
2407
|
+
[[section6_7_9]]
|
2408
|
+
==== VERSION
|
2409
|
+
|
2410
|
+
Purpose:: To specify the version of the vCard specification used to
|
2411
|
+
format this vCard.
|
2412
|
+
|
2413
|
+
Value type:: A single text value.
|
2414
|
+
|
2415
|
+
Cardinality:: 1
|
2416
|
+
|
2417
|
+
Special notes: This property [bcp14]#MUST# be present in the vCard object,
|
2418
|
+
and it must appear immediately after BEGIN:VCARD. The value [bcp14]#MUST#
|
2419
|
+
be `"4.0"` if the vCard corresponds to this specification. Note
|
2420
|
+
that earlier versions of vCard allowed this property to be placed
|
2421
|
+
anywhere in the vCard object, or even to be absent.
|
2422
|
+
|
2423
|
+
ABNF::
|
2424
|
+
+
|
2425
|
+
[source,abnf]
|
2426
|
+
----
|
2427
|
+
VERSION-param = "VALUE=text" / any-param
|
2428
|
+
VERSION-value = "4.0"
|
2429
|
+
----
|
2430
|
+
|
2431
|
+
Example::
|
2432
|
+
+
|
2433
|
+
....
|
2434
|
+
VERSION:4.0
|
2435
|
+
....
|
2436
|
+
|
2437
|
+
[[section6_8]]
|
2438
|
+
=== Security Properties
|
2439
|
+
|
2440
|
+
These properties are concerned with the security of communication
|
2441
|
+
pathways or access to the vCard.
|
2442
|
+
|
2443
|
+
[[section6_8_1]]
|
2444
|
+
==== KEY
|
2445
|
+
|
2446
|
+
Purpose:: To specify a public key or authentication certificate
|
2447
|
+
associated with the object that the vCard represents.
|
2448
|
+
|
2449
|
+
Value type:: A single URI. It can also be reset to a text value.
|
2450
|
+
|
2451
|
+
Cardinality:: *
|
2452
|
+
|
2453
|
+
ABNF:
|
2454
|
+
+
|
2455
|
+
[source,abnf]
|
2456
|
+
----
|
2457
|
+
KEY-param = KEY-uri-param / KEY-text-param
|
2458
|
+
KEY-value = KEY-uri-value / KEY-text-value
|
2459
|
+
; Value and parameter [bcp14]#MUST# match.
|
2460
|
+
|
2461
|
+
KEY-uri-param = "VALUE=uri" / mediatype-param
|
2462
|
+
KEY-uri-value = URI
|
2463
|
+
|
2464
|
+
KEY-text-param = "VALUE=text"
|
2465
|
+
KEY-text-value = text
|
2466
|
+
|
2467
|
+
KEY-param =/ altid-param / pid-param / pref-param / type-param
|
2468
|
+
/ any-param
|
2469
|
+
----
|
2470
|
+
|
2471
|
+
Examples::
|
2472
|
+
+
|
2473
|
+
....
|
2474
|
+
KEY:http://www.example.com/keys/jdoe.cer
|
2475
|
+
|
2476
|
+
KEY;MEDIATYPE=application/pgp-keys:ftp://example.com/keys/jdoe
|
2477
|
+
|
2478
|
+
KEY:data:application/pgp-keys;base64,MIICajCCAdOgAwIBAgICBE
|
2479
|
+
UwDQYJKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05l
|
2480
|
+
<... remainder of base64-encoded data ...>
|
2481
|
+
....
|
2482
|
+
|
2483
|
+
[[section6_9]]
|
2484
|
+
==== Calendar Properties
|
2485
|
+
|
2486
|
+
These properties are further specified in cite:[RFC2739].
|
2487
|
+
|
2488
|
+
[[secton6_9_1]]
|
2489
|
+
==== FBURL
|
2490
|
+
|
2491
|
+
Purpose:: To specify the URI for the busy time associated with the
|
2492
|
+
object that the vCard represents.
|
2493
|
+
|
2494
|
+
Value type:: A single URI value.
|
2495
|
+
|
2496
|
+
Cardinality:: *
|
2497
|
+
|
2498
|
+
Special notes:: Where multiple `FBURL` properties are specified, the
|
2499
|
+
default `FBURL` property is indicated with the `PREF` parameter. The
|
2500
|
+
`FTP` cite:[RFC1738] or `HTTP` cite:[RFC2616] type of URI points to an iCalendar
|
2501
|
+
cite:[RFC5545] object associated with a snapshot of the next few weeks
|
2502
|
+
or months of busy time data. If the iCalendar object is
|
2503
|
+
represented as a file or document, its file extension should be
|
2504
|
+
`".ifb"`.
|
2505
|
+
|
2506
|
+
ABNF::
|
2507
|
+
+
|
2508
|
+
[source,abnf]
|
2509
|
+
----
|
2510
|
+
FBURL-param = "VALUE=uri" / pid-param / pref-param / type-param
|
2511
|
+
/ mediatype-param / altid-param / any-param
|
2512
|
+
FBURL-value = URI
|
2513
|
+
----
|
2514
|
+
|
2515
|
+
Examples::
|
2516
|
+
+
|
2517
|
+
....
|
2518
|
+
FBURL;PREF=1:http://www.example.com/busy/janedoe
|
2519
|
+
FBURL;MEDIATYPE=text/calendar:ftp://example.com/busy/project-a.ifb
|
2520
|
+
....
|
2521
|
+
|
2522
|
+
[[section6_9_2]]
|
2523
|
+
==== CALADRURI
|
2524
|
+
|
2525
|
+
Purpose:: To specify the calendar user address cite:[RFC5545] to which a
|
2526
|
+
scheduling request cite:[RFC5546] should be sent for the object
|
2527
|
+
represented by the vCard.
|
2528
|
+
|
2529
|
+
Value type:: A single URI value.
|
2530
|
+
|
2531
|
+
Cardinality:: *
|
2532
|
+
|
2533
|
+
Special notes: Where multiple `CALADRURI` properties are specified,
|
2534
|
+
the default `CALADRURI` property is indicated with the `PREF`
|
2535
|
+
parameter.
|
2536
|
+
|
2537
|
+
ABNF::
|
2538
|
+
+
|
2539
|
+
[source,abnf]
|
2540
|
+
----
|
2541
|
+
CALADRURI-param = "VALUE=uri" / pid-param / pref-param / type-param
|
2542
|
+
/ mediatype-param / altid-param / any-param
|
2543
|
+
CALADRURI-value = URI
|
2544
|
+
----
|
2545
|
+
|
2546
|
+
Example::
|
2547
|
+
+
|
2548
|
+
....
|
2549
|
+
CALADRURI;PREF=1:mailto:janedoe@example.com
|
2550
|
+
CALADRURI:http://example.com/calendar/jdoe
|
2551
|
+
....
|
2552
|
+
|
2553
|
+
[[section6_9_3]]
|
2554
|
+
==== CALURI
|
2555
|
+
|
2556
|
+
Purpose:: To specify the URI for a calendar associated with the
|
2557
|
+
object represented by the vCard.
|
2558
|
+
|
2559
|
+
Value type:: A single URI value.
|
2560
|
+
|
2561
|
+
Cardinality:: *
|
2562
|
+
|
2563
|
+
Special notes:: Where multiple `CALURI` properties are specified, the
|
2564
|
+
default `CALURI` property is indicated with the `PREF` parameter. The
|
2565
|
+
property should contain a URI pointing to an iCalendar cite:[RFC3986]
|
2566
|
+
object associated with a snapshot of the user's calendar store.
|
2567
|
+
If the iCalendar object is represented as a file or document, its
|
2568
|
+
file extension should be `".ics"`.
|
2569
|
+
|
2570
|
+
ABNF::
|
2571
|
+
+
|
2572
|
+
[source,abnf]
|
2573
|
+
----
|
2574
|
+
CALURI-param = "VALUE=uri" / pid-param / pref-param / type-param
|
2575
|
+
/ mediatype-param / altid-param / any-param
|
2576
|
+
CALURI-value = URI
|
2577
|
+
----
|
2578
|
+
|
2579
|
+
Examples::
|
2580
|
+
+
|
2581
|
+
....
|
2582
|
+
CALURI;PREF=1:http://cal.example.com/calA
|
2583
|
+
CALURI;MEDIATYPE=text/calendar:ftp://ftp.example.com/calA.ics
|
2584
|
+
....
|
2585
|
+
|
2586
|
+
[[section6_10]]
|
2587
|
+
=== Extended Properties and Parameters
|
2588
|
+
|
2589
|
+
The properties and parameters defined by this document can be
|
2590
|
+
extended. Non-standard, private properties and parameters with a
|
2591
|
+
name starting with `"X-"` may be defined bilaterally between two
|
2592
|
+
cooperating agents without outside registration or standardization.
|
2593
|
+
|
2594
|
+
[[section7]]
|
2595
|
+
== Synchronization
|
2596
|
+
|
2597
|
+
vCard data often needs to be synchronized between devices. In this
|
2598
|
+
context, synchronization is defined as the intelligent merging of two
|
2599
|
+
representations of the same object. vCard 4.0 includes mechanisms to
|
2600
|
+
aid this process.
|
2601
|
+
|
2602
|
+
[[section7_1]]
|
2603
|
+
=== Mechanisms
|
2604
|
+
|
2605
|
+
Two mechanisms are available: the `UID` property is used to match
|
2606
|
+
multiple instances of the same vCard, while the `PID` parameter is used
|
2607
|
+
to match multiple instances of the same property.
|
2608
|
+
|
2609
|
+
The term "matching" is used here to mean recognizing that two
|
2610
|
+
instances are in fact representations of the same object. For
|
2611
|
+
example, a single vCard that is shared with someone results in two
|
2612
|
+
vCard instances. After they have evolved separately, they still
|
2613
|
+
represent the same object, and therefore may be matched by a
|
2614
|
+
synchronization engine.
|
2615
|
+
|
2616
|
+
[[section7_1_1]]
|
2617
|
+
==== Matching vCard Instances
|
2618
|
+
|
2619
|
+
vCard instances for which the UID properties (<<section6_7_6,Section 6.7.6>>) are
|
2620
|
+
equivalent [bcp14]#MUST# be matched. Equivalence is determined as specified
|
2621
|
+
in <<RFC3986, 6 comma>>.
|
2622
|
+
|
2623
|
+
In all other cases, vCard instances [bcp14]#MAY# be matched at the discretion
|
2624
|
+
of the synchronization engine.
|
2625
|
+
|
2626
|
+
[[section7_1_2]]
|
2627
|
+
==== Matching Property Instances
|
2628
|
+
|
2629
|
+
Property instances belonging to unmatched vCards [bcp14]#MUST NOT# be matched.
|
2630
|
+
|
2631
|
+
Property instances whose name (e.g., `EMAIL`, `TEL`, etc.) is not the
|
2632
|
+
same [bcp14]#MUST NOT# be matched.
|
2633
|
+
|
2634
|
+
Property instances whose name is `CLIENTPIDMAP` are handled separately
|
2635
|
+
and [bcp14]#MUST NOT# be matched. The synchronization [bcp14]#MUST# ensure that there
|
2636
|
+
is consistency of `CLIENTPIDMAP`s among matched vCard instances.
|
2637
|
+
|
2638
|
+
Property instances belonging to matched vCards, whose name is the
|
2639
|
+
same, and whose maximum cardinality is 1, [bcp14]#MUST# be matched.
|
2640
|
+
|
2641
|
+
Property instances belonging to matched vCards, whose name is the
|
2642
|
+
same, and whose `PID` parameters match, [bcp14]#MUST# be matched. See
|
2643
|
+
<<section7_1_3,Section 7.1.3>> for details on `PID` matching.
|
2644
|
+
|
2645
|
+
In all other cases, property instances [bcp14]#MAY# be matched at the
|
2646
|
+
discretion of the synchronization engine.
|
2647
|
+
|
2648
|
+
[[section7_1_3]]
|
2649
|
+
==== PID Matching
|
2650
|
+
|
2651
|
+
Two `PID` values for which the first fields are equivalent represent
|
2652
|
+
the same local value.
|
2653
|
+
|
2654
|
+
Two `PID` values representing the same local value and for which the
|
2655
|
+
second fields point to `CLIENTPIDMAP` properties whose second field
|
2656
|
+
URIs are equivalent (as specified in <<RFC3986,6 comma>>) also
|
2657
|
+
represent the same global value.
|
2658
|
+
|
2659
|
+
`PID` parameters for which at least one pair of their values represent
|
2660
|
+
the same global value [bcp14]#MUST# be matched.
|
2661
|
+
|
2662
|
+
In all other cases, `PID` parameters [bcp14]#MAY# be matched at the discretion
|
2663
|
+
of the synchronization engine.
|
2664
|
+
|
2665
|
+
For example, `PID` value `"5.1"`, in the first vCard below, and `PID` value
|
2666
|
+
`"5.2"`, in the second vCard below, represent the same global value.
|
2667
|
+
|
2668
|
+
|
2669
|
+
....
|
2670
|
+
BEGIN:VCARD
|
2671
|
+
VERSION:4.0
|
2672
|
+
EMAIL;PID=4.2,5.1:jdoe@example.com
|
2673
|
+
CLIENTPIDMAP:1;urn:uuid:3eef374e-7179-4196-a914-27358c3e6527
|
2674
|
+
CLIENTPIDMAP:2;urn:uuid:42bcd5a7-1699-4514-87b4-056edf68e9cc
|
2675
|
+
END:VCARD
|
2676
|
+
....
|
2677
|
+
|
2678
|
+
....
|
2679
|
+
BEGIN:VCARD
|
2680
|
+
VERSION:4.0
|
2681
|
+
EMAIL;PID=5.1,5.2:john@example.com
|
2682
|
+
CLIENTPIDMAP:1;urn:uuid:0c75c629-6a8d-4d5e-a07f-1bb35846854d
|
2683
|
+
CLIENTPIDMAP:2;urn:uuid:3eef374e-7179-4196-a914-27358c3e6527
|
2684
|
+
END:VCARD
|
2685
|
+
....
|
2686
|
+
|
2687
|
+
[[section7_2]]
|
2688
|
+
=== Example
|
2689
|
+
|
2690
|
+
[[section7_2_1]]
|
2691
|
+
==== Creation
|
2692
|
+
|
2693
|
+
The following simple vCard is first created on a given device.
|
2694
|
+
|
2695
|
+
....
|
2696
|
+
BEGIN:VCARD
|
2697
|
+
VERSION:4.0
|
2698
|
+
UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
|
2699
|
+
FN;PID=1.1:J. Doe
|
2700
|
+
N:Doe;J.;;;
|
2701
|
+
EMAIL;PID=1.1:jdoe@example.com
|
2702
|
+
CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
|
2703
|
+
END:VCARD
|
2704
|
+
....
|
2705
|
+
|
2706
|
+
This new vCard is assigned the UID
|
2707
|
+
`"urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1"` by the creating
|
2708
|
+
device. The `FN` and `EMAIL` properties are assigned the same local
|
2709
|
+
value of `1`, and this value is given global context by associating it
|
2710
|
+
with `"urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556"`, which
|
2711
|
+
represents the creating device. We are at liberty to reuse the same
|
2712
|
+
local value since instances of different properties will never be
|
2713
|
+
matched. The `N` property has no `PID` because it is forbidden by its
|
2714
|
+
maximum cardinality of 1.
|
2715
|
+
|
2716
|
+
[[section7_2_2]]
|
2717
|
+
==== Initial Sharing
|
2718
|
+
|
2719
|
+
This vCard is shared with a second device. Upon inspecting the `UID`
|
2720
|
+
property, the second device understands that this is a new vCard
|
2721
|
+
(i.e., unmatched) and thus the synchronization results in a simple
|
2722
|
+
copy.
|
2723
|
+
|
2724
|
+
[[section7_2_3]]
|
2725
|
+
==== Adding and Sharing a Property
|
2726
|
+
|
2727
|
+
A new phone number is created on the first device, then the vCard is
|
2728
|
+
shared with the second device. This is what the second device
|
2729
|
+
receives:
|
2730
|
+
|
2731
|
+
....
|
2732
|
+
BEGIN:VCARD
|
2733
|
+
VERSION:4.0
|
2734
|
+
UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
|
2735
|
+
FN;PID=1.1:J. Doe
|
2736
|
+
N:Doe;J.;;;
|
2737
|
+
EMAIL;PID=1.1:jdoe@example.com
|
2738
|
+
TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
|
2739
|
+
CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
|
2740
|
+
END:VCARD
|
2741
|
+
....
|
2742
|
+
|
2743
|
+
Upon inspecting the `UID` property, the second device matches the vCard
|
2744
|
+
it received to the vCard that it already has stored. It then starts
|
2745
|
+
comparing the properties of the two vCards in same-named pairs.
|
2746
|
+
|
2747
|
+
The FN properties are matched because the `PID` parameters have the
|
2748
|
+
same global value. Since the property value is the same, no update
|
2749
|
+
takes place.
|
2750
|
+
|
2751
|
+
The `N` properties are matched automatically because their maximum
|
2752
|
+
cardinality is 1. Since the property value is the same, no update
|
2753
|
+
takes place.
|
2754
|
+
|
2755
|
+
The `EMAIL` properties are matched because the `PID` parameters have the
|
2756
|
+
same global value. Since the property value is the same, no update
|
2757
|
+
takes place.
|
2758
|
+
|
2759
|
+
The `TEL` property in the new vCard is not matched to any in the stored
|
2760
|
+
vCard because no property in the stored vCard has the same name.
|
2761
|
+
Therefore, this property is copied from the new vCard to the stored
|
2762
|
+
vCard.
|
2763
|
+
|
2764
|
+
The `CLIENTPIDMAP` property is handled separately by the
|
2765
|
+
synchronization engine. It ensures that it is consistent with the
|
2766
|
+
stored one. If it was not, the results would be up to the
|
2767
|
+
synchronization engine, and thus undefined by this document.
|
2768
|
+
|
2769
|
+
[[section7_2_4]]
|
2770
|
+
==== Simultaneous Editing
|
2771
|
+
|
2772
|
+
A new email address and a new phone number are added to the vCard on
|
2773
|
+
each of the two devices, and then a new synchronization event
|
2774
|
+
happens. Here are the vCards that are communicated to each other:
|
2775
|
+
|
2776
|
+
....
|
2777
|
+
BEGIN:VCARD
|
2778
|
+
VERSION:4.0
|
2779
|
+
UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
|
2780
|
+
FN;PID=1.1:J. Doe
|
2781
|
+
N:Doe;J.;;;
|
2782
|
+
EMAIL;PID=1.1:jdoe@example.com
|
2783
|
+
EMAIL;PID=2.1:boss@example.com
|
2784
|
+
TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
|
2785
|
+
TEL;PID=2.1;VALUE=uri:tel:+1-666-666-6666
|
2786
|
+
CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
|
2787
|
+
END:VCARD
|
2788
|
+
....
|
2789
|
+
|
2790
|
+
....
|
2791
|
+
BEGIN:VCARD
|
2792
|
+
VERSION:4.0
|
2793
|
+
UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
|
2794
|
+
FN;PID=1.1:J. Doe
|
2795
|
+
N:Doe;J.;;;
|
2796
|
+
EMAIL;PID=1.1:jdoe@example.com
|
2797
|
+
EMAIL;PID=2.2:ceo@example.com
|
2798
|
+
TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
|
2799
|
+
TEL;PID=2.2;VALUE=uri:tel:+1-666-666-6666
|
2800
|
+
CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
|
2801
|
+
CLIENTPIDMAP:2;urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee
|
2802
|
+
END:VCARD
|
2803
|
+
....
|
2804
|
+
|
2805
|
+
On the first device, the same `PID` source identifier (1) is reused for
|
2806
|
+
the new `EMAIL` and `TEL` properties. On the second device, a new source
|
2807
|
+
identifier (2) is generated, and a corresponding `CLIENTPIDMAP`
|
2808
|
+
property is created. It contains the second device's identifier,
|
2809
|
+
`"urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee"`.
|
2810
|
+
|
2811
|
+
The new `EMAIL` properties are unmatched on both sides since the `PID`
|
2812
|
+
global value is new in both cases. The sync thus results in a copy
|
2813
|
+
on both sides.
|
2814
|
+
|
2815
|
+
Although the situation appears to be the same for the `TEL` properties,
|
2816
|
+
in this case, the synchronization engine is particularly smart and
|
2817
|
+
matches the two new `TEL` properties even though their `PID` global
|
2818
|
+
values are different. Note that in this case, the rules of
|
2819
|
+
<<section7_1_2,Section 7.1.2>> state that two properties [bcp14]#MAY# be matched at the
|
2820
|
+
discretion of the synchronization engine. Therefore, the two
|
2821
|
+
properties are merged.
|
2822
|
+
|
2823
|
+
All this results in the following vCard, which is stored on both
|
2824
|
+
devices:
|
2825
|
+
|
2826
|
+
|
2827
|
+
....
|
2828
|
+
BEGIN:VCARD
|
2829
|
+
VERSION:4.0
|
2830
|
+
UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
|
2831
|
+
FN:J. Doe
|
2832
|
+
N:Doe;J.;;;
|
2833
|
+
EMAIL;PID=1.1:jdoe@example.com
|
2834
|
+
EMAIL;PID=2.1:boss@example.com
|
2835
|
+
EMAIL;PID=2.2:ceo@example.com
|
2836
|
+
TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
|
2837
|
+
TEL;PID=2.1,2.2;VALUE=uri:tel:+1-666-666-6666
|
2838
|
+
CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
|
2839
|
+
CLIENTPIDMAP:2;urn:uuid:1f762d2b-03c4-4a83-9a03-75ff658a6eee
|
2840
|
+
END:VCARD
|
2841
|
+
....
|
2842
|
+
|
2843
|
+
[[section7_2_5]]
|
2844
|
+
==== Global Context Simplification
|
2845
|
+
|
2846
|
+
The two devices finish their synchronization procedure by simplifying
|
2847
|
+
their global contexts. Since they haven't talked to any other
|
2848
|
+
device, the following vCard is for all purposes equivalent to the
|
2849
|
+
above. It is also shorter.
|
2850
|
+
|
2851
|
+
....
|
2852
|
+
BEGIN:VCARD
|
2853
|
+
VERSION:4.0
|
2854
|
+
UID:urn:uuid:4fbe8971-0bc3-424c-9c26-36c3e1eff6b1
|
2855
|
+
FN:J. Doe
|
2856
|
+
N:Doe;J.;;;
|
2857
|
+
EMAIL;PID=1.1:jdoe@example.com
|
2858
|
+
EMAIL;PID=2.1:boss@example.com
|
2859
|
+
EMAIL;PID=3.1:ceo@example.com
|
2860
|
+
TEL;PID=1.1;VALUE=uri:tel:+1-555-555-5555
|
2861
|
+
TEL;PID=2.1;VALUE=uri:tel:+1-666-666-6666
|
2862
|
+
CLIENTPIDMAP:1;urn:uuid:53e374d9-337e-4727-8803-a1e9c14e0556
|
2863
|
+
END:VCARD
|
2864
|
+
....
|
2865
|
+
|
2866
|
+
The details of global context simplification are unspecified by this
|
2867
|
+
document. They are left up to the synchronization engine. This
|
2868
|
+
example is merely intended to illustrate the possibility, which
|
2869
|
+
investigating would be, in the author's opinion, worthwhile.
|
2870
|
+
|
2871
|
+
[[section8]]
|
2872
|
+
== Example: Author's vCard
|
2873
|
+
|
2874
|
+
....
|
2875
|
+
BEGIN:VCARD
|
2876
|
+
VERSION:4.0
|
2877
|
+
FN:Simon Perreault
|
2878
|
+
N:Perreault;Simon;;;ing. jr,M.Sc.
|
2879
|
+
BDAY:--0203
|
2880
|
+
ANNIVERSARY:20090808T1430-0500
|
2881
|
+
GENDER:M
|
2882
|
+
LANG;PREF=1:fr
|
2883
|
+
LANG;PREF=2:en
|
2884
|
+
ORG;TYPE=work:Viagenie
|
2885
|
+
ADR;TYPE=work:;Suite D2-630;2875 Laurier;
|
2886
|
+
Quebec;QC;G1V 2M2;Canada
|
2887
|
+
TEL;VALUE=uri;TYPE="work,voice";PREF=1:tel:+1-418-656-9254;ext=102
|
2888
|
+
TEL;VALUE=uri;TYPE="work,cell,voice,video,text":tel:+1-418-262-6501
|
2889
|
+
EMAIL;TYPE=work:simon.perreault@viagenie.ca
|
2890
|
+
GEO;TYPE=work:geo:46.772673,-71.282945
|
2891
|
+
KEY;TYPE=work;VALUE=uri:
|
2892
|
+
http://www.viagenie.ca/simon.perreault/simon.asc
|
2893
|
+
TZ:-0500
|
2894
|
+
URL;TYPE=home:http://nomis80.org
|
2895
|
+
END:VCARD
|
2896
|
+
....
|
2897
|
+
|
2898
|
+
[[section9]]
|
2899
|
+
== Security Considerations
|
2900
|
+
|
2901
|
+
* Internet mail is often used to transport vCards and is subject to
|
2902
|
+
many well-known security attacks, including monitoring, replay,
|
2903
|
+
and forgery. Care should be taken by any directory service in
|
2904
|
+
allowing information to leave the scope of the service itself,
|
2905
|
+
where any access controls or confidentiality can no longer be
|
2906
|
+
guaranteed. Applications should also take care to display
|
2907
|
+
directory data in a "safe" environment.
|
2908
|
+
|
2909
|
+
* vCards can carry cryptographic keys or certificates, as described
|
2910
|
+
in <<section6_8_1,Section 6.8.1>>.
|
2911
|
+
|
2912
|
+
* vCards often carry information that can be sensitive (e.g.,
|
2913
|
+
birthday, address, and phone information). Although vCards have
|
2914
|
+
no inherent authentication or confidentiality provisions, they can
|
2915
|
+
easily be carried by any security mechanism that transfers MIME
|
2916
|
+
objects to address authentication or confidentiality (e.g., S/MIME
|
2917
|
+
cite:[RFC5751], OpenPGP cite:[RFC4880]). In cases where the confidentiality
|
2918
|
+
or authenticity of information contained in vCard is a concern,
|
2919
|
+
the vCard [bcp14]#SHOULD# be transported using one of these secure
|
2920
|
+
mechanisms. The `KEY` property (<<section6_8_1,Section 6.8.1>>) can be used to
|
2921
|
+
transport the public key used by these mechanisms.
|
2922
|
+
|
2923
|
+
* The information in a vCard may become out of date. In cases where
|
2924
|
+
the vitality of data is important to an originator of a vCard, the
|
2925
|
+
`SOURCE` property (<<section6_1_3,Section 6.1.3>>) [bcp14]#SHOULD# be specified. In addition,
|
2926
|
+
the `"REV"` type described in <<section6_7_4,Section 6.7.4>> can be specified to
|
2927
|
+
indicate the last time that the vCard data was updated.
|
2928
|
+
|
2929
|
+
* Many vCard properties may be used to transport URIs. Please refer
|
2930
|
+
to <<RFC3986,7 comma>>, for considerations related to URIs.
|
2931
|
+
|
2932
|
+
[[section10]]
|
2933
|
+
== IANA Considerations
|
2934
|
+
|
2935
|
+
[[section10_1]]
|
2936
|
+
=== Media Type Registration
|
2937
|
+
|
2938
|
+
IANA has registered the following Media Type (in
|
2939
|
+
<http://www.iana.org/[]>) and marked the text/directory Media Type as
|
2940
|
+
DEPRECATED.
|
2941
|
+
|
2942
|
+
To:: ietf-types@iana.org
|
2943
|
+
|
2944
|
+
Subject:: Registration of media type text/vcard
|
2945
|
+
|
2946
|
+
Type name:: text
|
2947
|
+
|
2948
|
+
Subtype name:: vcard
|
2949
|
+
|
2950
|
+
Required parameters:: none
|
2951
|
+
|
2952
|
+
Optional parameters:: version
|
2953
|
+
+
|
2954
|
+
The "version" parameter is to be interpreted identically as the
|
2955
|
+
`VERSION` vCard property. If this parameter is present, all vCards
|
2956
|
+
in a text/vcard body part [bcp14]#MUST# have a `VERSION` property with value
|
2957
|
+
identical to that of this MIME parameter.
|
2958
|
+
+
|
2959
|
+
"charset": as defined for text/plain cite:[RFC2046]; encodings other
|
2960
|
+
than UTF-8 cite:[RFC3629] [bcp14]#MUST NOT# be used.
|
2961
|
+
|
2962
|
+
Encoding considerations:: 8bit
|
2963
|
+
|
2964
|
+
Security considerations:: See <<section9,Section 9>>.
|
2965
|
+
|
2966
|
+
Interoperability considerations:: The text/vcard media type is
|
2967
|
+
intended to identify vCard data of any version. There are older
|
2968
|
+
specifications of vCard cite:[RFC2426]+[vCard21] still in common use.
|
2969
|
+
While these formats are similar, they are not strictly compatible.
|
2970
|
+
In general, it is necessary to inspect the value of the `VERSION`
|
2971
|
+
property (see <<section6_7_9,Section 6.7.9>>) for identifying the standard to which
|
2972
|
+
a given vCard object conforms.
|
2973
|
+
+
|
2974
|
+
In addition, the following media types are known to have been used
|
2975
|
+
to refer to vCard data. They should be considered deprecated in
|
2976
|
+
favor of text/vcard.
|
2977
|
+
+
|
2978
|
+
* text/directory
|
2979
|
+
* text/directory; profile=vcard
|
2980
|
+
* text/x-vcard
|
2981
|
+
|
2982
|
+
Published specification:: RFC 6350
|
2983
|
+
|
2984
|
+
Applications that use this media type:: They are numerous, diverse,
|
2985
|
+
and include mail user agents, instant messaging clients, address
|
2986
|
+
book applications, directory servers, and customer relationship
|
2987
|
+
management software.
|
2988
|
+
|
2989
|
+
Additional information::
|
2990
|
+
|
2991
|
+
Magic number(s):::
|
2992
|
+
|
2993
|
+
File extension(s)::: .vcf .vcard
|
2994
|
+
|
2995
|
+
Macintosh file type code(s):::
|
2996
|
+
|
2997
|
+
Person & email address to contact for further information:: vCard
|
2998
|
+
discussion mailing list <vcarddav@ietf.org>
|
2999
|
+
|
3000
|
+
Intended usage:: COMMON
|
3001
|
+
|
3002
|
+
Restrictions on usage:: none
|
3003
|
+
|
3004
|
+
Author:: Simon Perreault
|
3005
|
+
|
3006
|
+
Change controller:: IETF
|
3007
|
+
|
3008
|
+
[[section10_2]]
|
3009
|
+
=== Registering New vCard Elements
|
3010
|
+
|
3011
|
+
This section defines the process for registering new or modified
|
3012
|
+
vCard elements (i.e., properties, parameters, value data types, and
|
3013
|
+
values) with IANA.
|
3014
|
+
|
3015
|
+
[[section10_2_1]]
|
3016
|
+
==== Registration Procedure
|
3017
|
+
|
3018
|
+
The IETF has created a mailing list, vcarddav@ietf.org, which can be
|
3019
|
+
used for public discussion of vCard element proposals prior to
|
3020
|
+
registration. Use of the mailing list is strongly encouraged. The
|
3021
|
+
IESG has appointed a designated expert who will monitor the
|
3022
|
+
vcarddav@ietf.org mailing list and review registrations.
|
3023
|
+
|
3024
|
+
Registration of new vCard elements [bcp14]#MUST# be reviewed by the designated
|
3025
|
+
expert and published in an RFC. A Standards Track RFC is [bcp14]#REQUIRED#
|
3026
|
+
for the registration of new value data types that modify existing
|
3027
|
+
properties. A Standards Track RFC is also [bcp14]#REQUIRED# for registration
|
3028
|
+
of vCard elements that modify vCard elements previously documented in
|
3029
|
+
a Standards Track RFC.
|
3030
|
+
|
3031
|
+
The registration procedure begins when a completed registration
|
3032
|
+
template, defined in the sections below, is sent to vcarddav@ietf.org
|
3033
|
+
and iana@iana.org. Within two weeks, the designated expert is
|
3034
|
+
expected to tell IANA and the submitter of the registration whether
|
3035
|
+
the registration is approved, approved with minor changes, or
|
3036
|
+
rejected with cause. When a registration is rejected with cause, it
|
3037
|
+
can be re-submitted if the concerns listed in the cause are
|
3038
|
+
addressed. Decisions made by the designated expert can be appealed
|
3039
|
+
to the IESG Applications Area Director, then to the IESG. They
|
3040
|
+
follow the normal appeals procedure for IESG decisions.
|
3041
|
+
|
3042
|
+
Once the registration procedure concludes successfully, IANA creates
|
3043
|
+
or modifies the corresponding record in the vCard registry. The
|
3044
|
+
completed registration template is discarded.
|
3045
|
+
|
3046
|
+
An RFC specifying new vCard elements [bcp14]#MUST# include the completed
|
3047
|
+
registration templates, which [bcp14]#MAY# be expanded with additional
|
3048
|
+
information. These completed templates are intended to go in the
|
3049
|
+
body of the document, not in the IANA Considerations section.
|
3050
|
+
|
3051
|
+
Finally, note that there is an XML representation for vCard defined
|
3052
|
+
in cite:[RFC6351]. An XML representation [bcp14]#SHOULD# be defined for new vCard
|
3053
|
+
elements.
|
3054
|
+
|
3055
|
+
[[section10_2_2]]
|
3056
|
+
==== Vendor Namespace
|
3057
|
+
|
3058
|
+
The vendor namespace is used for vCard elements associated with
|
3059
|
+
commercially available products. "Vendor" or "producer" are
|
3060
|
+
construed as equivalent and very broadly in this context.
|
3061
|
+
|
3062
|
+
A registration may be placed in the vendor namespace by anyone who
|
3063
|
+
needs to interchange files associated with the particular product.
|
3064
|
+
However, the registration formally belongs to the vendor or
|
3065
|
+
organization handling the vCard elements in the namespace being
|
3066
|
+
registered. Changes to the specification will be made at their
|
3067
|
+
request, as discussed in subsequent sections.
|
3068
|
+
|
3069
|
+
vCard elements belonging to the vendor namespace will be
|
3070
|
+
distinguished by the `"VND-"` prefix. This is followed by an IANA-
|
3071
|
+
registered Private Enterprise Number (PEN), a dash, and a vCard
|
3072
|
+
element designation of the vendor's choosing (e.g., `"VND-123456-
|
3073
|
+
MUDPIE"`).
|
3074
|
+
|
3075
|
+
While public exposure and review of vCard elements to be registered
|
3076
|
+
in the vendor namespace are not required, using the vcarddav@ietf.org
|
3077
|
+
mailing list for review is strongly encouraged to improve the quality
|
3078
|
+
of those specifications. Registrations in the vendor namespace may
|
3079
|
+
be submitted directly to the IANA.
|
3080
|
+
|
3081
|
+
[[section10_2_3]]
|
3082
|
+
==== Registration Template for Properties
|
3083
|
+
|
3084
|
+
A property is defined by completing the following template.
|
3085
|
+
|
3086
|
+
Namespace:: Empty for the global namespace, `"VND-NNNN-"` for a vendor-
|
3087
|
+
specific property (where `NNNN` is replaced by the vendor's PEN).
|
3088
|
+
|
3089
|
+
Property name:: The name of the property.
|
3090
|
+
|
3091
|
+
Purpose:: The purpose of the property. Give a short but clear
|
3092
|
+
description.
|
3093
|
+
|
3094
|
+
Value type:: Any of the valid value types for the property value
|
3095
|
+
needs to be specified. The default value type also needs to be
|
3096
|
+
specified.
|
3097
|
+
|
3098
|
+
Cardinality:: See <<section6,Section 6>>.
|
3099
|
+
|
3100
|
+
Property parameters:: Any of the valid property parameters for the
|
3101
|
+
property [bcp14]#MUST# be specified.
|
3102
|
+
|
3103
|
+
Description:: Any special notes about the property, how it is to be
|
3104
|
+
used, etc.
|
3105
|
+
|
3106
|
+
Format definition:: The ABNF for the property definition needs to be
|
3107
|
+
specified.
|
3108
|
+
|
3109
|
+
Example(s):: One or more examples of instances of the property need
|
3110
|
+
to be specified.
|
3111
|
+
|
3112
|
+
[[section10_2_4]]
|
3113
|
+
==== Registration Template for Parameters
|
3114
|
+
|
3115
|
+
A parameter is defined by completing the following template.
|
3116
|
+
|
3117
|
+
Namespace:: Empty for the global namespace, `"VND-NNNN-"` for a vendor-
|
3118
|
+
specific property (where `NNNN` is replaced by the vendor's PEN).
|
3119
|
+
|
3120
|
+
Parameter name:: The name of the parameter.
|
3121
|
+
|
3122
|
+
Purpose:: The purpose of the parameter. Give a short but clear
|
3123
|
+
description.
|
3124
|
+
|
3125
|
+
Description:: Any special notes about the parameter, how it is to be
|
3126
|
+
used, etc.
|
3127
|
+
|
3128
|
+
Format definition:: The ABNF for the parameter definition needs to be
|
3129
|
+
specified.
|
3130
|
+
|
3131
|
+
Example(s):: One or more examples of instances of the parameter need
|
3132
|
+
to be specified.
|
3133
|
+
|
3134
|
+
[[section10_2_5]]
|
3135
|
+
==== Registration Template for Value Data Types
|
3136
|
+
|
3137
|
+
A value data type is defined by completing the following template.
|
3138
|
+
|
3139
|
+
Value name:: The name of the value type.
|
3140
|
+
|
3141
|
+
Purpose:: The purpose of the value type. Give a short but clear
|
3142
|
+
description.
|
3143
|
+
|
3144
|
+
Description:: Any special notes about the value type, how it is to be
|
3145
|
+
used, etc.
|
3146
|
+
|
3147
|
+
Format definition:: The ABNF for the value type definition needs to
|
3148
|
+
be specified.
|
3149
|
+
|
3150
|
+
Example(s):: One or more examples of instances of the value type need
|
3151
|
+
to be specified.
|
3152
|
+
|
3153
|
+
[[section10_2_6]]
|
3154
|
+
==== Registration Template for Values
|
3155
|
+
|
3156
|
+
A value is defined by completing the following template.
|
3157
|
+
|
3158
|
+
Value:: The value literal.
|
3159
|
+
|
3160
|
+
Purpose:: The purpose of the value. Give a short but clear
|
3161
|
+
description.
|
3162
|
+
|
3163
|
+
Conformance:: The vCard properties and/or parameters that can take
|
3164
|
+
this value needs to be specified.
|
3165
|
+
|
3166
|
+
Example(s):: One or more examples of instances of the value need to
|
3167
|
+
be specified.
|
3168
|
+
|
3169
|
+
The following is a fictitious example of a registration of a vCard
|
3170
|
+
value:
|
3171
|
+
|
3172
|
+
Value:: supervisor
|
3173
|
+
|
3174
|
+
Purpose:: It means that the related entity is the direct hierarchical
|
3175
|
+
superior (i.e., supervisor or manager) of the entity this vCard
|
3176
|
+
represents.
|
3177
|
+
|
3178
|
+
Conformance:: This value can be used with the `"TYPE"` parameter
|
3179
|
+
applied on the `"RELATED"` property.
|
3180
|
+
|
3181
|
+
|
3182
|
+
Example(s):"
|
3183
|
+
+
|
3184
|
+
....
|
3185
|
+
RELATED;TYPE=supervisor:urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6
|
3186
|
+
....
|
3187
|
+
|
3188
|
+
[[section10_3]]
|
3189
|
+
=== Initial vCard Elements Registries
|
3190
|
+
|
3191
|
+
The IANA has created and will maintain the following registries for
|
3192
|
+
vCard elements with pointers to appropriate reference documents. The
|
3193
|
+
registries are grouped together under the heading "vCard Elements".
|
3194
|
+
|
3195
|
+
[[section10_3_1]]
|
3196
|
+
==== Properties Registry
|
3197
|
+
|
3198
|
+
The following table has been used to initialize the properties
|
3199
|
+
registry.
|
3200
|
+
|
3201
|
+
|===
|
3202
|
+
| Namespace | Property | Reference
|
3203
|
+
|
3204
|
+
| | SOURCE | RFC 6350, Section 6.1.3
|
3205
|
+
| | KIND | RFC 6350, Section 6.1.4
|
3206
|
+
| | XML | RFC 6350, Section 6.1.5
|
3207
|
+
| | FN | RFC 6350, Section 6.2.1
|
3208
|
+
| | N | RFC 6350, Section 6.2.2
|
3209
|
+
| | NICKNAME | RFC 6350, Section 6.2.3
|
3210
|
+
| | PHOTO | RFC 6350, Section 6.2.4
|
3211
|
+
| | BDAY | RFC 6350, Section 6.2.5
|
3212
|
+
| | ANNIVERSARY | RFC 6350, Section 6.2.6
|
3213
|
+
| | GENDER | RFC 6350, Section 6.2.7
|
3214
|
+
| | ADR | RFC 6350, Section 6.3.1
|
3215
|
+
| | TEL | RFC 6350, Section 6.4.1
|
3216
|
+
| | EMAIL | RFC 6350, Section 6.4.2
|
3217
|
+
| | IMPP | RFC 6350, Section 6.4.3
|
3218
|
+
| | LANG | RFC 6350, Section 6.4.4
|
3219
|
+
| | TZ | RFC 6350, Section 6.5.1
|
3220
|
+
| | GEO | RFC 6350, Section 6.5.2
|
3221
|
+
| | TITLE | RFC 6350, Section 6.6.1
|
3222
|
+
| | ROLE | RFC 6350, Section 6.6.2
|
3223
|
+
| | LOGO | RFC 6350, Section 6.6.3
|
3224
|
+
| | ORG | RFC 6350, Section 6.6.4
|
3225
|
+
| | MEMBER | RFC 6350, Section 6.6.5
|
3226
|
+
| | RELATED | RFC 6350, Section 6.6.6
|
3227
|
+
| | CATEGORIES | RFC 6350, Section 6.7.1
|
3228
|
+
| | NOTE | RFC 6350, Section 6.7.2
|
3229
|
+
| | PRODID | RFC 6350, Section 6.7.3
|
3230
|
+
| | REV | RFC 6350, Section 6.7.4
|
3231
|
+
| | SOUND | RFC 6350, Section 6.7.5
|
3232
|
+
| | UID | RFC 6350, Section 6.7.6
|
3233
|
+
| | CLIENTPIDMAP | RFC 6350, Section 6.7.7
|
3234
|
+
| | URL | RFC 6350, Section 6.7.8
|
3235
|
+
| | VERSION | RFC 6350, Section 6.7.9
|
3236
|
+
| | KEY | RFC 6350, Section 6.8.1
|
3237
|
+
| | FBURL | RFC 6350, Section 6.9.1
|
3238
|
+
| | CALADRURI | RFC 6350, Section 6.9.2
|
3239
|
+
| | CALURI | RFC 6350, Section 6.9.3
|
3240
|
+
|===
|
3241
|
+
|
3242
|
+
|
3243
|
+
[[section10_3_2]]
|
3244
|
+
==== Parameters Registry
|
3245
|
+
|
3246
|
+
The following table has been used to initialize the parameters
|
3247
|
+
registry.
|
3248
|
+
|
3249
|
+
|===
|
3250
|
+
| Namespace | Parameter | Reference
|
3251
|
+
|
3252
|
+
| | LANGUAGE | RFC 6350, Section 5.1
|
3253
|
+
| | VALUE | RFC 6350, Section 5.2
|
3254
|
+
| | PREF | RFC 6350, Section 5.3
|
3255
|
+
| | ALTID | RFC 6350, Section 5.4
|
3256
|
+
| | PID | RFC 6350, Section 5.5
|
3257
|
+
| | TYPE | RFC 6350, Section 5.6
|
3258
|
+
| | MEDIATYPE | RFC 6350, Section 5.7
|
3259
|
+
| | CALSCALE | RFC 6350, Section 5.8
|
3260
|
+
| | SORT-AS | RFC 6350, Section 5.9
|
3261
|
+
| | GEO | RFC 6350, Section 5.10
|
3262
|
+
| | TZ | RFC 6350, Section 5.11
|
3263
|
+
|===
|
3264
|
+
|
3265
|
+
[[section10_3_3]]
|
3266
|
+
==== Value Data Types Registry
|
3267
|
+
|
3268
|
+
The following table has been used to initialize the parameters
|
3269
|
+
registry.
|
3270
|
+
|
3271
|
+
|===
|
3272
|
+
| Value Data Type | Reference
|
3273
|
+
|
3274
|
+
| BOOLEAN | RFC 6350, Section 4.4 |
|
3275
|
+
| DATE | RFC 6350, Section 4.3.1 |
|
3276
|
+
| DATE-AND-OR-TIME | RFC 6350, Section 4.3.4 |
|
3277
|
+
| DATE-TIME | RFC 6350, Section 4.3.3 |
|
3278
|
+
| FLOAT | RFC 6350, Section 4.6 |
|
3279
|
+
| INTEGER | RFC 6350, Section 4.5 |
|
3280
|
+
| LANGUAGE-TAG | RFC 6350, Section 4.8 |
|
3281
|
+
| TEXT | RFC 6350, Section 4.1 |
|
3282
|
+
| TIME | RFC 6350, Section 4.3.2 |
|
3283
|
+
| TIMESTAMP | RFC 6350, Section 4.3.5 |
|
3284
|
+
| URI | RFC 6350, Section 4.2 |
|
3285
|
+
| UTC-OFFSET | RFC 6350, Section 4.7 |
|
3286
|
+
|===
|
3287
|
+
|
3288
|
+
[[section10_3_4]]
|
3289
|
+
==== Values Registries
|
3290
|
+
|
3291
|
+
Separate tables are used for property and parameter values.
|
3292
|
+
|
3293
|
+
The following table is to be used to initialize the property values
|
3294
|
+
registry.
|
3295
|
+
|
3296
|
+
|===
|
3297
|
+
| Property | Value | Reference |
|
3298
|
+
|
3299
|
+
| BEGIN | VCARD | RFC 6350, Section 6.1.1 |
|
3300
|
+
| END | VCARD | RFC 6350, Section 6.1.2 |
|
3301
|
+
| KIND | individual | RFC 6350, Section 6.1.4 |
|
3302
|
+
| KIND | group | RFC 6350, Section 6.1.4 |
|
3303
|
+
| KIND | org | RFC 6350, Section 6.1.4 |
|
3304
|
+
| KIND | location | RFC 6350, Section 6.1.4 |
|
3305
|
+
|===
|
3306
|
+
|
3307
|
+
The following table has been used to initialize the parameter values
|
3308
|
+
registry.
|
3309
|
+
|
3310
|
+
[cols="4"]
|
3311
|
+
|===
|
3312
|
+
| Property | Parameter | Value | Reference
|
3313
|
+
|
3314
|
+
| FN, NICKNAME, PHOTO,
|
3315
|
+
ADR, TEL, EMAIL, IMPP,
|
3316
|
+
LANG, TZ, GEO, TITLE,
|
3317
|
+
ROLE, LOGO, ORG,
|
3318
|
+
RELATED, CATEGORIES,
|
3319
|
+
NOTE, SOUND, URL, KEY,
|
3320
|
+
FBURL, CALADRURI, and
|
3321
|
+
CALURI
|
3322
|
+
| TYPE | work | RFC 6350, Section 5.6
|
3323
|
+
|
3324
|
+
| FN, NICKNAME, PHOTO,
|
3325
|
+
ADR, TEL, EMAIL, IMPP,
|
3326
|
+
LANG, TZ, GEO, TITLE,
|
3327
|
+
ROLE, LOGO, ORG,
|
3328
|
+
RELATED, CATEGORIES,
|
3329
|
+
NOTE, SOUND, URL, KEY,
|
3330
|
+
FBURL, CALADRURI, and
|
3331
|
+
CALURI
|
3332
|
+
| TYPE | home | RFC 6350, Section 5.6
|
3333
|
+
|
3334
|
+
| TEL | TYPE | text | RFC 6350, Section 6.4.1
|
3335
|
+
| TEL | TYPE | voice | RFC 6350, Section 6.4.1
|
3336
|
+
| TEL | TYPE | fax | RFC 6350, Section 6.4.1
|
3337
|
+
| TEL | TYPE | cell | RFC 6350, Section 6.4.1
|
3338
|
+
| TEL | TYPE | video | RFC 6350, Section 6.4.1
|
3339
|
+
| TEL | TYPE | pager | RFC 6350, Section 6.4.1
|
3340
|
+
| TEL | TYPE | textphone | RFC 6350, Section 6.4.1
|
3341
|
+
|
3342
|
+
| BDAY, ANNIVERSARY | CALSCALE | gregorian
|
3343
|
+
| RFC 6350, Section 5.8
|
3344
|
+
|
3345
|
+
| RELATED | TYPE | contact
|
3346
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3347
|
+
|
3348
|
+
| RELATED | TYPE | acquaintance
|
3349
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3350
|
+
|
3351
|
+
| RELATED | TYPE | friend
|
3352
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3353
|
+
|
3354
|
+
| RELATED | TYPE | met
|
3355
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3356
|
+
|
3357
|
+
| RELATED | TYPE | co-worker
|
3358
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3359
|
+
|
3360
|
+
| RELATED | TYPE | colleague
|
3361
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3362
|
+
|
3363
|
+
| RELATED | TYPE | co-resident
|
3364
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3365
|
+
|
3366
|
+
| RELATED | TYPE | neighbor
|
3367
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3368
|
+
|
3369
|
+
| RELATED | TYPE | child
|
3370
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3371
|
+
|
3372
|
+
| RELATED | TYPE | parent
|
3373
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3374
|
+
|
3375
|
+
| RELATED | TYPE | sibling
|
3376
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3377
|
+
|
3378
|
+
| RELATED | TYPE | spouse
|
3379
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3380
|
+
|
3381
|
+
| RELATED | TYPE | kin
|
3382
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3383
|
+
|
3384
|
+
| RELATED | TYPE | muse
|
3385
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3386
|
+
|
3387
|
+
| RELATED | TYPE | crush
|
3388
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3389
|
+
|
3390
|
+
| RELATED | TYPE | date
|
3391
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3392
|
+
|
3393
|
+
| RELATED | TYPE | sweetheart
|
3394
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3395
|
+
|
3396
|
+
| RELATED | TYPE | me
|
3397
|
+
| RFC 6350, Section 6.6.6 and cite:[xfn]
|
3398
|
+
|
3399
|
+
| RELATED | TYPE | agent | RFC 6350, Section 6.6.6
|
3400
|
+
| RELATED | TYPE | emergency | RFC 6350, Section 6.6.6
|
3401
|
+
|===
|
3402
|
+
|
3403
|
+
|
3404
|
+
[[section11]]
|
3405
|
+
== Acknowledgments
|
3406
|
+
|
3407
|
+
The authors would like to thank Tim Howes, Mark Smith, and Frank
|
3408
|
+
Dawson, the original authors of cite:[RFC2425] and cite:[RFC2426], Pete
|
3409
|
+
Resnick, who got this effort started and provided help along the way,
|
3410
|
+
as well as the following individuals who have participated in the
|
3411
|
+
drafting, review, and discussion of this memo:
|
3412
|
+
|
3413
|
+
Aki Niemi, Andy Mabbett, Alexander Mayrhofer, Alexey Melnikov, Anil
|
3414
|
+
Srivastava, Barry Leiba, Ben Fortuna, Bernard Desruisseaux, Bernie
|
3415
|
+
Hoeneisen, Bjoern Hoehrmann, Caleb Richardson, Chris Bryant, Chris
|
3416
|
+
Newman, Cyrus Daboo, Daisuke Miyakawa, Dan Brickley, Dan Mosedale,
|
3417
|
+
Dany Cauchie, Darryl Champagne, Dave Thewlis, Filip Navara, Florian
|
3418
|
+
Zeitz, Helge Hess, Jari Urpalainen, Javier Godoy, Jean-Luc Schellens,
|
3419
|
+
Joe Hildebrand, Jose Luis Gayosso, Joseph Smarr, Julian Reschke,
|
3420
|
+
Kepeng Li, Kevin Marks, Kevin Wu Won, Kurt Zeilenga, Lisa Dusseault,
|
3421
|
+
Marc Blanchet, Mark Paterson, Markus Lorenz, Michael Haardt, Mike
|
3422
|
+
Douglass, Nick Levinson, Peter K. Sheerin, Peter Mogensen, Peter
|
3423
|
+
Saint-Andre, Renato Iannella, Rohit Khare, Sly Gryphon, Stephane
|
3424
|
+
Bortzmeyer, Tantek Celik, and Zoltan Ordogh.
|
3425
|
+
|
3426
|
+
[bibliography]
|
3427
|
+
== References
|
3428
|
+
|
3429
|
+
[bibliography]
|
3430
|
+
=== Normative References
|
3431
|
+
|
3432
|
+
[bibliography]
|
3433
|
+
=== Informative References
|
3434
|
+
|
3435
|
+
bibliography::[]
|
3436
|
+
|
3437
|
+
|
3438
|
+
|
3439
|
+
|
3440
|
+
[[appendixA]]
|
3441
|
+
== Appendix A. Differences from RFCs 2425 and 2426
|
3442
|
+
|
3443
|
+
This appendix contains a high-level overview of the major changes
|
3444
|
+
that have been made in the vCard specification from RFCs 2425 and
|
3445
|
+
2426. It is incomplete, as it only lists the most important changes.
|
3446
|
+
|
3447
|
+
[[appendixA_1]]
|
3448
|
+
=== New Structure
|
3449
|
+
|
3450
|
+
* cite:[RFC2425] and cite:[RFC2426] have been merged.
|
3451
|
+
|
3452
|
+
* vCard is now not only a MIME type but a stand-alone format.
|
3453
|
+
|
3454
|
+
* A proper MIME type registration form has been included.
|
3455
|
+
|
3456
|
+
* UTF-8 is now the only possible character set.
|
3457
|
+
|
3458
|
+
* New vCard elements can be registered from IANA.
|
3459
|
+
|
3460
|
+
[[appendixA_2]]
|
3461
|
+
=== Removed Features
|
3462
|
+
|
3463
|
+
* The `CONTEXT` and `CHARSET` parameters are no more.
|
3464
|
+
|
3465
|
+
* The `NAME`, `MAILER`, `LABEL`, and `CLASS` properties are no more.
|
3466
|
+
|
3467
|
+
* The "intl", "dom", "postal", and "parcel" `TYPE` parameter values
|
3468
|
+
for the `ADR` property have been removed.
|
3469
|
+
|
3470
|
+
* In-line vCards (such as the value of the `AGENT` property) are no
|
3471
|
+
longer supported.
|
3472
|
+
|
3473
|
+
[[appendixA_3]]
|
3474
|
+
=== New Properties and Parameters
|
3475
|
+
|
3476
|
+
* The `KIND`, `GENDER`, `LANG`, `ANNIVERSARY`, `XML`, and `CLIENTPIDMAP`
|
3477
|
+
properties have been added.
|
3478
|
+
|
3479
|
+
* cite:[RFC2739], which defines the `FBURL`, `CALADRURI`, `CAPURI`, and `CALURI`
|
3480
|
+
properties, has been merged in.
|
3481
|
+
|
3482
|
+
* cite:[RFC4770], which defines the `IMPP` property, has been merged in.
|
3483
|
+
|
3484
|
+
* The "work" and "home" `TYPE` parameter values are now applicable to
|
3485
|
+
many more properties.
|
3486
|
+
|
3487
|
+
* The "pref" value of the `TYPE` parameter is now a parameter of its
|
3488
|
+
own, with a positive integer value indicating the level of
|
3489
|
+
preference.
|
3490
|
+
|
3491
|
+
* The `ALTID` and `PID` parameters have been added.
|
3492
|
+
|
3493
|
+
* The `MEDIATYPE` parameter has been added and replaces the `TYPE`
|
3494
|
+
parameter when it was used for indicating the media type of the
|
3495
|
+
property's content.
|
3496
|
+
|
3497
|
+
|
3498
|
+
|
3499
|
+
|