Skip to content

michalkutil/vCardLib

 
 

Repository files navigation

This project contains two sub projects

Build status Coverage Status Mono Book session on Codementor

vCardLibUI

Download vCardLibUI License: MIT

This tool was developed because I recently lost my android phone but was blessed to have created a VCF backup of all my contacts. vCardLibUI loads contacts from a vCard (VCF) file into a table which allows sorting and case insensitive searching. The table shows the surname, the first name, one email address and two phone numbers

vCardLib

NuGet Badge License: MIT

Update: v2.2.0 introduced breaking changes. Details of these changes are on the 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

Then add this using command:

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

About

A library and graphic tool for reading files in the vcard format

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.7%
  • PowerShell 0.3%