-
Notifications
You must be signed in to change notification settings - Fork 93
Non standard
The vCard standard allows for "extended" (aka non-standard) properties and parameters to exist in a vCard. They are called "extended" because they are not part of the vCard specification. Extended property and parameter names MUST start with X-
. Many email clients make use of extended properties to store additional data.
To retrieve extended properties from a VCard
object, use the VCard.getExtendedProperties()
method. This will return a list of RawProperty
objects whose names match the name that was passed into the method.
The example below prints the values of all X-MS-MANAGER
properties in a vCard.
VCard vcard = ...
List<RawProperty> managers = vcard.getExtendedProperties("X-MS-MANAGER");
for (RawProperty manager : managers){
System.out.println("Manager: " + manager.getValue());
}
To add an extended property to a VCard
object, call the VCard.addExtendedProperty()
method. This method returns the RawProperty
object that was added to the vCard, allowing you to make further modifications to the property if necessary.
The example below creates a X-SPOUSE
property and assigns a group name to it.
VCard vcard = new VCard();
RawProperty spouse = vcard.addExtendedProperty("X-SPOUSE", "Jane Doe");
spouse.setGroup("item1");
Note that it's also possible to create custom property classes using a pluggable API. See the Property scribe page for more information.
To retrieve an extended parameter (or any parameter for that matter), call the getParameter()
or getParameters()
method on the property object.
The example below retrieves a parameter named X-GENDER
from the FN
property.
VCard vcard = ...
FormattedName fn = vcard.getFormattedName();
String gender = fn.getParameter("X-GENDER");
To add an extended parameter (or any parameter for that matter) to a property, call the addParameter()
method.
The example below adds a parameter named X-GENDER
to the FN
property.
FormattedName fn = new FormattedName("John Doe");
fn.addParameter("X-GENDER", "male");
ez-vcard is maintained by Michael Angstadt
Table of Contents
Getting started
Examples
FAQ
Javadocs
Downloads
1 An Overview of the vCard data format
2 Reading and Writing vCard data with ez-vcard
2.1 Plain-text (traditional)
2.2 XML-encoded (xCard)
2.3 JSON-encoded (jCard)
2.4 HTML-encoded (hCard)
3 Differences between the vCard versions
4 Dealing with Non-standard Data
4.1 Working with non-standard properties and parameters
4.2 Property scribe
5 Project Information
5.1 News
5.2 Dependencies
5.3 Supported Specifications
5.4 Changelog
6 Reference
6.1 vCard Property Reference
6.2 Javadocs