Working with vCard metadata Leave feedback
vCard, also known as VCF (Virtual Contact File), is a file format standard for electronic business cards. vCards are often attached to e-mail messages, but can be exchanged in other ways. They can contain name and address information, telephone numbers, e-mail addresses, URLs, logos, photographs, and even audio clips.
NoteFor more information on the format please see https://en.wikipedia.org/wiki/VCard
To access Metadata in a vCard, GroupDocs.Metadata API provides the VCardRootPackage.getVCardPackagemethod which contains the information extracted from a file. The following are the steps to access metadata in a vCard:
- Load a vCard file
- Get the root metadata package
- Extract the native metadata package using the VCardRootPackage.getVCardPackagemethod
- Read the extracted vCard fields
The following code snippet gets metadata of a vCard file.
advanced_usage.managing_metadata_for_specific_formats.
public static void run() {
try (Metadata metadata = new Metadata(Constants.InputVcf)) {
VCardRootPackage root = metadata.getRootPackageGeneric();
for (VCardCard vCard : root.getVCardPackage().getCards()) {
System.out.println(vCard.getIdentificationRecordset().getName());
PrintArray(vCard.getIdentificationRecordset().getFormattedNames());
PrintArray(vCard.getCommunicationRecordset().getEmails());
PrintArray(vCard.getCommunicationRecordset().getTelephones());
PrintArray(vCard.getDeliveryAddressingRecordset().getAddresses());
// ...
}
}
}
private static void PrintArray(String[] values) {
if (values != null) {
for (String value : values) {
System.out.println(value);
}
}
}
The GroupDocs.Metadata API also provides a way to get Metadata from vCards with descriptive parameters.The steps are given below:
- Load a vCard file
- Get the root metadata package
- Extract the native metadata package using the VCardRootPackage.getVCardPackagemethod
- Use methods with the Record(s) postfix to get vCard fields along with descriptive parameters
The following code snippet shows how to extract vCard fields along with descriptive parameters.
advanced_usage.managing_metadata_for_specific_formats.
try (Metadata metadata = new Metadata(Constants.InputVcf)) {
VCardRootPackage root = metadata.getRootPackageGeneric();
for (VCardCard vCard : root.getVCardPackage().getCards()) {
if (vCard.getIdentificationRecordset().getPhotoUriRecords() != null) {
// Iterate all photos represented by URIs
for (VCardTextRecord photoUriRecord : vCard.getIdentificationRecordset().getPhotoUriRecords()) {
// Print the property value
System.out.println(photoUriRecord.getValue());
// Print some additional parameters of the property
System.out.println(photoUriRecord.getContentType());
System.out.println(photoUriRecord.getMediaTypeParameter());
if (photoUriRecord.getTypeParameters() != null) {
for (String parameter : photoUriRecord.getTypeParameters()) {
System.out.println(parameter);
}
}
System.out.println(photoUriRecord.getPrefParameter());
}
}
}
}
The GroupDocs.Metadata API provides the ability to filter vCard properties in order to make finding desired information easier. The code sample below demonstrates how to use the filtering feature.
advanced_usage.managing_metadata_for_specific_formats.
public static void run() {
try (Metadata metadata = new Metadata(Constants.InputVcf)) {
VCardRootPackage root = metadata.getRootPackageGeneric();
for (VCardCard vCard : root.getVCardPackage().getCards()) {
// Print most preferred work phone numbers and work emails
VCardCard filtered = vCard.filterWorkTags().filterPreferred();
PrintArray(filtered.getCommunicationRecordset().getTelephones());
PrintArray(filtered.getCommunicationRecordset().getEmails());
}
}
}
private static void PrintArray(String[] values) {
if (values != null) {
for (String value : values) {
System.out.println(value);
}
}
}
You may easily run the code above and see the feature in action in our GitHub examples:
Along with full featured Java library we provide simple, but powerful free Apps.
You are welcome to view and edit metadata of PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, emails, images and more with our free online Free Online Document Metadata Viewing and Editing App.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
