ExDav.VCard (ExDav v0.4.9)

vCard 4.0 parser and serialiser. vCard 3.0 is explicitly rejected.

Only the properties needed for CardDAV are handled: FN, N, EMAIL, TEL, ADR, ORG, NOTE, UID, REV, plus a catch-all for unknown properties. Unknown properties are round-tripped verbatim as {"RAW", line} entries.

Returned map keys are downcased atoms where known, :raw list otherwise.

Summary

Functions

etag(content)

Compute an ETag for a vCard body (same algorithm as ICal.etag/1).

extract_uid(text)

Extract the UID from a vCard string. Returns nil if not present or invalid.

parse(text)

Parse a vCard 4.0 string. Returns {:ok, map} or {:error, reason} where reason is a string.

serialize(props)

Serialise a map (as returned by parse/1) back to a vCard 4.0 string.

validate(text)

Validate a vCard 4.0 PUT body. Returns :ok or {:error, reason} with one of

Functions

etag(content)

@spec etag(String.t()) :: String.t()

Compute an ETag for a vCard body (same algorithm as ICal.etag/1).

extract_uid(text)

@spec extract_uid(String.t()) :: String.t() | nil

Extract the UID from a vCard string. Returns nil if not present or invalid.

parse(text)

@spec parse(String.t()) :: {:ok, map()} | {:error, String.t()}

Parse a vCard 4.0 string. Returns {:ok, map} or {:error, reason} where reason is a string.

The returned map has:

:fn — full name string
:n — structured name string
:email — list of email strings
:tel — list of tel strings
:adr — list of address strings
:org — org string
:note — note string
:uid — uid string
:rev — revision string
:raw — list of verbatim lines for unknown properties

serialize(props)

@spec serialize(map()) :: String.t()

Serialise a map (as returned by parse/1) back to a vCard 4.0 string.

validate(text)

@spec validate(String.t()) ::
  :ok | {:error, :not_vcard | :wrong_version | :missing_fn}

Validate a vCard 4.0 PUT body. Returns :ok or {:error, reason} with one of:

:not_vcard — missing BEGIN:VCARD / END:VCARD
:wrong_version — VERSION is not 4.0
:missing_fn — FN property absent