dotnet add package vCardLib.dll

Usage 🛠️

Deserialization (Reading vCards)

From a File

string filePath = // path to .vcf file;
IEnumerable<vCard> contacts = vCardDeserializer.FromFile(filePath);

From a Stream

var stream = // generate stream containing serialized vCards
IEnumerable<vCard> contacts = vCardDeserializer.FromStream(stream);

From a String

var contactDetails = @"BEGIN:VCARD
VERSION:2.1
N:John;Doe;;;
END:VCARD";
IEnumerable<vCard> contacts = vCardDeserializer.FromContent(contactDetails);

Serialization (Writing vCards)

Serialize as String

var vcard = new vCard(vCardVersion.V2)
{
    FormattedName = "John Doe"
};
var serialized = vCardSerializer.Serialize(vcard);

/*
Output:
BEGIN:VCARD
VERSION:2.1
REV:20230719T001838Z
FN:John Doe
END:VCARD
*/

Serialize with Version Override

var vcard = new vCard(vCardVersion.V2)
{
    FormattedName = "John Doe"
};
var serialized = vCardSerializer.Serialize(vcard, vCardVersion.V4);

/*
Output:
BEGIN:VCARD
VERSION:4.0
REV:20230719T001838Z
FN:John Doe
END:VCARD
*/

Branches 🌿

• master: Contains the latest breaking changes and features. 🚧
  Note: This branch may contain unstable code and is not recommended for production use.

• v4 Tag: The most recent stable release. ✅

Contributors 🙌

A huge thank you to these amazing contributors who have helped make vCardLib better:

@bolorundurowb, @crowar,
@rmja, @JeanCollas

License 📜

vCardLib is licensed under the MIT License. See the LICENSE file for more details.

Get Started Today! 🎉

Whether you're building a contact management system, integrating vCard support into your app, or just need to process .vcf files, vCardLib is here to make your life easier. Install the package, follow the examples, and start working with vCards like a pro! ⏱️

Happy Coding! 🚀