EVCard

typedef struct _EVCard EVCard;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

enum EVCardFormat

typedef enum {
	EVC_FORMAT_VCARD_21,
	EVC_FORMAT_VCARD_30
} EVCardFormat;

The specific vCard format version that the vCard complies with.

EVCardAttribute

typedef struct _EVCardAttribute EVCardAttribute;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

EVCardAttributeParam

typedef struct _EVCardAttributeParam EVCardAttributeParam;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

e_vcard_new ()

EVCard*             e_vcard_new                         (void);

Creates a new, blank EVCard.

e_vcard_new_from_string ()

EVCard*             e_vcard_new_from_string             (const char *str);

Creates a new EVCard from the passed-in string representation.

The contents of the vCard will be lazily parsed into EVCardAttributes, so non-trivial errors in the vCard will not be resolved by the time this function returns.

e_vcard_to_string ()

char*               e_vcard_to_string                   (EVCard *evc,
                                                         EVCardFormat format);

Exports evc to a string representation, specified by the format argument.

e_vcard_dump_structure ()

void                e_vcard_dump_structure              (EVCard *evc);

Prints a dump of evc's structure to stdout. Used for debugging.

e_vcard_attribute_new ()

EVCardAttribute*    e_vcard_attribute_new               (const char *attr_group,
                                                         const char *attr_name);

Creates a new EVCardAttribute with the specified group and attribute names.

e_vcard_attribute_free ()

void                e_vcard_attribute_free              (EVCardAttribute *attr);

Frees an attribute, its values and its parameters.

e_vcard_attribute_copy ()

EVCardAttribute*    e_vcard_attribute_copy              (EVCardAttribute *attr);

Makes a copy of attr.

e_vcard_remove_attributes ()

void                e_vcard_remove_attributes           (EVCard *evc,
                                                         const char *attr_group,
                                                         const char *attr_name);

Removes all the attributes with group name and attribute name equal to passed in values. If attr_group is NULL or an empty string, it removes all the attributes with passed in name irrespective of their group names.

e_vcard_remove_attribute ()

void                e_vcard_remove_attribute            (EVCard *evc,
                                                         EVCardAttribute *attr);

Removes attr from evc and frees it.

e_vcard_add_attribute ()

void                e_vcard_add_attribute               (EVCard *evc,
                                                         EVCardAttribute *attr);

Adds attr to evc.

This also transfers ownership of attr to evc.

e_vcard_add_attribute_with_value ()

void                e_vcard_add_attribute_with_value    (EVCard *evcard,
                                                         EVCardAttribute *attr,
                                                         const char *value);

Adds attr to evcard, setting it to value.

This also transfers ownership of attr to evc.

e_vcard_add_attribute_with_values ()

void                e_vcard_add_attribute_with_values   (EVCard *evcard,
                                                         EVCardAttribute *attr,
                                                         ...);

Adds attr to evcard, assigning the list of values to it.

This also transfers ownership of attr to evc.

e_vcard_attribute_add_value ()

void                e_vcard_attribute_add_value         (EVCardAttribute *attr,
                                                         const char *value);

Adds value to attr's list of values.

e_vcard_attribute_add_value_decoded ()

void                e_vcard_attribute_add_value_decoded (EVCardAttribute *attr,
                                                         const char *value,
                                                         int len);

Decodes value according to the encoding used for attr, and adds it to attr's list of values.

e_vcard_attribute_add_values ()

void                e_vcard_attribute_add_values        (EVCardAttribute *attr,
                                                         ...);

Adds a list of values to attr.

e_vcard_attribute_remove_values ()

void                e_vcard_attribute_remove_values     (EVCardAttribute *attr);

Removes all values from attr.

e_vcard_attribute_remove_params ()

void                e_vcard_attribute_remove_params     (EVCardAttribute *attr);

Removes all parameters from attr.

e_vcard_attribute_param_new ()

EVCardAttributeParam* e_vcard_attribute_param_new       (const char *name);

Creates a new parameter named name.

e_vcard_attribute_param_free ()

void                e_vcard_attribute_param_free        (EVCardAttributeParam *param);

Frees param and its values.

e_vcard_attribute_param_copy ()

EVCardAttributeParam* e_vcard_attribute_param_copy      (EVCardAttributeParam *param);

Makes a copy of param.

e_vcard_attribute_add_param ()

void                e_vcard_attribute_add_param         (EVCardAttribute *attr,
                                                         EVCardAttributeParam *param);

Adds param to attr's list of parameters.

This also transfers ownership of param to attr.

e_vcard_attribute_add_param_with_value ()

void                e_vcard_attribute_add_param_with_value
                                                        (EVCardAttribute *attr,
                                                         EVCardAttributeParam *param,
                                                         const char *value);

Adds value to param, then adds param to attr.

e_vcard_attribute_add_param_with_values ()

void                e_vcard_attribute_add_param_with_values
                                                        (EVCardAttribute *attr,
                                                         EVCardAttributeParam *param,
                                                         ...);

Adds the list of values to param, then adds param to attr.

e_vcard_attribute_param_add_value ()

void                e_vcard_attribute_param_add_value   (EVCardAttributeParam *param,
                                                         const char *value);

Adds value to param's list of values.

e_vcard_attribute_param_add_values ()

void                e_vcard_attribute_param_add_values  (EVCardAttributeParam *param,
                                                         ...);

Adds a list of values to param.

e_vcard_attribute_param_remove_values ()

void                e_vcard_attribute_param_remove_values
                                                        (EVCardAttributeParam *param);

Removes and frees all values from param.

e_vcard_get_attributes ()

GList*              e_vcard_get_attributes              (EVCard *evcard);

Gets the list of attributes from evcard. The list and its contents are owned by evcard, and must not be freed.

e_vcard_attribute_equal ()

gboolean            e_vcard_attribute_equal             (EVCardAttribute *attr_a,
                                                         EVCardAttribute *attr_b);

Checks if attr_a and attr_b are equal by value. This function considers attibute names, values and parameters. It is save to pass NULL to its arguments.

e_vcard_attribute_has_type ()

gboolean            e_vcard_attribute_has_type          (EVCardAttribute *attr,
                                                         const char *typestr);

Checks if attr has an EVCardAttributeParam of the specified type.

e_vcard_attribute_is_single_valued ()

gboolean            e_vcard_attribute_is_single_valued  (EVCardAttribute *attr);

Checks if attr has a single value.

e_vcard_attribute_get_group ()

const char*         e_vcard_attribute_get_group         (EVCardAttribute *attr);

Gets the group name of attr.

e_vcard_attribute_get_name ()

const char*         e_vcard_attribute_get_name          (EVCardAttribute *attr);

Gets the name of attr.

e_vcard_attribute_get_value ()

char*               e_vcard_attribute_get_value         (EVCardAttribute *attr);

Gets the value of a single-valued EVCardAttribute, attr.

e_vcard_attribute_get_value_decoded ()

GString*            e_vcard_attribute_get_value_decoded (EVCardAttribute *attr);

Gets the value of a single-valued EVCardAttribute, attr, decoding it if necessary.

Note: this function seems currently to be unused. Could be removed.

e_vcard_attribute_get_values ()

GList*              e_vcard_attribute_get_values        (EVCardAttribute *attr);

Gets the list of values from attr. The list and its contents are owned by attr, and must not be freed.

e_vcard_attribute_get_values_decoded ()

GList*              e_vcard_attribute_get_values_decoded
                                                        (EVCardAttribute *attr);

Gets the list of values from attr, decoding them if necessary. The list and its contents are owned by attr, and must not be freed.

e_vcard_attribute_get_param ()

GList*              e_vcard_attribute_get_param         (EVCardAttribute *attr,
                                                         const char *name);

Gets the list of values for the paramater name from attr. The list and its contents are owned by attr, and must not be freed.

e_vcard_attribute_get_params ()

GList*              e_vcard_attribute_get_params        (EVCardAttribute *attr);

Gets the list of parameters from attr. The list and its contents are owned by attr, and must not be freed.

e_vcard_attribute_param_get_name ()

const char*         e_vcard_attribute_param_get_name    (EVCardAttributeParam *param);

Gets the name of param.

e_vcard_attribute_param_get_values ()

GList*              e_vcard_attribute_param_get_values  (EVCardAttributeParam *param);

Gets the list of values from param. The list and its contents are owned by param, and must not be freed.

e_vcard_attribute_remove_param ()

void                e_vcard_attribute_remove_param      (EVCardAttribute *attr,
                                                         const char *param_name);

Removes the parameter param_name from the attribute attr.

e_vcard_attribute_remove_param_value ()

void                e_vcard_attribute_remove_param_value
                                                        (EVCardAttribute *attr,
                                                         const char *param_name,
                                                         const char *s);

Removes the value s from the parameter param_name on the attribute attr.

e_vcard_attribute_remove_value ()

void                e_vcard_attribute_remove_value      (EVCardAttribute *attr,
                                                         const char *s);

Removes from the value list in attr the value s.

e_vcard_escape_string ()

char*               e_vcard_escape_string               (const char *s);

Escapes a string according to RFC2426, section 5.

e_vcard_get_attribute ()

EVCardAttribute*    e_vcard_get_attribute               (EVCard *evc,
                                                         const char *name);

Get the attribute name from evc. The EVCardAttribute is owned by evcard and should not be freed. If the attribute does not exist, NULL is returned.

e_vcard_is_parsed ()

gboolean            e_vcard_is_parsed                   (EVCard *evc);

Check if the evc has been parsed already. Used for debugging.

e_vcard_is_parsing ()

gboolean            e_vcard_is_parsing                  (EVCard *evc);

Check if the evc is currently beening parsed. Used in derived classes to distinguish between parser caused attribute additions and real attribute additions.

e_vcard_unescape_string ()

char*               e_vcard_unescape_string             (const char *s);

Unescapes a string according to RFC2426, section 5.

EVC_ADR

#define EVC_ADR             "ADR"

Postal/mailing address

EVC_BDAY

#define EVC_BDAY            "BDAY"

Birthdate in ISO 8601 date or combined-date-and-time (in UTC or UTC-with-offset) format.

EVC_CALURI

#define EVC_CALURI          "CALURI"

EVC_CATEGORIES

#define EVC_CATEGORIES      "CATEGORIES"

EVC_EMAIL

#define EVC_EMAIL           "EMAIL"

Email address

EVC_ENCODING

#define EVC_ENCODING        "ENCODING"

The encoding format of the vCard

EVC_FBURL

#define EVC_FBURL           "FBURL"

EVC_FN

#define EVC_FN              "FN"

Full name; this is a single-string representation of the N field.

EVC_GEO

#define EVC_GEO		    "GEO"

Geographical location field

EVC_ICSCALENDAR

#define EVC_ICSCALENDAR     "ICSCALENDAR" /* XXX should this be X-EVOLUTION-ICSCALENDAR? */

EVC_KEY

#define EVC_KEY             "KEY"

EVC_LABEL

#define EVC_LABEL           "LABEL"

EVC_LOGO

#define EVC_LOGO            "LOGO"

EVC_MAILER

#define EVC_MAILER          "MAILER"

EVC_NICKNAME

#define EVC_NICKNAME        "NICKNAME"

A contact's nickname

EVC_N

#define EVC_N               "N"

Structured name field. The values for this field are, in order, as follows: <family name>;<given name>;<middle name(s)>;<honorific prefix(es()>;<honorific suffix(es)>

Example from RFC 2426: N:Stevenson;John;Philip,Paul;Dr.;Jr.,M.D.,A.C.P.

EVC_NOTE

#define EVC_NOTE            "NOTE"

An arbitrary user-set note about the contact

EVC_ORG

#define EVC_ORG             "ORG"

Organization/Company

EVC_PHOTO

#define EVC_PHOTO           "PHOTO"

Structured Photo/avatar. See RFC 2426 for more details.

EVC_PRODID

#define EVC_PRODID          "PRODID"

EVC_QUOTEDPRINTABLE

#define EVC_QUOTEDPRINTABLE "QUOTED-PRINTABLE"

EVC_REV

#define EVC_REV             "REV"

EVC_ROLE

#define EVC_ROLE            "ROLE"

EVC_TEL

#define EVC_TEL             "TEL"

Telephone or fax number.

EVC_TITLE

#define EVC_TITLE           "TITLE"

Professional title (e.g., "Director, Standards and Practices Dept.")

EVC_TYPE

#define EVC_TYPE            "TYPE"

The vCard "TYPE" attribute parameter. Usually omitted, "HOME", "WORK", or "OTHER".

EVC_UID

#define EVC_UID             "UID"

Unique ID

EVC_URL

#define EVC_URL             "URL"

A Web URL

EVC_VALUE

#define EVC_VALUE           "VALUE"

EVC_VERSION

#define EVC_VERSION         "VERSION"

EVC_X_AIM

#define EVC_X_AIM              "X-AIM"

An AOL Instant Messenger username

EVC_X_BLOG_URL

#define EVC_X_BLOG_URL         "X-EVOLUTION-BLOG-URL"

EVC_X_BOOK_URI

#define EVC_X_BOOK_URI     	"X-EVOLUTION-BOOK-URI"

The URI of the contact's EBook store. Do not set this manually.

EVC_X_GADUGADU

#define EVC_X_GADUGADU        "X-GADUGADU"

A Gadu Gadu messenger username

EVC_X_GROUPWISE

#define EVC_X_GROUPWISE     	"X-GROUPWISE"

A Novell Groupwise username

EVC_X_ICQ

#define EVC_X_ICQ              "X-ICQ"

An ICQ messenger username

EVC_X_JABBER

#define EVC_X_JABBER           "X-JABBER"

A Jabber/XMPP username

EVC_X_MSN

#define EVC_X_MSN           	"X-MSN"

A Microsoft Network/MSN Messenger username

EVC_X_SIP

#define EVC_X_SIP           	"X-SIP"

A SIP VoIP username

EVC_X_SKYPE

#define EVC_X_SKYPE           "X-SKYPE"

A Skype username

EVC_X_VIDEO_URL

#define EVC_X_VIDEO_URL     	"X-EVOLUTION-VIDEO-URL"

EVC_X_YAHOO

#define EVC_X_YAHOO         	"X-YAHOO"

A Yahoo! Messenger username