Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bolorundurowb/vcardlib
📇 A .NET standard library for reading and writing vCard files
https://github.com/bolorundurowb/vcardlib
c-sharp library vcard vcf
Last synced: 12 days ago
JSON representation
📇 A .NET standard library for reading and writing vCard files
- Host: GitHub
- URL: https://github.com/bolorundurowb/vcardlib
- Owner: bolorundurowb
- License: mit
- Created: 2016-04-03T12:44:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-28T04:39:09.000Z (about 1 month ago)
- Last Synced: 2024-10-14T23:43:24.811Z (25 days ago)
- Topics: c-sharp, library, vcard, vcf
- Language: C#
- Homepage: https://github.com/bolorundurowb/vCardLib/blob/master/README.md
- Size: 785 KB
- Stars: 25
- Watchers: 5
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# vCardLib: A vCard (.vcf) Processing Library
[](https://www.nuget.org/packages/vCardLib.dll) [](https://coveralls.io/github/bolorundurowb/vCardLib?branch=master) []() []() [](LICENSE)
This library provides functionality for working with vCard files.
**Features:**
* Read multiple contacts from a single vcf file, stream, or contact string.
* Returns contact data as an `IEnumerable` object for easy iteration.
* Supports reading and writing vCard versions 2.1, 3.0, and 4.0.
**Branches:**
* **master:** This branch contains the latest **breaking changes and features**. For the most recent stable release (v4), please see the [v4 tag](https://github.com/bolorundurowb/vCardLib/tree/v4).
**Important:** The `master` branch may contain unstable code and is not recommended for production use.
**Improvements:**
* **Clarity:** I've rephrased some sentences to be more clear and concise.
* **Structure:** I've added headings and bullet points to improve readability.
* **Branching:** I've clarified the purpose of the `master` branch and provided a link to the latest stable release.
* **Emphasis:** I've bolded "breaking changes and features" to emphasize the potential instability of the `master` branch.
I hope this improved markdown is helpful!
## How to use this library:
First get this package from nuget via your package manager:
```
Install-Package vCardLib.dll
```
or
```bash
dotnet add package vCardLib.dll
```
## For Deserialization
### Deserialize from a file
```csharp
string filePath = // path to vcf file;
IEnumerable contacts = vCardDeserializer.FromFile(filePath);
```
### Deserialize from a Stream
```csharp
var stream = // generate stream containing serialized vcards
IEnumerable contacts = vCardDeserializer.FromStream(stream);
```
### Deserialize from a string
```csharp
var contactDetails = @"BEGIN:VCARD
VERSION:2.1
N:John;Doe;;;
END:VCARD";
IEnumerable contacts = vCardDeserializer.FromContent(contactDetails);
```
## For Serialization
### Serialize as string
```csharp
var vcard = new vCard(vCardVersion.v2)
{
FormattedName = "John Doe"
};
var serialized = vCardSerializer.Serialize(vcard);
/*
BEGIN:VCARD
VERSION:2.1
REV:20230719T001838Z
FN:John Doe
END:VCARD
*/
```
### Serialize with an override
This allows a vcard to get serialized to a different version
```csharp
var vcard = new vCard(vCardVersion.v2)
{
FormattedName = "John Doe"
};
var serialized = vCardSerializer.Serialize(vcard, vCardVersioon.v4);
/*
BEGIN:VCARD
VERSION:4.0
REV:20230719T001838Z
FN:John Doe
END:VCARD
*/
```
## Contributors
A huge thank you to these wonderful people who took time to contribute to this project.
[@bolorundurowb](https://github.com/bolorundurowb), [@crowar](https://github.com/crowar)
, [@rmja](https://github.com/rmja), [@JeanCollas](https://github.com/JeanCollas)