Class

CamelFolderSearch

Description

class Camel.FolderSearch : GObject.Object {
  parent: GObject,
  priv: CamelFolderSearchPrivate*
}

No description available.

Ancestors

GObject

Constructors

Functions

camel_folder_search_util_add_months

Increases time t by the given number of months (or decreases, if months is negative).

since: 3.2

camel_folder_search_util_compare_date

Compares date portion of the two date-time values, first converted into the local time zone. The returned value is like with strcmp().

since: 3.30

camel_folder_search_util_hash_message_id

Calculates a hash of the Message-ID header value message_id.

since: 3.40

camel_folder_search_util_make_time

Implementation of ‘make-time’ function, which expects one argument, a string or an integer, to be converted into time_t.

since: 3.30

Instance methods

camel_folder_search_count

Run a search. Search must have had Folder already set on it, and it must implement summaries.

since: 2.26

camel_folder_search_free_result

Frees result of camel_folder_search_search() call.

camel_folder_search_get_current_message_info

No description available.

since: 3.24

camel_folder_search_get_current_summary

No description available.

since: 3.24

camel_folder_search_get_folder

No description available.

since: 3.24

camel_folder_search_get_only_cached_messages

No description available.

since: 3.24

camel_folder_search_get_summary

No description available.

since: 3.24

camel_folder_search_get_summary_empty

No description available.

camel_folder_search_search

Run a search. Search must have had Folder already set on it, and it must implement summaries.

camel_folder_search_set_body_index

Set the index representing the contents of all messages in this folder. If this is not set, then the folder implementation should sub-class the CamelFolderSearch and provide its own body-contains function.

camel_folder_search_set_current_message_info

Sets, or unsets, the info as the currently processing CamelMessageInfo. The function adds its own reference to info, if not NULL.

since: 3.24

camel_folder_search_set_folder

Set the folder attribute of the search. This can be used to perform a slow-search when indexes and so forth are not available. Or for use by subclasses.

camel_folder_search_set_only_cached_messages

Sets whether only locally cached messages can be searched. The default value is FALSE, which means that when a message is required and it is not available locally, then it is downloaded from the server, if possible.

since: 3.24

camel_folder_search_set_summary

Set the array of summary objects representing the span of the search.

camel_folder_search_take_current_message_info

Sets, or unsets, the info as the currently processing CamelMessageInfo. Unlike camel_folder_search_set_current_message_info(), this function assumes ownership of the info, if not NULL.

since: 3.24

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Signals

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct CamelFolderSearchClass {
  GObjectClass parent_class;
  CamelSExpResult* (* and_) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* or_) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* not_) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* lt) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* gt) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* eq) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* match_all) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* match_threads) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpTerm** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* body_contains) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* body_regex) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_contains) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_matches) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_starts_with) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_ends_with) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_exists) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_soundex) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_regex) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* header_full_regex) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* user_flag) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* user_tag) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* system_flag) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* get_sent_date) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* get_received_date) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* get_current_date) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* get_relative_months) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* get_size) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* uid) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* message_location) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* make_time) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* compare_date) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  CamelSExpResult* (* addressbook_contains) (
    CamelSExp* sexp,
    gint argc,
    CamelSExpResult** argv,
    CamelFolderSearch* search
  );
  None reserved;
  
}

No description available.

Class members

parent_class: GObjectClass: No description available.
and_: CamelSExpResult* (* and_) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
or_: CamelSExpResult* (* or_) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
not_: CamelSExpResult* (* not_) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
lt: CamelSExpResult* (* lt) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
gt: CamelSExpResult* (* gt) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
eq: CamelSExpResult* (* eq) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
match_all: CamelSExpResult* (* match_all) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
match_threads: CamelSExpResult* (* match_threads) ( CamelSExp* sexp, gint argc, CamelSExpTerm** argv, CamelFolderSearch* search ): No description available.
body_contains: CamelSExpResult* (* body_contains) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
body_regex: CamelSExpResult* (* body_regex) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_contains: CamelSExpResult* (* header_contains) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_matches: CamelSExpResult* (* header_matches) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_starts_with: CamelSExpResult* (* header_starts_with) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_ends_with: CamelSExpResult* (* header_ends_with) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_exists: CamelSExpResult* (* header_exists) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_soundex: CamelSExpResult* (* header_soundex) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_regex: CamelSExpResult* (* header_regex) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
header_full_regex: CamelSExpResult* (* header_full_regex) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
user_flag: CamelSExpResult* (* user_flag) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
user_tag: CamelSExpResult* (* user_tag) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
system_flag: CamelSExpResult* (* system_flag) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
get_sent_date: CamelSExpResult* (* get_sent_date) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
get_received_date: CamelSExpResult* (* get_received_date) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
get_current_date: CamelSExpResult* (* get_current_date) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
get_relative_months: CamelSExpResult* (* get_relative_months) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
get_size: CamelSExpResult* (* get_size) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
uid: CamelSExpResult* (* uid) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
message_location: CamelSExpResult* (* message_location) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
make_time: CamelSExpResult* (* make_time) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
compare_date: CamelSExpResult* (* compare_date) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
addressbook_contains: CamelSExpResult* (* addressbook_contains) ( CamelSExp* sexp, gint argc, CamelSExpResult** argv, CamelFolderSearch* search ): No description available.
reserved: None: No description available.