RFC 9554

vCard Format Extensions for JSContact

๐Ÿ“… published May 2024, from ietf

vCard Format Extensions for JSContact ๐ŸŽ€

okay bestie, this RFC is the vCard + JSContact glow-up, and it's officially a Standards Track doc ๐Ÿ’… Here's the title block tea โ˜•:

  • RFC number: 9554 โœจ
  • Authors: R. Stepanek (Fastmail) and M. Loffredo (IIT-CNR) ๐Ÿซถ
  • Category: Standards Track, which means it's an official Internet standard, not just vibes ๐Ÿ‘‘
  • Date: May 2024 ๐ŸŒธ
  • ISSN: 2070-1721
  • Published by: the Internet Engineering Task Force (IETF) ๐Ÿฆ‹
  • Updates: RFC 6350 (vCard Format Specification) ๐Ÿ’œ
  • Obsoletes: nothing listed in the header ๐Ÿ™ˆ

Abstract โœจ

ok so this doc adds a bunch of new properties to vCard and also levels up some existing ones ๐Ÿ”ฅ The main goal is to get the same features in both JSContact and vCard, so they match. The new stuff is also useful for plain vCard people who never touch JSContact ๐Ÿ’– It updates RFC 6350, the vCard Format Specification ๐Ÿงš

Status of This Memo ๐ŸŒˆ

This is an Internet Standards Track document โœจ

It's a product of the Internet Engineering Task Force (IETF), so it reflects what the IETF community agreed on. It got public review and was approved for publication by the Internet Engineering Steering Group (IESG) ๐Ÿ‘‘ If you want more on Internet Standards, check Section 2 of RFC 7841 ๐Ÿ“š

For the current status, any errata, and how to send feedback, go to https://www.rfc-editor.org/info/rfc9554 ๐Ÿ“

Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. ๐Ÿ’œ

This doc is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) as they stood when it was published. Please actually read these, because they spell out your rights and restrictions for this document ๐Ÿ™ˆ Any Code Components pulled out of this document must include the Revised BSD License text described in Section 4.e of the Trust Legal Provisions, and they come with no warranty, as the Revised BSD License says ๐Ÿ’…

This doc may include material from IETF Documents or IETF Contributions that were published or made public before November 10, 2008. Some of that copyright might belong to people who never gave the IETF Trust permission to allow changes outside the IETF Standards Process. So unless you get a proper license from whoever holds that copyright, this document can't be modified outside the IETF Standards Process, and derivative works can't be made outside it either. The exceptions are formatting it for publication as an RFC and translating it into languages other than English ๐ŸŒธ

Table of Contents ๐Ÿฆ‹

1.  Introduction
  1.1.  Notational Conventions
  1.2.  ABNF Notations
2.  Updated Properties
  2.1.  ADR
  2.2.  N
3.  New Properties
  3.1.  CREATED
  3.2.  GRAMGENDER
  3.3.  LANGUAGE
  3.4.  PRONOUNS
  3.5.  SOCIALPROFILE
4.  New Parameters
  4.1.  AUTHOR
  4.2.  AUTHOR-NAME
  4.3.  CREATED
  4.4.  DERIVED
  4.5.  LABEL
  4.6.  PHONETIC
  4.7.  PROP-ID
  4.8.  SCRIPT
  4.9.  SERVICE-TYPE
  4.10. USERNAME
5.  New Values
  5.1.  Billing Address Type Value
  5.2.  Delivery Address Type Value
6.  Security Considerations
7.  IANA Considerations
  7.1.  Changes to the vCard Properties Registry
    7.1.1.  New vCard Property Definitions
    7.1.2.  Updated vCard Properties
  7.2.  Changes to the vCard Parameters Registry
  7.3.  Changes to the vCard Property Values Registry
  7.4.  Changes to the vCard Parameter Values Registry
8.  References
  8.1.  Normative References
9.  Informative References
Acknowledgements
Authors' Addresses

1. Introduction ๐Ÿ’–

ok so JSContact [RFC9553] is basically the new-school alternative to the vCard [RFC6350] format for contact and address book data ๐Ÿฆ‹ It brings in new semantics that the current vCard definition and its extensions just don't cover โœจ Converting contact data between the two is defined in [RFC9555], and the goal is that you don't lose any meaning when you convert ๐Ÿซถ To make that work, this doc defines a new set of vCard properties and extends some existing ones ๐Ÿ”ฅ

1.1. Notational Conventions ๐ŸŒธ

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here ๐Ÿ’…

1.2. ABNF Notations ๐Ÿงš

The ABNF definitions in this doc use the notations of [RFC5234] โœจ Any ABNF rules that aren't defined here are defined in either [RFC5234] (for things like CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT) or [RFC6350] ๐Ÿ’œ

2. Updated Properties ๐ŸŽ€

2.1. ADR ๐Ÿก

This spec changes the ADR property ๐Ÿ”ฅ It adds more components to its structured value so it can handle international addresses better ๐ŸŒ It also splits up the address parts that people usually stuff into the street address component, and gives each one its own component ๐Ÿ’–

Implementations SHOULD write a combined value of these components in the street address component for backwards compatibility ๐Ÿซถ But when reading, they SHOULD ignore the street component if the ADR property value contains any of the new components โœจ

The change below is made to the first paragraph under "Special note" from Section 6.3.1 of [RFC6350] ๐Ÿฆ‹ The rest of that section in the original spec still applies ๐ŸŒธ

Special note: The structured type value consists of a sequence of address components. The component values MUST be specified in their corresponding position. The structured type value corresponds, in sequence, to the

  1. post office box;
  2. extended address (e.g., apartment or suite number);
  3. street address;
  4. locality (e.g., city);
  5. region (e.g., state or province);
  6. postal code;
  7. country name (full name in the language specified in Section 5.1 of [RFC6350]);
  8. room, suite number, or identifier;
  9. apartment number, extension designation, or box number;
  10. building floor or level;
  11. street number;
  12. street name;
  13. building, tower, or condominium;
  14. block name or number;
  15. subdistrict;
  16. district;
  17. landmark or another publicly known prominent feature that can substitute the street name and number (e.g., "White House" and "Taj Mahal"); and
  18. the cardinal direction or quadrant (e.g., "north").

The change below is made to the definition of "ADR-value" under "ABNF" from Section 6.3.1 of [RFC6350] ๐Ÿ”ฅ

ABNF

ADR-value = ; defined in RFC 6350, Section 6.3.1.:
            ADR-component-pobox ";"
            ADR-component-ext ";"
            ADR-component-street ";"
            ADR-component-locality ";"
            ADR-component-region ";"
            ADR-component-code ";"
            ADR-component-country ";"
            ; defined in this document:
            ADR-component-room ";"
            ADR-component-apartment ";"
            ADR-component-floor ";"
            ADR-component-streetnumber ";"
            ADR-component-streetname ";"
            ADR-component-building ";"
            ADR-component-block ";"
            ADR-component-subdistrict ";"
            ADR-component-district ";"
            ADR-component-landmark ";"
            ADR-component-direction

ADR-component-pobox    = list-component
ADR-component-ext      = list-component
ADR-component-street   = list-component
ADR-component-locality = list-component
ADR-component-region   = list-component
ADR-component-code     = list-component
ADR-component-country  = list-component
ADR-component-room     = list-component
ADR-component-apartment = list-component
ADR-component-floor    = list-component
ADR-component-streetnumber = list-component
ADR-component-streetname = list-component
ADR-component-building = list-component
ADR-component-block    = list-component
ADR-component-subdistrict = list-component
ADR-component-district = list-component
ADR-component-landmark = list-component
ADR-component-direction = list-component

The change below is made under "Example" from Section 6.3.1 of [RFC6350] ๐Ÿ’…

Example: In this example, the post office box and the extended address components are absent. The street number and name are both added as separate components and are combined in the street component for backwards compatibility.

ADR;GEO="geo:12.3457,78.910":
  ;;123 Main Street;Any Town;CA;91921-1234;U.S.A
  ;;;;123;Main Street;;;;;;

2.2. N ๐ŸŒˆ

This spec changes the N property too ๐Ÿ’œ It adds more name components so international names and generation markers are supported properly ๐ŸŒ That also makes it easier to format N property values with the Unicode Common Locale Data Repository (CLDR) Person Name [CLDRPersonName] formatting standard โœจ

One new component is for secondary surnames. In some cultures these are used to show the paternal and maternal family names, or generational names like father or grandfather ๐Ÿซถ Another new component holds a generation ("II", "XVI") or a parental relation ("Jr.", "Sr.") ๐Ÿฆ‹

Right now, implementations usually put secondary surnames in the family name component and generational markers in the honorific suffixes component ๐Ÿ™ˆ For backwards compatibility, implementations SHOULD add those values to both the new components and their backwards-compatible counterparts ๐Ÿ”ฅ When reading N property values, implementations SHOULD ignore any value in the backwards-compatible component if an equal value is set in the new component ๐Ÿ’– For example, a "Jr." that shows up in both honorific suffixes and generation should only be handled as a generational marker ๐Ÿ’…

The change below is made to the first paragraph under "Special note" from Section 6.2.2 of [RFC6350] ๐ŸŒธ The rest of that section in the original spec still applies โœจ

Special note: The structured property value corresponds, in sequence, to the

  1. family names (also known as surnames);
  2. given names;
  3. additional names;
  4. honorific prefixes;
  5. honorific suffixes;
  6. secondary surname; and
  7. generation.

The change below is made under "ABNF" from Section 6.2.2 of [RFC6350] ๐Ÿงš

ABNF

N-param = "VALUE=text" / sort-as-param / language-param
             / altid-param / any-param
N-value = list-component 6(";" list-component)

The change below is made under "Examples" from Section 6.2.2 of [RFC6350] ๐Ÿฆ‹

Examples

N:Public;John;Quinlan;Mr.;Esq.

N:Stevenson;John;Philip,Paul;Dr.;Jr.,M.D.,A.C.P.;;Jr.

No change is needed to the definition of the SORT-AS parameter, but the new components also apply when you use that parameter ๐ŸŽ€


3. New Properties โœจ

3.1. CREATED ๐ŸŒธ

Property name: CREATED

Purpose: This tells you the exact moment a vCard was born ๐Ÿผ

Value type: A single timestamp value.

Cardinality: *1

Property parameters: VALUE

Description: This is the timestamp for when the vCard was created. Copying a vCard between systems does NOT count as a new creation or a new revision ๐Ÿ™…โ€โ™€๏ธ The timestamp usually stays the same for as long as the vCard exists, so it's giving stable and reliable vibes โœจ

Format definition:

created       = "CREATED" createdparam ":" timestamp

createdparam  = *(
                 ;
                 ; The following are OPTIONAL
                 ; but MUST NOT occur more than once.
                 ;
                 (";" "VALUE" "=" "timestamp") /
                 ;
                 ; The following are OPTIONAL
                 ; and MAY occur more than once.
                 ;
                 (";" any-param)
                 ;
                 )

Example(s):

CREATED:20220705T093412Z
CREATED;VALUE=TIMESTAMP:20211022T140000-05

3.2. GRAMGENDER ๐ŸŽ€

Property name: GRAMGENDER

Purpose: This picks which grammatical gender gets used in salutations and other grammar stuff ๐Ÿ’…

Value type: A single text value that is restricted to an enumerated list of allowed values.

Cardinality: *

Property parameters: LANGUAGE

Description: This property sets the grammatical gender the contact wants to be addressed by or referred to as, in written or spoken form. Languages like German are literally obsessed with gender in greetings, like "Sehr geehrte" (feminine) and "Sehr geehrter" (masculine) ๐Ÿงš Multiple occurrences of this property MUST be distinguished by the LANGUAGE parameter, so each one is clearly tied to its own language ๐ŸŒˆ

Format definition:

gramgender       = "GRAMGENDER" gramgender-param
                      ":" gramgender-value

gramgender-param =
                *(
                 ;
                 ; The following are OPTIONAL
                 ; but MUST NOT occur more than once.
                 ;
                 (";" language-param) /
                 ;
                 ; The following are OPTIONAL
                 ; and MAY occur more than once.
                 ;
                 (";" any-param)
                 ;
                 )

gramgender-value = "animate" /
                   "common" /
                   "feminine" /
                   "inanimate" /
                   "masculine" /
                   "neuter" /
                   iana-token /
                   x-name

Example(s):

GRAMGENDER;LANGUAGE=de:feminine

3.3. LANGUAGE ๐Ÿฆ‹

Property name: LANGUAGE

Purpose: This sets the default language that the human-readable text in this vCard is assumed to be written in ๐ŸŒ

Value type: A single Language-Tag value as defined in Section 4 of [RFC6350].

Cardinality: *1

Property parameters: The LANGUAGE parameter MUST NOT be assigned to this property. ๐Ÿšซ It's a property-level thing only, bestie.

Description: This property sets the language that TEXT-type property values in this vCard are assumed to be written in. If a vCard property includes the LANGUAGE parameter, then that parameter value has higher precedence than the LANGUAGE property value ๐Ÿ‘‘ So the more specific one wins, no cap.

Format definition:

language-prop       = "LANGUAGE" any-param ":" Language-Tag
               ; Language-Tag is defined in RFC 6350, Section 4.

Example(s):

LANGUAGE:de-AT

3.4. PRONOUNS ๐Ÿ’œ

Property name: PRONOUNS

Purpose: This defines the pronouns that shall be used to refer to the entity represented by this vCard ๐Ÿซถ

Value type: A single text value.

Cardinality: *

Property parameters: LANGUAGE, PREF, TYPE, ALTID

Description: This property holds the pronouns the contact picks for themselves, and it's free-form text. These pronouns shall be used when addressing or referring to the contact, so respect the pronouns, periodt ๐Ÿ’– Multiple occurrences of this property MAY define pronouns for multiple languages, preferences, and contexts, which is a very main character move ๐ŸŒธ Multiple pronouns in the same language SHOULD use the PREF parameter. Otherwise, the order of preference is implementation-specific ๐Ÿคทโ€โ™€๏ธ

Format definition:

pronouns       = "PRONOUNS" pronouns-param ":" text

pronouns-param =
                *(
                 ;
                 ; The following are OPTIONAL
                 ; but MUST NOT occur more than once.
                 ;
                 (";" language-param) /
                 (";" pref-param) /
                 (";" type-param) /
                 (";" altid-param) /
                 ;
                 ; The following are OPTIONAL
                 ; and MAY occur more than once.
                 ;
                 (";" any-param)
                 ;
                 )

Example(s):

PRONOUNS;LANGUAGE=en;PREF=1:xe/xir
PRONOUNS;LANGUAGE=en;PREF=2:they/them

3.5. SOCIALPROFILE ๐Ÿ“

Property name: SOCIALPROFILE

Purpose: This gives the URI or username for social media profiles linked to the object the vCard represents ๐Ÿ“ฑ

Value type: A single URI or TEXT value. The default value type is URI.

Cardinality: *

Property parameters: The SERVICE-TYPE parameter MUST be assigned to this property if the value type is TEXT, and it MAY be assigned if the value type is URI. In either case, it MUST NOT be assigned more than once. ๐ŸŽฏ

Description: Lots of vCard address book apps are already using an experimental X-SOCIALPROFILE property to store social profiles for contacts. This specification gives us an IANA-registered property for the same purpose, which is so iconic โœจ On top of the usual URI values, it also lets you set usernames for social media services as free-text TEXT values. In that case the service name MUST be provided as a parameter. Names MUST be considered equal if they match case-insensitively, so "Peter94" and "peter94" are the same person ๐Ÿ™ˆ

Format definition:

socialpr       = "SOCIALPROFILE" socialpr-param ":"
                                 socialpr-value

socialpr-param = "VALUE=uri" / "VALUE=text" /
                 service-type-param / any-param

socialpr-value = URI / text

Example(s):

SOCIALPROFILE;SERVICE-TYPE=Mastodon:https://example.com/@foo
SOCIALPROFILE:https://example.com/ietf
SOCIALPROFILE;SERVICE-TYPE=SomeSite;VALUE=text:peter94

4. New Parameters โœจ

4.1. AUTHOR ๐Ÿ–‹๏ธ

Parameter name: AUTHOR

Purpose: This tells you who wrote the associated property value ๐Ÿ“

Description: This parameter MAY be set on any property where you want to show authorship. It identifies the author as a URI [RFC3986]. Since every valid URI includes the COLON (U+003A) character, the parameter value MUST be quoted ๐Ÿ’… As an alternative or in addition to this parameter, the AUTHOR-NAME parameter lets you name an author with free-text (see Section 4.2).

Format definition:

author-param    = "AUTHOR" "=" DQUOTE URI DQUOTE

Example(s):

NOTE;AUTHOR="mailto:john@example.com":This is some note.

4.2. AUTHOR-NAME ๐ŸŒท

Parameter name: AUTHOR-NAME

Purpose: This names the author of the associated property value ๐Ÿท๏ธ

Description: This parameter MAY be set on any property where you want to show authorship. It names the author as a free-text value. The parameter value MUST NOT be empty ๐Ÿ™…โ€โ™€๏ธ Implementations MUST take care to quote the name part. If they don't, the part won't be a valid "param-value" (see Section 3.3 of [RFC6350]), and that's a whole mess ๐Ÿ’€ As an alternative or in addition to this parameter, the AUTHOR parameter lets you identify an author by URI (see Section 4.1).

Format definition:

author-name-param    = "AUTHOR-NAME" "=" param-value ; not empty

Example(s):

NOTE;AUTHOR-NAME=John Doe:This is some note.
NOTE;AUTHOR-NAME="_:l33tHckr:_":A note by an unusual author name.

4.3. CREATED ๐Ÿ•ฐ๏ธ

Parameter name: CREATED

Purpose: This defines the date and time when a property was created in a vCard โฐ

Description: This parameter MAY be set on any property to define the point in time when that property was created. The value MUST be a valid TIMESTAMP value as defined in Section 4.3.5 of [RFC6350]. Generally, updating a property value SHOULD NOT change the creation timestamp, because the origin story stays the origin story ๐ŸŽฌ

Format definition:

created-param = "CREATED" "=" param-value
             ; a valid TIMESTAMP of Section 4.3.5 of RFC 6350

Example(s):

NOTE;CREATED=20221122T151823Z:This is some note.

4.4. DERIVED ๐Ÿช„

Parameter name: DERIVED

Purpose: This says that the value of the associated property is derived from other property values in the same vCard ๐Ÿ”ฎ

Description: This property parameter SHOULD be specified on a property if that property value is derived from other properties in the same vCard. When it's present with a value of "true", clients MUST NOT update the property ๐Ÿ™Œ

As an example, an implementation may derive the value of the FN property from the name components of the N property. It shows this by setting the DERIVED parameter on the FN property to "true" ๐Ÿงš

Format definition:

derived-param    = "DERIVED" "=" ("true" / "false")
; Default is false

Example(s):

N:;John;Quinlan;Mr.;
FN;DERIVED=TRUE:Mr. John Quinlan

4.5. LABEL ๐Ÿ“ฎ

Parameter name: LABEL

Purpose: Used with the ADR property. Its value holds a formatted text version of that address, like for delivery ๐Ÿ“ฆ

Description: Section 6.3.1 of [RFC6350] defines the ADR property and notes that the property can also include a LABEL parameter to show a delivery address label for the address. But this parameter was never added to the IANA "vCard Parameters" registry (Section 10.3.2 of [RFC6350]), so it isn't a registered standard vCard element. Oof ๐Ÿ˜ญ This specification defines and registers the LABEL parameter for use with the ADR property, the way it was originally meant to work ๐ŸŽ‰

Format definition:

label-param    = "LABEL" "=" param-value

Example(s): The LABEL parameter as shown in the ADR property example in Section 6.3.1 of [RFC6350].

ADR;LABEL="Mr. John Q. Public, Esq.\nMail Drop: TNE QB\n123
  Main Street\nAny Town, CA  91921-1234\nU.S.A.":
  ;;123 Main Street;Any Town;CA;91921-1234;U.S.A.

4.6. PHONETIC ๐ŸŽ€

Parameter name: PHONETIC

Okay so PHONETIC is the parameter that tells you how to say something ๐Ÿ—ฃ๏ธ It basically means "this value is the sounds-like version of another same-named property in the same vCard." The big examples are pronouncing Japanese names and romanizing Mandarin or Cantonese names and address parts. Iconic, honestly ๐Ÿ‡ฏ๐Ÿ‡ตโœจ

Purpose: Defines how to pronounce the value of another property in the same vCard.

Description: The parameter value names the phonetic system, and it MUST be one of the values listed in the IANA "vCard Parameter Values" registry (Section 7.4). This spec defines these values:

  • ipa: the International Phonetic Alphabet [IPA] ๐Ÿ”ค
  • jyut: Cantonese romanization called "Jyutping" ๐ŸŒถ๏ธ
  • piny: Standard Mandarin romanization called "Hanyu Pinyin" ๐Ÿœ
  • script: the unknown phonetic system. The SCRIPT (Section 4.8) parameter MUST be set in addition to the PHONETIC parameter ๐Ÿซถ

The value type of the property where PHONETIC is set MUST be the same type as its related property. If a component value is set on the property with PHONETIC, then a component value MUST also be set at that same position in the related property. On the flip side, not every component value in the related property needs a phonetic representation ๐Ÿ’…

Now the ALTID thing, which is a whole vibe. The ALTID (Section 5.4 of [RFC6350]) parameter MUST be set with equal values on both the related property and the property that has PHONETIC set. If more than one same-named property has both PHONETIC set and an equal ALTID value, then at most one of them MAY not have the LANGUAGE parameter set, and all the others MUST have it. The LANGUAGE parameters MUST NOT have equal values. The LANGUAGE parameter value SHOULD NOT contain a script subtag in its Language-Tag value, and any such subtag MUST be ignored in favor of the SCRIPT (Section 4.8) parameter value. Bestie, that's a lot of rules, but they're all there for a reason ๐Ÿ™ˆ

This specification defines the PHONETIC parameter for use with the ADR and N properties ๐Ÿ 

Format definition:

phonetic-param = "PHONETIC=" phonetic-value

phonetic-value = "ipa" / "piny" / "jyut" / "script" /
                 iana-token / x-name

Example(s):

N;ALTID=1;LANGUAGE=zh-Hant:ๅญซ;ไธญๅฑฑ;ๆ–‡,้€ธไป™;;;;
N;ALTID=1;PHONETIC=jyut;
  SCRIPT=Latn;LANGUAGE=yue:syun1;zung1saan1;man4,jat6sin1;;;;

4.7. PROP-ID ๐Ÿชช

Parameter name: PROP-ID

Purpose: Identifies a property among all its siblings of the same property name.

Description: This parameter uniquely identifies a property among all of its siblings with the same name inside a vCard. A valid PROP-ID value must be between 1 and a maximum of 255 octets in size, and it MUST only contain ASCII alphanumeric characters ("A-Za-z0-9"), hyphen (-), and underscore ("_"). The identifier's only job is to uniquely identify siblings. Its value has no other meaning, so don't read anything into it ๐Ÿ™…โ€โ™€๏ธ If an application uses PROP-ID, it SHOULD assign a unique identifier to each sibling property of the same name within their embedding component. The same identifier MAY be used for properties with a different name, and it MAY also be assigned to a same-named property that is not a sibling.

Resolving duplicate identifier conflicts is up to the application. Similarly, handling properties where only some siblings have a PROP-ID assigned is application-specific too ๐ŸŒธ

Format definition:

prop-id-param  = "PROP-ID" "=" 1*255(ALPHA / DIGIT / "-"/ "_")

Example(s):

PHOTO;PROP-ID=p827:data:image/jpeg;base64,MIICajCCAdOgAwIBAg
        <...remainder of base64-encoded data...>

4.8. SCRIPT ๐Ÿ–‹๏ธ

Parameter name: SCRIPT

Purpose: Defines the script that a property value is written in.

Description: This parameter lets you set a script for a property value without also naming a language, which is what the LANGUAGE parameter would do. The value MUST be a script subtag as defined in Section 2.2.3 of [RFC5646]. This specification uses the SCRIPT parameter together with the PHONETIC (Section 4.6) parameter ๐Ÿ’œ

Format definition:

script-param = 4ALPHA

Example(s):

SCRIPT=Latn

4.9. SERVICE-TYPE ๐Ÿ“ฑ

Parameter name: SERVICE-TYPE

Purpose: Defines the online service name associated with a messaging or social media profile.

Description: This parameter MAY be specified on an Instant Messaging and Presence Protocol (IMPP) or a SOCIALPROFILE property to name the online service linked to that property value. Its value is case-sensitive, and its letter cases MUST be preserved. Capital letters stay capital, bestie ๐Ÿ” 

Several vCard address book implementations currently use an experimental X-SERVICE-TYPE parameter. This specification provides an IANA-registered parameter for the same purpose ๐Ÿฆ‹

Format definition:

service-type-param    = "SERVICE-TYPE" "=" param-value

Example(s):

SOCIALPROFILE;SERVICE-TYPE=Mastodon:https://example.com/@foo

4.10. USERNAME ๐Ÿ™‹โ€โ™€๏ธ

Parameter name: USERNAME

Purpose: Defines a username, such as the user of a messaging or social media service.

Description: This parameter MAY be specified on an IMPP or a SOCIALPROFILE property to name the user with that property value. Its value is case-sensitive, and its letter cases MUST be preserved. The IMPP or SOCIALPROFILE value type MUST be URI ๐Ÿ”—

Format definition:

username-param    = "USERNAME" "=" param-value

Example(s):

SOCIALPROFILE;USERNAME="The Foo":https://example.com/@foo

5. New Values ๐ŸŒˆ

5.1. Billing Address Type Value ๐Ÿ’ธ

Value: billing

Purpose: Indicates using this address for billing, e.g., to send invoices to.

Conformance: This value can be used with the TYPE parameter applied on the ADR property.

Example(s):

ADR;TYPE=billing:;;123 Main Street;Any Town;CA;91921-1234;U.S.A.

5.2. Delivery Address Type Value ๐Ÿ“ฆ

Value: delivery

Purpose: Indicates using this address for delivery, e.g., to send packages to.

Conformance: This value can be used with the TYPE parameter applied on the ADR property.

Example(s):

ADR;TYPE=delivery:;;123 Main Street;Any Town;CA;91921-1234;U.S.A.

6. Security Considerations ๐Ÿ”

This specification extends "vCard Format Specification" [RFC6350]. The same security considerations as outlined in Section 9 of [RFC6350] apply. Read that section too, it's giving serious "lock your diary" energy ๐Ÿ”’


7. IANA Considerations ๐Ÿ—‚๏ธ

7.1. Changes to the vCard Properties Registry ๐Ÿ“‹

7.1.1. New vCard Property Definitions โœจ

IANA has added the following entries to the "vCard Properties" registry, as defined in Section 10.3.1 of [RFC6350].

        +===========+===============+=======================+
        | Namespace | Property      | Reference             |
        +===========+===============+=======================+
        |           | CREATED       | RFC 9554, Section 3.1 |
        +-----------+---------------+-----------------------+
        |           | GRAMGENDER    | RFC 9554, Section 3.2 |
        +-----------+---------------+-----------------------+
        |           | LANGUAGE      | RFC 9554, Section 3.3 |
        +-----------+---------------+-----------------------+
        |           | PRONOUNS      | RFC 9554, Section 3.4 |
        +-----------+---------------+-----------------------+
        |           | SOCIALPROFILE | RFC 9554, Section 3.5 |
        +-----------+---------------+-----------------------+

                    Table 1: New vCard Properties

7.1.2. Updated vCard Properties ๐Ÿ”„

IANA has added Section 2.1 of this document as a reference for the ADR property, and Section 2.2 of this document as a reference for the N property, in the "vCard Properties" registry.

7.2. Changes to the vCard Parameters Registry ๐Ÿท๏ธ

IANA has added the following entries to the "vCard Parameters" registry, as defined in Section 10.3.2 of [RFC6350].

      +===========+==============+===========================+
      | Namespace | Parameter    | Reference                 |
      +===========+==============+===========================+
      |           | AUTHOR       | RFC 9554, Section 4.1     |
      +-----------+--------------+---------------------------+
      |           | AUTHOR-NAME  | RFC 9554, Section 4.2     |
      +-----------+--------------+---------------------------+
      |           | CREATED      | RFC 9554, Section 4.3     |
      +-----------+--------------+---------------------------+
      |           | DERIVED      | RFC 9554, Section 4.4     |
      +-----------+--------------+---------------------------+
      |           | LABEL        | [RFC6350], Section 6.3.1  |
      |           |              | and RFC 9554, Section 4.5 |
      +-----------+--------------+---------------------------+
      |           | PHONETIC     | RFC 9554, Section 4.6     |
      +-----------+--------------+---------------------------+
      |           | PROP-ID      | RFC 9554, Section 4.7     |
      +-----------+--------------+---------------------------+
      |           | SCRIPT       | RFC 9554, Section 4.8     |
      +-----------+--------------+---------------------------+
      |           | SERVICE-TYPE | RFC 9554, Section 4.9     |
      +-----------+--------------+---------------------------+
      |           | USERNAME     | RFC 9554, Section 4.10    |
      +-----------+--------------+---------------------------+

                    Table 2: New vCard Parameters

7.3. Changes to the vCard Property Values Registry ๐ŸŽจ

IANA has added the following entries to the "vCard Property Values" registry, as defined in Section 10.3.4 of [RFC6350].

         +============+===========+=======================+
         | Property   | Value     | Reference             |
         +============+===========+=======================+
         | GRAMGENDER | animate   | RFC 9554, Section 3.2 |
         +------------+-----------+-----------------------+
         | GRAMGENDER | common    | RFC 9554, Section 3.2 |
         +------------+-----------+-----------------------+
         | GRAMGENDER | feminine  | RFC 9554, Section 3.2 |
         +------------+-----------+-----------------------+
         | GRAMGENDER | inanimate | RFC 9554, Section 3.2 |
         +------------+-----------+-----------------------+
         | GRAMGENDER | masculine | RFC 9554, Section 3.2 |
         +------------+-----------+-----------------------+
         | GRAMGENDER | neuter    | RFC 9554, Section 3.2 |
         +------------+-----------+-----------------------+

                 Table 3: New vCard Property Values

7.4. Changes to the vCard Parameter Values Registry โœจ

okay so IANA added some new entries to the "vCard Parameter Values" registry ๐Ÿ’… This is the one from Section 10.3.4 of [RFC6350], so it's giving official paperwork energy ๐Ÿ“‹ Here's the whole table, babe:

     +==========+===========+==========+=======================+
     | Property | Parameter | Value    | Reference             |
     +==========+===========+==========+=======================+
     | ADR      | TYPE      | billing  | RFC 9554, Section 5.1 |
     +----------+-----------+----------+-----------------------+
     | ADR      | TYPE      | delivery | RFC 9554, Section 5.2 |
     +----------+-----------+----------+-----------------------+
     | ADR, N   | PHONETIC  | ipa      | RFC 9554, Section 4.6 |
     +----------+-----------+----------+-----------------------+
     | ADR, N   | PHONETIC  | jyut     | RFC 9554, Section 4.6 |
     +----------+-----------+----------+-----------------------+
     | ADR, N   | PHONETIC  | piny     | RFC 9554, Section 4.6 |
     +----------+-----------+----------+-----------------------+
     | ADR, N   | PHONETIC  | script   | RFC 9554, Section 4.6 |
     +----------+-----------+----------+-----------------------+

           Table 4: New vCard Property and Parameter Values

The main vibe: billing and delivery are new TYPE values for ADR ๐Ÿ , and ipa, jyut, piny, and script are new PHONETIC values for both ADR and N ๐ŸŽ€. The Reference column tells you exactly where each one is explained, so no guessing ๐Ÿ”


8. References ๐Ÿ“š

8.1. Normative References ๐Ÿ’–

These are the references the spec needs in order to make sense, bestie ๐Ÿซถ

[RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
           Requirement Levels", BCP 14, RFC 2119,
           DOI 10.17487/RFC2119, March 1997,
           <https://www.rfc-editor.org/info/rfc2119>.

[RFC3986]  Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
           Resource Identifier (URI): Generic Syntax", STD 66,
           RFC 3986, DOI 10.17487/RFC3986, January 2005,
           <https://www.rfc-editor.org/info/rfc3986>.

[RFC5234]  Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
           Specifications: ABNF", STD 68, RFC 5234,
           DOI 10.17487/RFC5234, January 2008,
           <https://www.rfc-editor.org/info/rfc5234>.

[RFC5646]  Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
           Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646,
           September 2009, <https://www.rfc-editor.org/info/rfc5646>.

[RFC6350]  Perreault, S., "vCard Format Specification", RFC 6350,
           DOI 10.17487/RFC6350, August 2011,
           <https://www.rfc-editor.org/info/rfc6350>.

[RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
           2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
           May 2017, <https://www.rfc-editor.org/info/rfc8174>.

[RFC9553]  Stepanek, R. and M. Loffredo, "JSContact: A JSON
           Representation of Contact Data", RFC 9553,
           DOI 10.17487/RFC9553, May 2024,
           <https://www.rfc-editor.org/info/rfc9553>.

[RFC9555]  Loffredo, M. and R. Stepanek, "JSContact: Converting from
           and to vCard", RFC 9555, DOI 10.17487/RFC9555, May 2024,
           <https://www.rfc-editor.org/info/rfc9555>.

9. Informative References ๐ŸŒธ

These ones are extra reading, so you don't need them to get the spec, but they're super helpful ๐Ÿงš

[CALCONNECT-VOBJECT]
           Tse, R., Tam, P., and M. Douglass, "vObject
           Internationalization", Work in Progress, Internet-Draft,
           draft-calconnect-vobject-i18n-00, 8 June 2018,
           <https://datatracker.ietf.org/doc/html/draft-calconnect-
           vobject-i18n-00>.

[CLDRPersonName]
           Davis, M., Edberg, P., Gillam, R., Kolisnychenko, A.,
           McKenna, M., and other CLDR committee members, "Unicode
           Locale Data Markup Language (LDML) Part 8: Person Names",
           Unicode Technical Standard #35, Version 44.1, July 2023,
           <https://www.unicode.org/reports/tr35/
           tr35-personNames.html>.

[IPA]      IPA, "International Phonetic Alphabet",
           <https://www.internationalphoneticalphabet.org/>.

Acknowledgements ๐Ÿซถ

okay shoutout time ๐Ÿ“ฃ The definition and examples of the PHONETIC (Section 4.6) and SCRIPT (Section 4.8) parameters are based on the early draft version of [CALCONNECT-VOBJECT]. Main character energy from that draft ๐Ÿ‘‘

Authors' Addresses ๐Ÿ’Œ

Here's how to reach the authors, iykyk ๐Ÿฆ‹

Robert Stepanek
Fastmail
PO Box 234
Collins St. West
Melbourne VIC 8007
Australia
Email: rsto@fastmailteam.com


Mario Loffredo
IIT-CNR
Via Moruzzi, 1
56124 Pisa
Italy
Email: mario.loffredo@iit.cnr.it

And that's a wrap on RFC 9554!! ๐ŸŒˆ๐Ÿ’–โœจ

๐Ÿ“ฆ where this page comes from