Do ignore empty recipients when checking names
[modest] / src / modest-search.h
1 /* Copyright (c) 2006, 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 #ifndef MODEST_SEARCH_H
31 #define MODEST_SEARCH_H
32
33 #include <glib.h>
34 #include <tny-folder.h>
35
36 #ifndef _GNU_SOURCE
37 #define _GNU_SOURCE
38 #endif
39
40 #ifdef HAVE_CONFIG_H
41 #include <config.h>
42 #endif
43
44 #ifdef MODEST_HAVE_OGS
45 #include <libogs/ogs-text-searcher.h>
46 #endif
47
48 G_BEGIN_DECLS
49
50 typedef enum {
51         MODEST_SEARCH_SUBJECT   = (1 << 0),
52         MODEST_SEARCH_SENDER    = (1 << 1),
53         MODEST_SEARCH_RECIPIENT = (1 << 2),
54         MODEST_SEARCH_SIZE      = (1 << 3),
55         MODEST_SEARCH_BEFORE    = (1 << 4),
56         MODEST_SEARCH_AFTER     = (1 << 5),
57         MODEST_SEARCH_BODY      = (1 << 6),
58         MODEST_SEARCH_USE_OGS   = (1 << 7),
59 } ModestSearchFlags;
60
61 typedef struct {
62         gchar     *msgid; /* E.g. the URI of the message. */
63         gchar     *subject;
64         gchar     *folder; /* The name, not the URI. */
65         gchar     *sender;
66         guint64    msize;
67         gboolean   has_attachment;
68         gboolean   is_unread;
69         gint64     timestamp;            
70 } ModestSearchResultHit;
71
72 typedef struct {
73         gchar *folder; /* The folder to search in */
74         
75         /* Text to search for in various parts: */
76         gchar *subject;
77         gchar *from;
78         gchar *recipient;
79         gchar *body;
80         
81         /* Other criteria: */
82         time_t start_date, end_date;
83         guint32 minsize;
84         ModestSearchFlags flags;
85 #ifdef MODEST_HAVE_OGS
86         gchar     *query; /* The text to search for. */
87         OgsTextSearcher *text_searcher; 
88 #endif
89 } ModestSearch;
90
91 typedef void (*ModestSearchCallback) (GList *hits, gpointer user_data);
92
93 void modest_search_folder (TnyFolder *folder, ModestSearch *search, ModestSearchCallback callback, gpointer user_data);
94 void modest_search_all_accounts (ModestSearch *search, ModestSearchCallback callback, gpointer user_data);
95 void modest_search_account (TnyAccount *account, ModestSearch *search, ModestSearchCallback callback, gpointer user_data);
96 void modest_search_free (ModestSearch *search);
97
98 G_END_DECLS
99
100 #endif
101