/vCardLib

A .NET standard library for reading vCard files

Primary LanguageC#MIT LicenseMIT

vCardLib

Build status Coverage Status NET Standard NuGet Badge License: MIT

Documentation can be found at documentation site

This is the library that powers the VCF Reader. Unlike all other vCard libraries for .NET that I found, this library supports reading multiple contacts from a single vcf file and returns the contact objects in a vCardCollection. The library currently supports only vCard version 2.1 and 3.0 (a curated list of properties supported can be seen on the documentation site).

How to use the library:

First get this package from nuget via your package manager:

Install-Package vCardLib.dll

or

dotnet add package vCardLib.dll

For Deserialization

Import the namespaces:

using vCardLib.Deserializers;

In your class you call the static method 'FromFile' and pass a string containing a path to it:

string filePath = //path to vcf file;

vCardCollection contacts = Deserializer.FromFile(filePath);

Or pass a StreamReader object to it:

StreamReader sr = //generate a streamreader somehow;
vCardCollection contacts = Deserializer.FromStreamReader(sr);

Iterate over the collection and pick the vCard objects:

foreach(vCard contact in contacts)
{
  Console.WriteLine(contact.FormattedName);
}

complete documentation on github.io