src/vcard.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2001-2006 Match Grun and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 /*
  21  * Definitions necessary to access vCard files. vCard files are used
  22  * by GnomeCard for addressbook, and Netscape for sending business
  23  * card information. Refer to RFC2426 for more information.
  24  */
  25
  26 #ifndef __VCARD_H__
  27 #define __VCARD_H__
  28
  29 #include <stdio.h>
  30 #include <glib.h>
  31
  32 #include "addritem.h"
  33 #include "addrcache.h"
  34 #include "adbookbase.h"
  35
  36 #define VCARDBUFSIZE       1024
  37
  38 #define VCARD_TAG_START    "begin"
  39 #define VCARD_TAG_END      "end"
  40 #define VCARD_NAME         "vcard"
  41
  42 #define VCARD_TAG_FULLNAME "fn"
  43 #define VCARD_TAG_NAME     "n"
  44 #define VCARD_TAG_EMAIL    "email"
  45 #define VCARD_TAG_UID      "uid"
  46
  47 #define VCARD_TYPE_QP      "quoted-printable"
  48
  49 #define VCARD_SEP_TAG      ':'
  50 #define VCARD_SEP_TYPE     ';'
  51
  52 /*
  53 * Typical vCard entry:
  54 *
  55 * BEGIN:VCARD
  56 * FN:Axle Rose
  57 * N:Rose;Axle;D;Ms;Jnr
  58 * REV:2001-04-22T03:52:05
  59 * ADR;HOME:;;777 Lexington Avenue;Denver;CO;80299;USA
  60 * ADR;POSTAL:P O Box 777;;;Denver;CO;80298;Usa
  61 * TEL;HOME:303-555-1234
  62 * EMAIL;AOL:axlerose@aol.com
  63 * EMAIL;INTERNET:axlerose@netscape.net
  64 * TITLE:Janitor
  65 * ORG:The Company
  66 * URL:http://www.axlerose.com
  67 * END:VCARD
  68 */
  69
  70 /* vCard object */
  71 typedef struct _VCardFile VCardFile;
  72 struct _VCardFile {
  73         AddressBookType type;
  74         AddressCache *addressCache;
  75         gint     retVal;
  76         FILE     *file;
  77         gchar    *path;
  78         gchar    buffer[ VCARDBUFSIZE ];
  79         gchar    *bufptr;
  80 };
  81
  82 /* Function prototypes */
  83 VCardFile *vcard_create                 ( void );
  84 VCardFile *vcard_create_path            ( const gchar *path );
  85 void vcard_set_name                     ( VCardFile* cardFile, const gchar *value );
  86 void vcard_set_file                     ( VCardFile* cardFile, const gchar *value );
  87 void vcard_set_modified                 ( VCardFile *cardFile, const gboolean value );
  88 void vcard_set_accessed                 ( VCardFile *cardFile, const gboolean value );
  89 gboolean vcard_get_modified             ( VCardFile *cardFile );
  90 gboolean vcard_get_accessed             ( VCardFile *cardFile );
  91 gboolean vcard_get_read_flag            ( VCardFile *cardFile );
  92 void vcard_set_read_flag                ( VCardFile *cardFile, const gboolean value );
  93 gint vcard_get_status                   ( VCardFile *cardFile );
  94 ItemFolder *vcard_get_root_folder       ( VCardFile *cardFile );
  95 gchar *vcard_get_name                   ( VCardFile *cardFile );
  96 void vcard_free                         ( VCardFile *cardFile );
  97 void vcard_force_refresh                ( VCardFile *cardFile );
  98 gint vcard_read_data                    ( VCardFile *cardFile );
  99 GList *vcard_get_list_person            ( VCardFile *cardFile );
 100 GList *vcard_get_list_folder            ( VCardFile *cardFile );
 101 GList *vcard_get_all_persons            ( VCardFile *cardFile );
 102 gboolean vcard_validate                 ( const VCardFile *cardFile );
 103 gchar *vcard_find_gnomecard             ( void );
 104 gint vcard_test_read_file               ( const gchar *fileSpec );
 105
 106 #endif /* __VCARD_H__ */
 107