Top | ![]() |
![]() |
![]() |
![]() |
gboolean | build-content | Read / Write |
guint | deleted-count | Read |
CamelFolder * | folder | Read / Write / Construct Only |
guint | junk-count | Read |
guint | junk-not-deleted-count | Read |
gboolean | need-preview | Read / Write |
guint | saved-count | Read |
guint | unread-count | Read |
guint | visible-count | Read |
struct | CamelFolderSummary |
struct | CamelMessageInfo |
struct | CamelMessageInfoBase |
struct | CamelMessageContentInfo |
enum | CamelMessageFlags |
CamelFlag | |
CamelTag | |
CamelSummaryMessageID | |
CamelSummaryReferences | |
enum | CamelFolderSummaryFlags |
enum | CamelFolderSummaryLock |
CamelFolderSummary *
camel_folder_summary_new (struct _CamelFolder *folder
);
Create a new CamelFolderSummary object.
struct _CamelFolder *
camel_folder_summary_get_folder (CamelFolderSummary *summary
);
guint32
camel_folder_summary_get_saved_count (CamelFolderSummary *summary
);
Since 3.4
guint32
camel_folder_summary_get_unread_count (CamelFolderSummary *summary
);
Since 3.4
guint32
camel_folder_summary_get_deleted_count
(CamelFolderSummary *summary
);
Since 3.4
guint32
camel_folder_summary_get_junk_count (CamelFolderSummary *summary
);
Since 3.4
guint32
camel_folder_summary_get_junk_not_deleted_count
(CamelFolderSummary *summary
);
Since 3.4
guint32
camel_folder_summary_get_visible_count
(CamelFolderSummary *summary
);
Since 3.4
void camel_folder_summary_set_index (CamelFolderSummary *summary
,CamelIndex *index
);
Set the index used to index body content. If the index is NULL
, or
not set (the default), no indexing of body content will take place.
Unlike earlier behaviour, build_content need not be set to perform indexing.
CamelIndex *
camel_folder_summary_get_index (CamelFolderSummary *summary
);
Since 3.4
void camel_folder_summary_set_build_content (CamelFolderSummary *summary
,gboolean state
);
Set a flag to tell the summary to build the content info summary (CamelMessageInfo.content). The default is not to build content info summaries.
gboolean
camel_folder_summary_get_build_content
(CamelFolderSummary *summary
);
Since 3.4
void camel_folder_summary_set_need_preview (CamelFolderSummary *summary
,gboolean preview
);
Since 2.28
gboolean
camel_folder_summary_get_need_preview (CamelFolderSummary *summary
);
Since 2.28
guint32
camel_folder_summary_next_uid (CamelFolderSummary *summary
);
Generate a new unique uid value as an integer. This may be used to create a unique sequence of numbers.
void camel_folder_summary_set_next_uid (CamelFolderSummary *summary
,guint32 uid
);
Set the next minimum uid available. This can be used to ensure new uid's do not clash with existing uid's.
summary |
a CamelFolderSummary object |
|
uid |
The next minimum uid to assign. To avoid clashing uid's, set this to the uid of a given messages + 1. |
guint32
camel_folder_summary_get_next_uid (CamelFolderSummary *summary
);
Next uid currently awaiting for assignment. The difference from
camel_folder_summary_next_uid()
is that this function returns actual
value and doesn't increment it before returning.
Since 3.4
gchar *
camel_folder_summary_next_uid_string (CamelFolderSummary *summary
);
Retrieve the next uid, but as a formatted string.
gboolean camel_folder_summary_save_to_db (CamelFolderSummary *summary
,GError **error
);
Since 2.24
gboolean camel_folder_summary_load_from_db (CamelFolderSummary *summary
,GError **error
);
Since 2.24
gboolean camel_folder_summary_header_load_from_db (CamelFolderSummary *summary
,struct _CamelStore *store
,const gchar *folder_name
,GError **error
);
Since 2.24
gboolean camel_folder_summary_header_save_to_db (CamelFolderSummary *summary
,GError **error
);
Since 2.24
void
camel_folder_summary_touch (CamelFolderSummary *summary
);
Mark the summary as changed, so that a save will force it to be written back to disk.
CamelMessageInfo * camel_folder_summary_info_new_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *headers
);
Create a new info record from a header.
CamelMessageInfo * camel_folder_summary_info_new_from_parser (CamelFolderSummary *summary
,CamelMimeParser *parser
);
Create a new info record from a parser. If the parser cannot determine a uid, then none will be assigned.
If indexing is enabled, and the parser cannot determine a new uid, then one is automatically assigned.
If indexing is enabled, then the content will be indexed based
on this new uid. In this case, the message info MUST be
added using :add()
.
Once complete, the parser will be positioned at the end of the message.
CamelMessageInfo * camel_folder_summary_info_new_from_message (CamelFolderSummary *summary
,CamelMimeMessage *message
,const gchar *bodystructure
);
Create a summary item from a message.
summary |
a CamelFodlerSummary object |
|
message |
a CamelMimeMessage object |
|
bodystructure |
a bodystructure or NULL |
CamelMessageContentInfo *
camel_folder_summary_content_info_new (CamelFolderSummary *summary
);
Allocate a new CamelMessageContentInfo, suitable for adding to this summary.
void camel_folder_summary_content_info_free (CamelFolderSummary *summary
,CamelMessageContentInfo *ci
);
Free the content info ci
, and all associated memory.
void camel_folder_summary_add_preview (CamelFolderSummary *summary
,CamelMessageInfo *info
);
Since 2.28
CamelMessageInfo * camel_folder_summary_add_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *headers
);
Build a new info record based on a set of headers, and add it to the summary.
Note that this function should not be used if build_content_info has been specified for this summary.
CamelMessageInfo * camel_folder_summary_add_from_parser (CamelFolderSummary *summary
,CamelMimeParser *parser
);
Build a new info record based on the current position of a CamelMimeParser.
The parser should be positioned before the start of the message to summarise. This function may be used if build_contnet_info or an index has been specified for the summary.
CamelMessageInfo * camel_folder_summary_add_from_message (CamelFolderSummary *summary
,CamelMimeMessage *message
);
Add a summary item from an existing message.
void camel_folder_summary_add (CamelFolderSummary *summary
,CamelMessageInfo *info
);
Adds a new info
record to the summary. If info->uid
is NULL
,
then a new uid is automatically re-assigned by calling
camel_folder_summary_next_uid_string()
.
The info
record should have been generated by calling one of the
info_new_*() functions, as it will be free'd based on the summary
class. And MUST NOT be allocated directly using malloc.
void camel_folder_summary_insert (CamelFolderSummary *summary
,CamelMessageInfo *info
,gboolean load
);
Since 2.24
gboolean camel_folder_summary_remove (CamelFolderSummary *summary
,CamelMessageInfo *info
);
Remove a specific info
record from the summary.
gboolean camel_folder_summary_remove_uid (CamelFolderSummary *summary
,const gchar *uid
);
Remove a specific info record from the summary, by uid
.
gboolean camel_folder_summary_clear (CamelFolderSummary *summary
,GError **error
);
Empty the summary contents.
guint
camel_folder_summary_count (CamelFolderSummary *summary
);
Get the number of summary items stored in this summary.
gboolean camel_folder_summary_check_uid (CamelFolderSummary *summary
,const gchar *uid
);
Check if the uid is valid. This isn't very efficient, so it shouldn't be called iteratively.
Since 2.24
CamelMessageInfo * camel_folder_summary_get (CamelFolderSummary *summary
,const gchar *uid
);
Retrieve a summary item by uid.
A referenced to the summary item is returned, which may be ref'd or free'd as appropriate.
Since 3.4
GPtrArray *
camel_folder_summary_get_array (CamelFolderSummary *summary
);
Obtain a copy of the summary array. This is done atomically, so cannot contain empty entries.
Free with camel_folder_summary_free_array()
Since 3.4
void
camel_folder_summary_free_array (GPtrArray *array
);
Free's array and its elements returned from camel_folder_summary_get_array()
.
Since 3.4
CamelMessageInfo * camel_folder_summary_peek_loaded (CamelFolderSummary *summary
,const gchar *uid
);
Since 2.26
GPtrArray *
camel_folder_summary_get_changed (CamelFolderSummary *summary
);
Since 2.24
void camel_folder_summary_prepare_fetch_all (CamelFolderSummary *summary
,GError **error
);
Loads all infos into memory, if they are not yet and ensures they will not be freed in next couple minutes. Call this function before any mass operation or when all message infos will be needed, for better performance.
Since 2.32
void camel_folder_summary_lock (CamelFolderSummary *summary
,CamelFolderSummaryLock lock
);
Locks summary
's lock
. Unlock it with camel_folder_summary_unlock()
.
Since 2.32
void camel_folder_summary_unlock (CamelFolderSummary *summary
,CamelFolderSummaryLock lock
);
Unlocks summary
's lock
, previously locked with camel_folder_summary_lock()
.
Since 2.32
gboolean camel_flag_get (CamelFlag **list
,const gchar *name
);
Find the state of the flag name
in list
.
gboolean camel_flag_set (CamelFlag **list
,const gchar *name
,gboolean value
);
Set the state of a flag name
in the list list
to value
.
list |
the address of a CamelFlag list |
|
name |
name of the flag to set or change |
|
value |
the value to set on the flag |
gboolean camel_flag_list_copy (CamelFlag **to
,CamelFlag **from
);
Copy a flag list.
gint
camel_flag_list_size (CamelFlag **list
);
Get the length of the flag list.
void
camel_flag_list_free (CamelFlag **list
);
Free the memory associated with the flag list list
.
gboolean camel_system_flag_get (CamelMessageFlags flags
,const gchar *name
);
Find the state of the flag name
in flags
.
const gchar * camel_tag_get (CamelTag **list
,const gchar *name
);
Find the flag name
in list
and get the value.
gboolean camel_tag_set (CamelTag **list
,const gchar *name
,const gchar *value
);
Set the tag name
in the tag list list
to value
.
list |
the address of a CamelTag list |
|
name |
name of the tag to set |
|
value |
value to set on the tag |
gboolean camel_tag_list_copy (CamelTag **to
,CamelTag **from
);
Copy a tag list.
gint
camel_tag_list_size (CamelTag **list
);
Get the number of tags present in the tag list list
.
gpointer
camel_message_info_new (CamelFolderSummary *summary
);
Create a new CamelMessageInfo.
CamelMessageInfo * camel_message_info_new_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *header
);
Create a new CamelMessageInfo pre-populated with info from
header
.
void
camel_message_info_free (gpointer info
);
Unref's and potentially frees a CamelMessageInfo and its contents.
gpointer
camel_message_info_clone (gconstpointer info
);
Duplicate a CamelMessageInfo.
gconstpointer camel_message_info_ptr (const CamelMessageInfo *mi
,gint id
);
Generic accessor method for getting pointer data.
guint32 camel_message_info_uint32 (const CamelMessageInfo *mi
,gint id
);
Generic accessor method for getting 32bit gint data.
time_t camel_message_info_time (const CamelMessageInfo *mi
,gint id
);
Generic accessor method for getting time_t data.
#define camel_message_info_uid(mi) ((const gchar *)((const CamelMessageInfo *)mi)->uid)
#define camel_message_info_subject(mi) ((const gchar *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_SUBJECT))
#define camel_message_info_preview(mi) ((const gchar *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_PREVIEW))
FIXME Document me!
Since 2.28
#define camel_message_info_from(mi) ((const gchar *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_FROM))
#define camel_message_info_to(mi) ((const gchar *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_TO))
#define camel_message_info_cc(mi) ((const gchar *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_CC))
#define camel_message_info_mlist(mi) ((const gchar *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_MLIST))
#define camel_message_info_flags(mi) camel_message_info_uint32((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_FLAGS)
#define camel_message_info_size(mi) camel_message_info_uint32((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_SIZE)
#define camel_message_info_date_sent(mi) camel_message_info_time((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_DATE_SENT)
#define camel_message_info_date_received(mi) camel_message_info_time((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_DATE_RECEIVED)
#define camel_message_info_message_id(mi) ((const CamelSummaryMessageID *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_MESSAGE_ID))
#define camel_message_info_references(mi) ((const CamelSummaryReferences *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_REFERENCES))
#define camel_message_info_user_flags(mi) ((const CamelFlag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_FLAGS))
#define camel_message_info_user_tags(mi) ((const CamelTag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_TAGS))
#define camel_message_info_headers(mi) ((const struct _camel_header_param *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_HEADERS))
FIXME Document me!
Since 2.24
#define camel_message_info_content(mi) ((const CamelMessageContentInfo *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_CONTENT))
FIXME Document me!
Since 2.30
gboolean camel_message_info_user_flag (const CamelMessageInfo *mi
,const gchar *id
);
Get the state of a user flag named id
.
const gchar * camel_message_info_user_tag (const CamelMessageInfo *mi
,const gchar *id
);
Get the value of a user tag named id
.
gboolean camel_message_info_set_flags (CamelMessageInfo *mi
,CamelMessageFlags flags
,guint32 set
);
Change the state of the system flags on the CamelMessageInfo
gboolean camel_message_info_set_user_flag (CamelMessageInfo *mi
,const gchar *id
,gboolean state
);
Set the state of a user flag on a CamelMessageInfo.
gboolean camel_message_info_set_user_tag (CamelMessageInfo *mi
,const gchar *id
,const gchar *val
);
Set the value of a user tag on a CamelMessageInfo.
const CamelMessageContentInfo * camel_folder_summary_guess_content_info (CamelMessageInfo *mi
,CamelContentType *ctype
);
FIXME Document me!
Since 2.30
struct CamelMessageInfo { CamelFolderSummary *summary; guint32 refcount; /* ??? */ const gchar *uid; /*FIXME: Make it work with the CAMEL_MESSADE_DB_DIRTY flag instead of another 4 bytes*/ guint dirty : 1; };
struct CamelMessageInfoBase { CamelFolderSummary *summary; guint32 refcount; /* ??? */ const gchar *uid; /*FIXME: Make it work with the CAMEL_MESSADE_DB_DIRTY flag instead of another 4 bytes*/ guint dirty : 1; const gchar *subject; const gchar *from; const gchar *to; const gchar *cc; const gchar *mlist; CamelMessageFlags flags; guint32 size; time_t date_sent; time_t date_received; CamelSummaryMessageID message_id; CamelSummaryReferences *references;/* from parent to root */ struct _CamelFlag *user_flags; struct _CamelTag *user_tags; /* tree of content description - NULL if it is not available */ CamelMessageContentInfo *content; struct _camel_header_param *headers; gchar *preview; gchar *bodystructure; };
struct CamelMessageContentInfo { CamelMessageContentInfo *next; CamelMessageContentInfo *childs; CamelMessageContentInfo *parent; CamelContentType *type; gchar *id; gchar *description; gchar *encoding; /* this should be an enum?? */ guint32 size; };
typedef struct { struct _CamelFlag *next; gchar name[1]; /* name allocated as part of the structure */ } CamelFlag;
typedef struct { struct _CamelTag *next; gchar *value; gchar name[1]; /* name allocated as part of the structure */ } CamelTag;
typedef struct { union { guint64 id; guchar hash[8]; struct { guint32 hi; guint32 lo; } part; } id; } CamelSummaryMessageID;
typedef struct { gint size; CamelSummaryMessageID references[1]; } CamelSummaryReferences;
“build-content”
property“build-content” gboolean
Whether to build CamelMessageInfo.content.
Flags: Read / Write
Default value: FALSE
“deleted-count”
property“deleted-count” guint
How many deleted infos is saved in a summary.
Flags: Read
Default value: 0
“folder”
property“folder” CamelFolder *
The CamelFolder to which the folder summary belongs.
Flags: Read / Write / Construct Only
“junk-count”
property“junk-count” guint
How many junk infos is saved in a summary.
Flags: Read
Default value: 0
“junk-not-deleted-count”
property“junk-not-deleted-count” guint
How many junk and not deleted infos is saved in a summary.
Flags: Read
Default value: 0
“saved-count”
property“saved-count” guint
How many infos is saved in a summary.
Flags: Read
Default value: 0
“unread-count”
property“unread-count” guint
How many unread infos is saved in a summary.
Flags: Read
Default value: 0
“visible-count”
property“visible-count” guint
How many visible (not deleted and not junk) infos is saved in a summary.
Flags: Read
Default value: 0