git.maemo.org Git - modest/blob - src/modest-address-book.h

   1 /* Copyright (c) 2007, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /* modest-address-book.h */
  31
  32 #ifndef __MODEST_ADDRESS_BOOK_H__
  33 #define __MODEST_ADDRESS_BOOK_H__
  34
  35 #include <gtk/gtkwindow.h>
  36 #include <glib.h>
  37 #include <widgets/modest-recpt-editor.h>
  38
  39 /**
  40  * modest_address_book_init:
  41  *
  42  * initializes the addressbook
  43  */
  44 void
  45 modest_address_book_init (void);
  46
  47 /**
  48  * modest_address_book_add_address:
  49  * @address: a string
  50  *
  51  * launches the UI for adding @address to the addressbook
  52  */
  53 void
  54 modest_address_book_add_address (const gchar *address);
  55
  56 /**
  57  * modest_address_book_select_addresses:
  58  *
  59  * Shows a dialog to select some addresses from the
  60  * address book. It adds them to the recipient editor
  61  *
  62  */
  63 void
  64 modest_address_book_select_addresses (ModestRecptEditor *editor,
  65                                       GtkWindow *parent_window);
  66
  67 /**
  68  * modest_address_book_check_names:
  69  * @editor: a #ModestRecptEditor
  70  * @address_list: if it is not NULL, this list is filled with the
  71  * valid addresses ready to be added to the address book
  72  *
  73  * Performs verification of addresses in a recipient editor.
  74  *
  75  * Returns: %TRUE if all recipients are valid or there are
  76  * no recipients, %FALSE otherwise.
  77  */
  78 gboolean
  79 modest_address_book_check_names (ModestRecptEditor *editor,
  80                                  GSList **address_list);
  81
  82 /**
  83  * modest_address_book_has_address:
  84  * @address: a string
  85  *
  86  * Checks if an address is already stored in addressbook.
  87  *
  88  * Returns: %TRUE is @address is in addressbook. %FALSE otherwise.
  89  */
  90 gboolean
  91 modest_address_book_has_address (const gchar *address);
  92
  93 /**
  94  * modest_address_book_get_my_name:
  95  * @:
  96  *
  97  * Returns user name from user's own vcard
  98  *
  99  * Returns: the user full name
 100  **/
 101 const gchar *
 102 modest_address_book_get_my_name ();
 103
 104 /**
 105  * modest_address_book_add_address_list:
 106  * @address_list: a list of email addresses to add to the addressbook
 107  *
 108  * Inserts a list of addresses in the addressbook
 109  **/
 110 void
 111 modest_address_book_add_address_list (GSList *address_list);
 112
 113 #endif /* __MODEST_ADDRESS_BOOK_H__ */