dm_search.h

/* $Id: dbsearch.h 1562 2005-01-14 15:37:44Z paul $

 Copyright (C) 1999-2004 IC & S  dbmail@ic-s.nl

 This program is free software; you can redistribute it and/or 
 modify it under the terms of the GNU General Public License 
 as published by the Free Software Foundation; either 
 version 2 of the License, or (at your option) any later 
 version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/**
 * \file dbsearch.h
 *
 * \brief Function prototypes for search functionality. 
 */

#ifndef _DBSEARCH_H
#define _DBSEARCH_H

#include "dbmail.h"


/**
 * \brief searches the dbase for messages belonging to mailbox mb
 * and matching the specified key
 * entries of rset will be set for matching msgs 
 * (using their MSN as identifier)
 * \param rset array index by MSN
 * \param setlen length of rset
 * \param sk search key to match
 * \param mb mailbox
 * \return 
 *     - 2 on memory error
 *     - -1 on database error
 *     - 0 on success
 *     - 1 on synchronisation error. mb->exists != setlen 
 *     		(search returned a UID which was not
 *     		in the MSN-list -> mailbox should be 
 *     		updated)
 */
int        db_search(unsigned int *rset, unsigned setlen, 
		search_key_t *sk, mailbox_t * mb);

int db_search_parsed(unsigned int *rset, unsigned setlen, 
		search_key_t *sk, mailbox_t * mb, int condition);

int   db_sort_parsed(unsigned int *rset, unsigned setlen, 
		search_key_t *sk, mailbox_t *mb, int condition);

/**
 * \brief perform search on on the body of a message
 * \param msg mime_message_t struct of message
 * \param sk search key
 * \param msg_idnr
 * \return 
 *     - 0 if no match
 *     - 1 if match
 */
int db_exec_search(GMimeObject *object, search_key_t * sk);


#endif