vCARD Schema From: http://metadata.net/dstc/vCARD/schema.txt See also: http://metadata.net Date: 980820 -- vCARD Schema -- -- vCARD attribute description url 'vCard.html' prefix 'VCARD' label 'vCard' icon syntax container attributes set FN, N, PHOTO, BDAY, ADR, LABEL, TEL, EMAIL, MAILER, TZ, GEO, TITLE, ROLE, LOGO, AGENT, ORG, NOTE, REV, SOUND, URL, UID, VERSION, KEY FN attribute description 'This property specifies the formatted name string associated with the vCard object. This is the way that the name is to be displayed. It can contain desired honorific prefixes, suffixes, titles, etc. For example, "Mr. John Q. Public, Jr.", Dr. Ann Tyler, or Hon. Judge Blackwell. This property is based on the semantics of the X.520 Common Name attribute. This property is identified by the property name FN. The following is an example of the Formatted Name property: FN:Mr. John Q. Public, Esq. Support for this property is optional for vCard Writers conforming to this specification.' label 'Formatted Name' optional single valued syntax string schemes 'X520' scheme N attribute description 'This property specifies a structured representation of the name of the person, place or thing associated with the vCard object. This property is identified by the property name N. This property is defined to encapsulate the individual components of an objects name. The property value consists of the components of the name specified as positional fields separated by the Field Delimiter character (ASCII decimal 59). The property value is a concatenation of the Family Name (first field), Given Name (second field), Additional Names (third field), Name Prefix (fourth field), and Name Suffix (fifth field) strings. The following is an example of the Name property for a person: N:Public;John;Quinlan;Mr.;Esq. The following is an example of the Name property for a resource or place: N:Veni, Vidi, Vici;The Restaurant. Support for this property is mandatory for vCard Writers conforming to this specification. All vCard data streams should include this property to facilitate a common property for collating and sorting of vCard objects.' label 'Name' mandatory single valued syntax string PHOTO attribute description 'This property specifies an image or photograph of the individual associated with the vCard. The property is identified by the property name PHOTO. For example, the following syntax is an example of a referenced image file: PHOTO;VALUE=URL:file:///jqpublic.gif The following example is the syntax for including an inline GIF image file, using the Base 64 encoding: PHOTO;ENCODING=BASE64;TYPE=GIF: R0lGODdhfgA4AOYAAAAAAK+vr62trVIxa6WlpZ+fnzEpCEpzlAha/0Kc74+PjyGM SuecKRhrtX9/fzExORBSjCEYCGtra2NjYyF7nDGE50JrhAg51qWtOTl7vee1MWu1 50o5e3PO/3sxcwAx/4R7GBgQOcDAwFoAQt61hJyMGHuUSpRKIf8A/wAY54yMjHtz ... Support for this property is optional for vCard Writers conforming to this specification.' label 'Photograph' optional single valued syntax string schemes 'URI' scheme, 'GIF' scheme, 'CGM' scheme, 'WMF' scheme, 'BMP' scheme, 'MET' scheme, 'PMB' scheme, 'DIB' scheme, 'PICT' scheme, 'TIFF' scheme, 'PS' scheme, 'PDF' scheme, 'JPEG' scheme, 'MPEG' scheme, 'MPEG2' scheme, 'AVI' scheme, 'QTIME' scheme BDAY attribute description 'This property specifies the date of birth of the individual associated with the vCard. The value for this property is a calendar date in a complete representation consistent with ISO 8601. This property is identified by the property name BDAY. The property value is a string conforming to the ISO 8601 calendar date, complete representation, in either basic or extended format. The following example is in the basic format of ISO 8601: BDAY:19950415 The following example is in the extended format of ISO 8601: BDAY:1995-04-15 Support for this property is optional for vCard Writers conforming to this specification.' label 'Birthdate' optional single valued syntax string schemes 'ISO8601' scheme ADR attribute description 'This property specifies a structured representation of the physical delivery address for the vCard object. The property is made up of components that are based on the X.500 Post Office Box attribute, the X.520 Street Address geographical attribute, the X.520 Locality Name geographical attribute, the X.520 State or Province Name geographical attribute, the X.520 Postal Code attribute, and the X.520 Country Name geographical attribute. This property is identified by the property name ADR. The property value consists of components of the address specified as positional fields separated by the Field Delimiter character (ASCII decimal 59). The property value is a concatenation of the Post Office Address (first field) Extended Address (second field), Street (third field), Locality (fourth field), Region (fifth field), Postal Code (six field), and Country (seventh field) strings. An example of this property follows: ADR;DOM;HOME:P.O. Box 101;Suite 101;123 Main Street;Any Town;CA;91921-1234; Support for this property is optional for vCard Writers conforming to this specification.' label 'Delivery Address' optional repeatable syntax string schemes 'X500/X520' scheme, 'DOM' type, 'INTL' type, 'POSTAL' type, 'PARCEL' type, 'HOME' type, 'WORK' type LABEL attribute description 'This property specifies the addressing label for physical delivery to the person/object associated with the vCard. The property is intended to include the information necessary to create a formatted delivery address label. Typical information includes the name, street address, possibly a Post Office or mail drop, city, state or province, zip or postal code. An international delivery label would also include the country name. This property is based on the semantics of the X.520 Postal Address attribute. This specification has added semantics to those defined by the X.500 Series standard for differentiating Home, Work, Parcel, Postal, Domestic, and International delivery label types. This property is identified by the property name LABEL. This property specifies the formatted delivery address label for the vCard object. An example of a domestic delivery label follows: LABEL;DOM;POSTAL;ENCODING=QUOTED-PRINTABLE:P. O. Box 456=0D=0A= 123 Main Street=0D=0A= Any Town, CA 91921-1234 An example of an international delivery label follows: LABEL;INTL;PARCEL,ENCODING=QUOTED-PRINTABLE:Suite 101=0D=0A= 123 Main Street=0D=0A= Any Town, CA 91921-1234=0D=0A= U.S.A. Support for this property is optional for vCard Writers conforming to this specification. A vCard Reader supporting this property and conforming to this specification should support a minimum of four lines of text for this property.' label 'Delivery Label' optional repeatable syntax string schemes 'X520' scheme, 'DOM' type, 'INTL' type, 'POSTAL' type, 'PARCEL' type, 'HOME' type, 'WORK' type TEL attribute description 'This property specifies the canonical number string for a telephone number for telephony communication with the vCard object. The value of this property is specified in a canonical form in order to specify an unambiguous representation of the globally unique telephony endpoint. This property is based on the X.520 Telephone Number attribute. The canonical form cannot be dialed without first being transformed by a dialing algorithm. The dialing algorithm combines the canonical number string with knowledge of the local dialing procedures, in effect at the time of call placement to produce actual dialing instructions. The actual dialing algorithm is outside the scope of this specification. Two important canonical forms allowed by this specification are: * Apple Computer`s Representation of a Canonical Static DeviceID in The Telephony Suite, version 1.0, * Microsoft TAPI in the Microsoft Windows 3.1 Telephony Programmer`s Guide, version 1.0. Software which creates this property can store a string in these allowed formats. Dialing software should be prepared to parse numbers from either of the supported formats; as neither format is considered to be technically costly to support. This property is identified by the property name TEL. An example of this property follows: TEL;PREF;WORK;MSG;FAX:+1-800-555-1234 Support for this property is optional for vCard Writers conforming to this specification.' label 'Telephone Number' optional repeatable syntax string schemes 'X520' scheme, 'PREF' type, 'WORK' type, 'HOME' type, 'VOICE' type, 'FAX' type, 'MSG' type, 'CELL' type, 'PAGER' type, 'BBS' type, 'MODEM' type, 'CAR' type, 'ISDN' type, 'VIDEO' type EMAIL attribute description 'This property specifies the address for electronic mail communication with the vCard object. The address is in the form of a specific addressing type. For example, the Internet mail address for John Public might be "John.Public@abc.com" or the CompuServe Information Service address might be "71234,5678".This property is identified by the property name EMAIL. An example of this property follows: EMAIL;INTERNET:john.public@abc.com Support for this property is optional for vCard Writers conforming to this specification.' label 'Electronic Mail' optional repeatable syntax string schemes 'AOL' scheme, 'AppleLink' scheme, 'ATTMail' scheme, 'CIS' scheme, 'eWorld' scheme, 'INTERNET' scheme, 'IBMMail' scheme, 'MCIMail' scheme, 'POWERSHARE' scheme, 'PRODIGY' scheme, 'TLX' scheme, 'X400' scheme MAILER attribute description 'This property parameter specifies the type of electronic mail software that is in use by the individual associated with the vCard object. This information may provide assistance to a correspondent regarding the type of data representation which can be used, and how they may be packaged. This property parameter is based on currently accepted practices within the Internet MIME community with the "X-Mailer" header field. This property is identified by the property name MAILER. Support for this property is optional for vCard Writers conforming to this specification. An example of this property follows: MAILER:ccMail 2.2' label 'Mailer' optional repeatable syntax string schemes 'MIME' scheme TZ attribute description 'This property specifies information related to the standard time zone of the vCard object. The time zone is a string as specified in a manner consistent with ISO 8601. It is an offset from Coordinated Universal Time (UTC). An ISO 8601 UTC offset, in basic format, is specified as a positive or negative difference in units of hours and minutes (e.g., +hhmm). If minutes are zero, then they may be omitted and the format would be specified in units of hours (e.g., +hh). The time is specified as a 24-hour clock. Hour values are from 00 to 24, and minute values are from 00 through 59. Hour and minute values are 2-digits with high-order zeroes required to maintain digit count. The extended format for ISO 8601 makes use of a colon (i.e., ":") character as a separator of the hour and minute substrings. This is not a property for capturing the daylight savings time rules observed by the vCard object. This property is identified by the property name TZ. This property is specified in a manner consistent with ISO 8601. The property value is a signed numeric indicating the number of hours and possibly minutes from UTC. Time zones east of UTC are positive numbers. Time zones west of UTC are negative numbers. Support for this property is optional for vCard Writers conforming to this specification. An example of the Eastern Standard Time (EST) zone value for this property follows using the basic format: TZ:-0500 An example of the Pacific Standard Time (PST) zone value for this property follows using the extended format: TZ:-08:00' label 'Time Zone' syntax string schemes 'ISO8601' scheme, 'EST' type, 'PST' type GEO attribute description 'This property specifies information related to the global positioning of the vCard object. The property specifies a longitude and latitude. The latitude represents the location north and south of the equator as a positive or negative number, respectively. The longitude represents the location east and west of the prime meridian as a positive or negative number, respectively. The rationale behind providing support for this property is that it is relatively simple for a vCard object to provide this information compared with how difficult it would be for a receiver of a vCard to determine the global location through some other means. This property is identified by the property name GEO. An example of this property follows: GEO:37.24,-17.87 Support for this property is optional for vCard Writers conforming to this specification.' label 'Geographic Position' optional repeatable syntax string schemes 'LongLat' scheme TITLE attribute description 'This property specifies the job title, functional position or function of the individual associated with the vCard object within an organization. This property is based on the X.520 Title attribute. For example, "Vice President, Research and Development". This property is identified by the property name TITLE. An example of this property follows: TITLE:V.P., Research and Development Support for this property is optional for vCard Writers conforming to this specification.' label 'Title' optional repeatable syntax string schemes 'X520' scheme ROLE attribute description 'This property specifies information concerning the role, occupation, or business category of the vCard object within an organization. This property is based on the X.520 Business Category explanatory attribute. For example, "Programmer". This property is included as an organizational property to avoid confusion with the Title property and to avoid incorrect use of the Title property to record Business Category information. This property is identified by the property name ROLE. An example of this property follows: ROLE:Executive Support for this property is optional for vCard Writers conforming to this specification.' label 'Business Category' optional repeatable syntax string schemes 'X520' scheme LOGO attribute description 'This property specifies an image or graphic of the logo of the organization that is associated with the individual to which the vCard belongs. This property is identified by the property name LOGO. An example of a value for a GIF formatted image of a logo in Base 64 encoding for this property follows: LOGO;ENCODING=BASE64;TYPE=GIF: R0lGODdhfgA4AOYAAAAAAK+vr62trVIxa6WlpZ+fnzEpCEpzlAha/0Kc74+PjyGM SuecKRhrtX9/fzExORBSjCEYCGtra2NjYyF7nDGE50JrhAg51qWtOTl7vee1MWu1 50o5e3PO/3sxcwAx/4R7GBgQOcDAwFoAQt61hJyMGHuUSpRKIf8A/wAY54yMjHtz ... Support for this property is optional for vCard Writers conforming to this specification.' label 'Logo' optional single valued syntax string schemes 'URI' scheme, 'GIF' scheme, 'CGM' scheme, 'WMF' scheme, 'BMP' scheme, 'MET' scheme, 'PMB' scheme, 'DIB' scheme, 'PICT' scheme, 'TIFF' scheme, 'PS' scheme, 'PDF' scheme, 'JPEG' scheme, 'MPEG' scheme, 'MPEG2' scheme, 'AVI' scheme, 'QTIME' scheme AGENT attribute description 'This property specifies information about another person who will act on behalf of the vCard object. Typically this would be an area administrator, assistant, or secretary for the individual. A key characteristic of the Agent property is that it represents somebody or something which is separately addressable. For example, if all phone calls or e-mail messages are normally screened by an agent, this property may not be needed. On the other hand, if an agent can act as a proxy, and may otherwise need to be contacted separately, then an Agent property is useful. This property is equivalent to nesting another vCard with the specified vCard. This property is identified by the property name AGENT. The value of this property is a string containing another vCard object. An example of this property follows: AGENT: BEGIN:VCARD VERSION:2.1 N:Friday;Fred TEL;WORK;VOICE:+1-213-555-1234 TEL;WORK;FAX:+1-213-555-5678 END:VCARD Support for this property is optional for vCard Writers conforming to this specification.' label 'Agent' optional repeatable syntax string schemes 'FN' type, 'N' type, 'PHOTO' type, 'BDAY' type, 'ADR' type, 'LABEL' type, 'TEL' type, 'EMAIL' type, 'MAILER' type, 'TZ' type, 'GEO' type, 'TITLE' type, 'ROLE' type, 'LOGO' type, 'ORG' type, 'NOTE' type, 'REV' type, 'SOUND' type, 'URL' type, 'UID' type, 'VERSION' type, 'KEY' type ORG attribute description 'This property specifies the name and optionally the unit(s) of the organization associated with the vCard object. This property is based on the X.520 Organization Name attribute and the X.520 Organization Unit attribute. For example, "The AB Corporation" and the "North American Division". This property is identified by the property name ORG. This property is defined to encapsulate the Organization Name and Organization Unit properties as sub-properties. The property value consists of the components of the organization specified as positional fields separated by the Field Delimiter (ASCII decimal 59). The property value is a concatenation of the Organization Name (first field), Organizational Unit (second field) strings. Additional positional fields, if specified, contain additional Organizational Units. The following is an example of the Organization property: ORG:ABC, Inc.;North American Division;Marketing Support for this property is optional for vCard Writers conforming to this specification.' label 'Organisation Name and Organisational Unit' syntax string schemes 'X520' scheme NOTE attribute description 'This property specifies supplemental information or a comment that is associated with the vCard. With the use of property grouping, the association can be limited to a group of properties. The property is based on the X.520 Description attribute. This property is identified by the property name NOTE. An example of this property follows: NOTE;ENCODING=QUOTED-PRINTABLE:This facsimile machine if operational= 0830 to 1715 hours=0D=0A= Monday through Friday. Call +1-213-555-1234 if you have problems=0D=0A= with access to the machine. Support for this property is optional for vCard Writers conforming to this specification.' label 'Comment' optional single valued syntax string schemes 'X520' scheme REV attribute description 'This property specifies the combination of the calendar date and time of day of the last update to the vCard object. The property value is a character string conforming to the basic or extended format of ISO 8601. The value can either be in terms of local time or UTC. This property is identified by the property name REV. Valid values for this property are a character string representing a combination of the calendar date and time of day conforming to the basic or extended format of ISO 8601. The time of day can be either local time or UTC. The following example is in the basic format and local time of ISO 8601: REV:19951031T222710 The following example is in the extended format and UTC time of ISO 8601: REV:1995-10-31T22:27:10Z Support for this property is optional for vCard Writers conforming to this specification.' label 'Last Revision' optional single valued syntax string schemes 'ISO8601' scheme SOUND attribute description 'This property specifies a sound annotation for the vCard object. By default, if this property is not grouped with other properties it specifies the pronunciation of the Formatted Name property of the vCard object. Such information may be in the form of a string of characters representing a phonetic sound or in the form of a digitized sound, or both; subject to the limitations imposed by the encoding used to communicate the vCard. This property is identified by the property name SOUND. Valid values for this property are either a string representation, a reference to a digital audio representation, or an inline digital audio representation of the phonetic pronunciation of the Formatted Name property. The following example shows the string based phonetic representation: SOUND:JON Q PUBLIK The following example shows the digtial sound representation and URL based value: SOUND;VALUE=URL:file///multimed/audio/jqpublic.wav The following example shows the digtial sound representation and INLINE value: SOUND;WAVE;BASE64: UklGRhAsAABXQVZFZm10IBAAAAABAAEAESsAABErAAABAAgAZGF0YesrAACAg4eC eXR4e3uAhoiIiYmKjIiDfnx5eX6CgoKEhYWDenV5fH6BhISGiIiDfHZ2eXt/hIiK jY2IhH12d3Vyc3uDiIiFf3l7fn18eXl+houFf319fnyAgHl5eoCIiISChIeAfnt2 ... Support for this property is optional for vCard Writers conforming to this specification.' label 'Sound' optional single valued syntax string schemes 'Phonetic' scheme, 'URI' scheme, 'WAVE' scheme, 'PCM' scheme, 'AIFF' scheme URL attribute description 'This property specifies a value that represents a Uniform Resource Locator (URL). An URL is a representation of an Internet location that can be used to obtain real-time information about the vCard object. Application of this property might be to specify the location of a publicly accessible directory where up-to-date or additional information on the individual or resource associated with a vCard can be found. This property is identified by the property name URL. Valid values for this property are a string conforming to the IETF RFC 1738, Uniform Resource Locators. The following is an example of this property: URL:http://abc.com/pub/directory/northam/jpublic.ecd Support for this property is optional for vCard Writers conforming to this specification.' label 'Uniform Resource Locator' optional repeatable syntax string schemes 'URI' scheme UID attribute description 'This property specifies a value that represents a persistent, globally unique identifier associated with the object. The property can be used as a mechanism to relate different vCard objects. Some examples of valid forms of unique identifiers would include ISO 9070 formal public identifiers (FPI), X.500 distinguished names, machine-generated "random" numbers with a statistically high likelihood of being globally unique and Uniform Resource Locators (URL). If an URL is specified, it is suggested that the URL reference a service which will produce an updated version of the vCard. This property is identified by the property name UID. This property is provided to enable a vCard Reader and Writer to uniquely identify either a vCard object instance or properties within a vCard object. Valid values for this property are a unique character string. The following is an example of this property: UID:19950401-080045-40000F192713-0052 Support for this property is optional for vCard Writers conforming to this specification.' label 'Unique Identifier' syntax string schemes 'FPI' scheme, 'X500' scheme, 'Random' scheme, 'URI' scheme VERSION attribute description 'This property specifies the identifier corresponding to the highest version number of the vCard Specification supported by the implementation that created the vCard object. The value of this property must be 2.1 to correspond to this specification. This property is identified by the property name VERSION. The following is an example of this property: VERSION:2.1 Support for this property is mandatory for implementations conforming to this specification. This property must appear within the vCard data stream.' label 'Version' mandatory single valued syntax string KEY attribute description 'This property specifies the public encryption key associated with the vCard object. This property is identified by the property name KEY. Valid values for this property are a public key that conforms to a bilaterally agreed to representation. If the representation is a binary format, then the public key must be further encoded. The default format is clear-text. If a binary format is used, then it is specified by the property parameter. Support for this property is optional for vCard Writers conforming to this specification.' label 'Public Key' optional single valued syntax string schemes 'Text' scheme, 'X509' scheme, 'PGP' scheme, 'Binary' scheme