|  |  |  | Evolution-Data-Server Manual: Address Book Client (libebook) |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct EVCard; enum EVCardFormat; EVCardAttribute; EVCardAttributeParam; EVCard * e_vcard_new (void); EVCard * e_vcard_new_from_string (const gchar *str); gchar * e_vcard_to_string (EVCard *evc,EVCardFormat format); void e_vcard_dump_structure (EVCard *evc); EVCardAttribute * e_vcard_attribute_new (const gchar *attr_group,const gchar *attr_name); void e_vcard_attribute_free (EVCardAttribute *attr); EVCardAttribute * e_vcard_attribute_copy (EVCardAttribute *attr); void e_vcard_remove_attributes (EVCard *evc,const gchar *attr_group,const gchar *attr_name); void e_vcard_remove_attribute (EVCard *evc,EVCardAttribute *attr); void e_vcard_append_attribute (EVCard *evc,EVCardAttribute *attr); void e_vcard_append_attribute_with_value (EVCard *evcard,EVCardAttribute *attr,const gchar *value); void e_vcard_append_attribute_with_values (EVCard *evcard,EVCardAttribute *attr,...); void e_vcard_add_attribute (EVCard *evc,EVCardAttribute *attr); void e_vcard_add_attribute_with_value (EVCard *evcard,EVCardAttribute *attr,const gchar *value); void e_vcard_add_attribute_with_values (EVCard *evcard,EVCardAttribute *attr,...); void e_vcard_attribute_add_value (EVCardAttribute *attr,const gchar *value); void e_vcard_attribute_add_value_decoded (EVCardAttribute *attr,const gchar *value,gint len); void e_vcard_attribute_add_values (EVCardAttribute *attr,...); void e_vcard_attribute_remove_values (EVCardAttribute *attr); void e_vcard_attribute_remove_value (EVCardAttribute *attr,const gchar *s); void e_vcard_attribute_remove_params (EVCardAttribute *attr); void e_vcard_attribute_remove_param (EVCardAttribute *attr,const gchar *param_name); void e_vcard_attribute_remove_param_value (EVCardAttribute *attr,const gchar *param_name,const gchar *s); EVCardAttributeParam * e_vcard_attribute_param_new (const gchar *name); void e_vcard_attribute_param_free (EVCardAttributeParam *param); EVCardAttributeParam * e_vcard_attribute_param_copy (EVCardAttributeParam *param); void e_vcard_attribute_add_param (EVCardAttribute *attr,EVCardAttributeParam *param); void e_vcard_attribute_add_param_with_value (EVCardAttribute *attr,EVCardAttributeParam *param,const gchar *value); void e_vcard_attribute_add_param_with_values (EVCardAttribute *attr,EVCardAttributeParam *param,...); void e_vcard_attribute_param_add_value (EVCardAttributeParam *param,const gchar *value); void e_vcard_attribute_param_add_values (EVCardAttributeParam *param,...); void e_vcard_attribute_param_remove_values (EVCardAttributeParam *param); const gchar * e_vcard_attribute_param_get_name (EVCardAttributeParam *param); GList * e_vcard_attribute_param_get_values (EVCardAttributeParam *param); EVCardAttribute * e_vcard_get_attribute (EVCard *evc,const gchar *name); GList * e_vcard_get_attributes (EVCard *evcard); const gchar * e_vcard_attribute_get_group (EVCardAttribute *attr); const gchar * e_vcard_attribute_get_name (EVCardAttribute *attr); GList * e_vcard_attribute_get_values (EVCardAttribute *attr); GList * e_vcard_attribute_get_values_decoded (EVCardAttribute *attr); GList * e_vcard_attribute_get_params (EVCardAttribute *attr); GList * e_vcard_attribute_get_param (EVCardAttribute *attr,const gchar *name); gchar * e_vcard_attribute_get_value (EVCardAttribute *attr); GString * e_vcard_attribute_get_value_decoded (EVCardAttribute *attr); gboolean e_vcard_attribute_has_type (EVCardAttribute *attr,const gchar *typestr); gboolean e_vcard_attribute_is_single_valued (EVCardAttribute *attr); gchar * e_vcard_escape_string (const gchar *s); gchar * e_vcard_unescape_string (const gchar *s); #define EVC_ADR #define EVC_BDAY #define EVC_CALURI #define EVC_CATEGORIES #define EVC_EMAIL #define EVC_ENCODING #define EVC_FBURL #define EVC_FN #define EVC_GEO #define EVC_ICSCALENDAR #define EVC_KEY #define EVC_LABEL #define EVC_LOGO #define EVC_MAILER #define EVC_NICKNAME #define EVC_N #define EVC_NOTE #define EVC_ORG #define EVC_PHOTO #define EVC_PRODID #define EVC_QUOTEDPRINTABLE #define EVC_REV #define EVC_ROLE #define EVC_TEL #define EVC_TITLE #define EVC_TYPE #define EVC_UID #define EVC_URL #define EVC_VALUE #define EVC_VERSION #define EVC_X_AIM #define EVC_X_ANNIVERSARY #define EVC_X_ASSISTANT #define EVC_X_BIRTHDAY #define EVC_X_BLOG_URL #define EVC_X_FILE_AS #define EVC_X_GADUGADU #define EVC_X_ICQ #define EVC_X_JABBER #define EVC_X_LIST_SHOW_ADDRESSES #define EVC_X_LIST #define EVC_X_MANAGER #define EVC_X_MSN #define EVC_X_SKYPE #define EVC_X_WANTS_HTML #define EVC_X_YAHOO #define EVC_X_BOOK_URI #define EVC_X_CALLBACK #define EVC_X_COMPANY #define EVC_X_DEST_CONTACT_UID #define EVC_X_DEST_EMAIL #define EVC_X_DEST_EMAIL_NUM #define EVC_X_DEST_HTML_MAIL #define EVC_X_DEST_NAME #define EVC_X_DEST_SOURCE_UID #define EVC_X_GROUPWISE #define EVC_X_RADIO #define EVC_X_SIP #define EVC_X_SPOUSE #define EVC_X_TELEX #define EVC_X_TTYTDD #define EVC_X_VIDEO_URL
Does the low-level parsing work for contact information. This data is more conveniently accessed through the EContact object.
EVCard *            e_vcard_new                         (void);
Creates a new, blank EVCard.
| Returns : | A new, blank EVCard. | 
EVCard *            e_vcard_new_from_string             (const gchar *str);
Creates a new EVCard from the passed-in string representation.
| 
 | a string representation of the vcard to create | 
| Returns : | A new EVCard. | 
gchar * e_vcard_to_string (EVCard *evc,EVCardFormat format);
Exports evc to a string representation, specified
by the format argument.
| 
 | the EVCard to export | 
| 
 | the format to export to | 
| Returns : | A newly allocated string representing the vcard. | 
void                e_vcard_dump_structure              (EVCard *evc);
Prints a dump of evc's structure to stdout. Used for
debugging.
| 
 | the EVCard to dump | 
EVCardAttribute * e_vcard_attribute_new (const gchar *attr_group,const gchar *attr_name);
Creates a new EVCardAttribute with the specified group and attribute names.
| 
 | a group name | 
| 
 | an attribute name | 
| Returns : | A new EVCardAttribute. | 
void                e_vcard_attribute_free              (EVCardAttribute *attr);
Frees an attribute, its values and its parameters.
| 
 | attribute to free | 
EVCardAttribute *   e_vcard_attribute_copy              (EVCardAttribute *attr);
Makes a copy of attr.
| 
 | attribute to copy | 
| Returns : | A new EVCardAttribute identical to attr. | 
void e_vcard_remove_attributes (EVCard *evc,const gchar *attr_group,const gchar *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.
| 
 | vcard object | 
| 
 | group name of attributes to be removed | 
| 
 | name of the arributes to be removed | 
void e_vcard_remove_attribute (EVCard *evc,EVCardAttribute *attr);
Removes attr from evc and frees it.
| 
 | an EVCard | 
| 
 | an EVCardAttribute to remove | 
void e_vcard_append_attribute (EVCard *evc,EVCardAttribute *attr);
Appends attr to evc to the end of a list of attributes.
| 
 | an EVCard | 
| 
 | an EVCardAttribute to append | 
Since 2.32
void e_vcard_append_attribute_with_value (EVCard *evcard,EVCardAttribute *attr,const gchar *value);
Appends attr to evcard, setting it to value.
For attribute addition is used e_vcard_append_attribute().
| 
 | an EVCard | 
| 
 | an EVCardAttribute to append | 
| 
 | a value to assign to the attribute | 
Since 2.32
void e_vcard_append_attribute_with_values (EVCard *evcard,EVCardAttribute *attr,...);
Appends attr to evcard, assigning the list of values to it.
For attribute addition is used e_vcard_append_attribute().
| 
 | an EVCard | 
| 
 | an EVCardAttribute to append | 
| 
 | a NULL-terminated list of values to assign to the attribute | 
Since 2.32
void e_vcard_add_attribute (EVCard *evc,EVCardAttribute *attr);
Adds attr to evc. It's added to the beginning of a list of attributes.
| 
 | an EVCard | 
| 
 | an EVCardAttribute to add | 
void e_vcard_add_attribute_with_value (EVCard *evcard,EVCardAttribute *attr,const gchar *value);
Adds attr to evcard, setting it to value. For attribute addition
is used e_vcard_add_attribute().
| 
 | an EVCard | 
| 
 | an EVCardAttribute to add | 
| 
 | a value to assign to the attribute | 
void e_vcard_add_attribute_with_values (EVCard *evcard,EVCardAttribute *attr,...);
Adds attr to evcard, assigning the list of values to it.
For attribute addition is used e_vcard_add_attribute().
| 
 | an EVCard | 
| 
 | an EVCardAttribute to add | 
| 
 | a NULL-terminated list of values to assign to the attribute | 
void e_vcard_attribute_add_value (EVCardAttribute *attr,const gchar *value);
Adds value to attr's list of values.
| 
 | an EVCardAttribute | 
| 
 | a string value | 
void e_vcard_attribute_add_value_decoded (EVCardAttribute *attr,const gchar *value,gint len);
Decodes value according to the encoding used for attr, and
adds it to attr's list of values.
| 
 | an EVCardAttribute | 
| 
 | an encoded value | 
| 
 | the length of the encoded value, in bytes | 
void e_vcard_attribute_add_values (EVCardAttribute *attr,...);
Adds a list of values to attr.
| 
 | an EVCardAttribute | 
| 
 | a NULL-terminated list of strings | 
void                e_vcard_attribute_remove_values     (EVCardAttribute *attr);
Removes all values from attr.
| 
 | an EVCardAttribute | 
void e_vcard_attribute_remove_value (EVCardAttribute *attr,const gchar *s);
Removes from the value list in attr the value s.
| 
 | an EVCardAttribute | 
| 
 | an value to remove | 
void                e_vcard_attribute_remove_params     (EVCardAttribute *attr);
Removes all parameters from attr.
| 
 | an EVCardAttribute | 
void e_vcard_attribute_remove_param (EVCardAttribute *attr,const gchar *param_name);
Removes the parameter param_name from the attribute attr.
| 
 | an EVCardAttribute | 
| 
 | a parameter name | 
Since 1.12
void e_vcard_attribute_remove_param_value (EVCardAttribute *attr,const gchar *param_name,const gchar *s);
Removes the value s from the parameter param_name on the attribute attr.
| 
 | an EVCardAttribute | 
| 
 | a parameter name | 
| 
 | a value | 
EVCardAttributeParam *  e_vcard_attribute_param_new     (const gchar *name);
Creates a new parameter named name.
| 
 | the name of the new parameter | 
| Returns : | A new EVCardAttributeParam. | 
void                e_vcard_attribute_param_free        (EVCardAttributeParam *param);
Frees param and its values.
| 
 | an EVCardAttributeParam | 
EVCardAttributeParam *  e_vcard_attribute_param_copy    (EVCardAttributeParam *param);
Makes a copy of param.
| 
 | an EVCardAttributeParam | 
| Returns : | a new EVCardAttributeParam identical to param. | 
void e_vcard_attribute_add_param (EVCardAttribute *attr,EVCardAttributeParam *param);
Adds param to attr's list of parameters.
It tests for duplicities, only new parameters are added,
when a new parameter already exists in attr, then those
values are merged, also without creating duplicities.
When we will not add whole param, then it's freed here.
| 
 | an EVCardAttribute | 
| 
 | an EVCardAttributeParam to add | 
void e_vcard_attribute_add_param_with_value (EVCardAttribute *attr,EVCardAttributeParam *param,const gchar *value);
Adds value to param, then adds param to attr.
| 
 | an EVCardAttribute | 
| 
 | an EVCardAttributeParam | 
| 
 | a string value | 
void e_vcard_attribute_add_param_with_values (EVCardAttribute *attr,EVCardAttributeParam *param,...);
Adds the list of values to param, then adds param
to attr.
| 
 | an EVCardAttribute | 
| 
 | an EVCardAttributeParam | 
| 
 | a NULL-terminated list of strings | 
void e_vcard_attribute_param_add_value (EVCardAttributeParam *param,const gchar *value);
Adds value to param's list of values.
| 
 | an EVCardAttributeParam | 
| 
 | a string value to add | 
void e_vcard_attribute_param_add_values (EVCardAttributeParam *param,...);
Adds a list of values to param.
| 
 | an EVCardAttributeParam | 
| 
 | a NULL-terminated list of strings | 
void                e_vcard_attribute_param_remove_values
                                                        (EVCardAttributeParam *param);
Removes and frees all values from param.
| 
 | an EVCardAttributeParam | 
const gchar *       e_vcard_attribute_param_get_name    (EVCardAttributeParam *param);
Gets the name of param.
| 
 | an EVCardAttributeParam | 
| Returns : | The name of the parameter. | 
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.
| 
 | an EVCardAttributeParam | 
| Returns : | A list of string elements representing the parameter's values. [transfer:none][element-type] | 
EVCardAttribute * e_vcard_get_attribute (EVCard *evc,const gchar *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.
| 
 | an EVCard | 
| 
 | the name of the attribute to get | 
| Returns : | An EVCardAttribute if found, or NULL. | 
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.
| 
 | an EVCard | 
| Returns : | A list of attributes of type EVCardAttribute. | 
const gchar *       e_vcard_attribute_get_group         (EVCardAttribute *attr);
Gets the group name of attr.
| 
 | an EVCardAttribute | 
| Returns : | The attribute's group name. | 
const gchar *       e_vcard_attribute_get_name          (EVCardAttribute *attr);
Gets the name of attr.
| 
 | an EVCardAttribute | 
| Returns : | The attribute's name. | 
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.
| 
 | an EVCardAttribute | 
| Returns : | A list of string values. | 
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.
| 
 | an EVCardAttribute | 
| Returns : | A list of values of type GString. [transfer: none][element-type] | 
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.
| 
 | an EVCardAttribute | 
| Returns : | A list of elements of type EVCardAttributeParam. | 
GList * e_vcard_attribute_get_param (EVCardAttribute *attr,const gchar *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.
| 
 | an EVCardAttribute | 
| 
 | a parameter name | 
| Returns : | A list of string elements representing the parameter's values. [transfer: none][element-type] | 
gchar *                  e_vcard_attribute_get_value    (EVCardAttribute *attr);
Gets the value of a single-valued EVCardAttribute, attr.
| 
 | an EVCardAttribute | 
| Returns : | A newly allocated string representing the value. | 
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.
| 
 | an EVCardAttribute | 
| Returns : | A newly allocated GString representing the value. | 
gboolean e_vcard_attribute_has_type (EVCardAttribute *attr,const gchar *typestr);
Checks if attr has an EVCardAttributeParam of the specified type.
| 
 | an EVCardAttribute | 
| 
 | a string representing the type | 
| Returns : | TRUEif such a parameter exists,FALSEotherwise. | 
gboolean            e_vcard_attribute_is_single_valued  (EVCardAttribute *attr);
Checks if attr has a single value.
| 
 | an EVCardAttribute | 
| Returns : | TRUEif the attribute has exactly one value,FALSEotherwise. | 
gchar *             e_vcard_escape_string               (const gchar *s);
Escapes a string according to RFC2426, section 5.
| 
 | the string to escape | 
| Returns : | A newly allocated, escaped string. | 
gchar *             e_vcard_unescape_string             (const gchar *s);
Unescapes a string according to RFC2426, section 5.
| 
 | the string to unescape | 
| Returns : | A newly allocated, unescaped string. | 
#define EVC_ICSCALENDAR "ICSCALENDAR" /* XXX should this be X-EVOLUTION-ICSCALENDAR? */
#define EVC_X_DEST_EMAIL "X-EVOLUTION-DEST-EMAIL"
EVC_X_DEST_EMAIL is deprecated and should not be used in newly-written code.
#define EVC_X_DEST_NAME "X-EVOLUTION-DEST-NAME"
EVC_X_DEST_NAME is deprecated and should not be used in newly-written code.