![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
struct CamelFolderSummary; struct CamelMessageInfo; struct CamelMessageInfoBase; struct CamelMessageContentInfo; enum CamelMessageFlags; #define CAMEL_MESSAGE_SYSTEM_MASK CamelFlag; CamelTag; CamelSummaryMessageID; CamelSummaryReferences; enum CamelFolderSummaryFlags; enum CamelFolderSummaryLock; CamelFolderSummary * camel_folder_summary_new (struct _CamelFolder *folder
); struct _CamelFolder * camel_folder_summary_get_folder (CamelFolderSummary *summary
); guint32 camel_folder_summary_get_saved_count (CamelFolderSummary *summary
); guint32 camel_folder_summary_get_unread_count (CamelFolderSummary *summary
); guint32 camel_folder_summary_get_deleted_count (CamelFolderSummary *summary
); guint32 camel_folder_summary_get_junk_count (CamelFolderSummary *summary
); guint32 camel_folder_summary_get_junk_not_deleted_count (CamelFolderSummary *summary
); guint32 camel_folder_summary_get_visible_count (CamelFolderSummary *summary
); void camel_folder_summary_set_index (CamelFolderSummary *summary
,CamelIndex *index
); CamelIndex * camel_folder_summary_get_index (CamelFolderSummary *summary
); void camel_folder_summary_set_build_content (CamelFolderSummary *summary
,gboolean state
); gboolean camel_folder_summary_get_build_content (CamelFolderSummary *summary
); void camel_folder_summary_set_need_preview (CamelFolderSummary *summary
,gboolean preview
); gboolean camel_folder_summary_get_need_preview (CamelFolderSummary *summary
); guint32 camel_folder_summary_next_uid (CamelFolderSummary *summary
); void camel_folder_summary_set_next_uid (CamelFolderSummary *summary
,guint32 uid
); guint32 camel_folder_summary_get_next_uid (CamelFolderSummary *summary
); gchar * camel_folder_summary_next_uid_string (CamelFolderSummary *summary
); gboolean camel_folder_summary_save_to_db (CamelFolderSummary *summary
,GError **error
); gboolean camel_folder_summary_load_from_db (CamelFolderSummary *summary
,GError **error
); gboolean camel_folder_summary_header_load_from_db (CamelFolderSummary *summary
,struct _CamelStore *store
,const gchar *folder_name
,GError **error
); gboolean camel_folder_summary_header_save_to_db (CamelFolderSummary *summary
,GError **error
); void camel_folder_summary_touch (CamelFolderSummary *summary
); CamelMessageInfo * camel_folder_summary_info_new_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *headers
); CamelMessageInfo * camel_folder_summary_info_new_from_parser (CamelFolderSummary *summary
,CamelMimeParser *parser
); CamelMessageInfo * camel_folder_summary_info_new_from_message (CamelFolderSummary *summary
,CamelMimeMessage *message
,const gchar *bodystructure
); CamelMessageContentInfo * camel_folder_summary_content_info_new (CamelFolderSummary *summary
); void camel_folder_summary_content_info_free (CamelFolderSummary *summary
,CamelMessageContentInfo *ci
); void camel_folder_summary_add_preview (CamelFolderSummary *summary
,CamelMessageInfo *info
); CamelMessageInfo * camel_folder_summary_add_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *headers
); CamelMessageInfo * camel_folder_summary_add_from_parser (CamelFolderSummary *summary
,CamelMimeParser *parser
); CamelMessageInfo * camel_folder_summary_add_from_message (CamelFolderSummary *summary
,CamelMimeMessage *message
); void camel_folder_summary_add (CamelFolderSummary *summary
,CamelMessageInfo *info
); void camel_folder_summary_insert (CamelFolderSummary *summary
,CamelMessageInfo *info
,gboolean load
); gboolean camel_folder_summary_remove (CamelFolderSummary *summary
,CamelMessageInfo *info
); gboolean camel_folder_summary_remove_uid (CamelFolderSummary *summary
,const gchar *uid
); gboolean camel_folder_summary_remove_uids (CamelFolderSummary *summary
,GList *uids
); gboolean camel_folder_summary_clear (CamelFolderSummary *summary
,GError **error
); guint camel_folder_summary_count (CamelFolderSummary *summary
); gboolean camel_folder_summary_check_uid (CamelFolderSummary *summary
,const gchar *uid
); CamelMessageInfo * camel_folder_summary_get (CamelFolderSummary *summary
,const gchar *uid
); GPtrArray * camel_folder_summary_get_array (CamelFolderSummary *summary
); void camel_folder_summary_free_array (GPtrArray *array
); GHashTable * camel_folder_summary_get_hash (CamelFolderSummary *summary
); gboolean camel_folder_summary_replace_flags (CamelFolderSummary *summary
,CamelMessageInfo *info
); CamelMessageInfo * camel_folder_summary_peek_loaded (CamelFolderSummary *summary
,const gchar *uid
); GPtrArray * camel_folder_summary_get_changed (CamelFolderSummary *summary
); void camel_folder_summary_prepare_fetch_all (CamelFolderSummary *summary
,GError **error
); void camel_folder_summary_lock (CamelFolderSummary *summary
,CamelFolderSummaryLock lock
); void camel_folder_summary_unlock (CamelFolderSummary *summary
,CamelFolderSummaryLock lock
); gboolean camel_flag_get (CamelFlag **list
,const gchar *name
); gboolean camel_flag_set (CamelFlag **list
,const gchar *name
,gboolean value
); gboolean camel_flag_list_copy (CamelFlag **to
,CamelFlag **from
); gint camel_flag_list_size (CamelFlag **list
); void camel_flag_list_free (CamelFlag **list
); CamelMessageFlags camel_system_flag (const gchar *name
); gboolean camel_system_flag_get (CamelMessageFlags flags
,const gchar *name
); const gchar * camel_tag_get (CamelTag **list
,const gchar *name
); gboolean camel_tag_set (CamelTag **list
,const gchar *name
,const gchar *value
); gboolean camel_tag_list_copy (CamelTag **to
,CamelTag **from
); gint camel_tag_list_size (CamelTag **list
); void camel_tag_list_free (CamelTag **list
); gpointer camel_message_info_new (CamelFolderSummary *summary
); gpointer camel_message_info_ref (gpointer info
); CamelMessageInfo * camel_message_info_new_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *header
); void camel_message_info_free (gpointer info
); gpointer camel_message_info_clone (gconstpointer info
); gconstpointer camel_message_info_ptr (const CamelMessageInfo *mi
,gint id
); guint32 camel_message_info_uint32 (const CamelMessageInfo *mi
,gint id
); time_t camel_message_info_time (const CamelMessageInfo *mi
,gint id
); #define camel_message_info_uid (mi) #define camel_message_info_subject (mi) #define camel_message_info_preview (mi) #define camel_message_info_from (mi) #define camel_message_info_to (mi) #define camel_message_info_cc (mi) #define camel_message_info_mlist (mi) #define camel_message_info_flags (mi) #define camel_message_info_size (mi) #define camel_message_info_date_sent (mi) #define camel_message_info_date_received (mi) #define camel_message_info_message_id (mi) #define camel_message_info_references (mi) #define camel_message_info_user_flags (mi) #define camel_message_info_user_tags (mi) #define camel_message_info_headers (mi) #define camel_message_info_content (mi) gboolean camel_message_info_user_flag (const CamelMessageInfo *mi
,const gchar *id
); const gchar * camel_message_info_user_tag (const CamelMessageInfo *mi
,const gchar *id
); gboolean camel_message_info_set_flags (CamelMessageInfo *mi
,CamelMessageFlags flags
,guint32 set
); gboolean camel_message_info_set_user_flag (CamelMessageInfo *mi
,const gchar *id
,gboolean state
); gboolean camel_message_info_set_user_tag (CamelMessageInfo *mi
,const gchar *id
,const gchar *val
); const CamelMessageContentInfo * camel_folder_summary_guess_content_info (CamelMessageInfo *mi
,CamelContentType *ctype
); void camel_content_info_dump (CamelMessageContentInfo *ci
,gint depth
); void camel_message_info_dump (CamelMessageInfo *mi
); gint bdata_extract_digit (gchar **part
); gchar * bdata_extract_string (gchar **part
);
GObject +----CamelObject +----CamelFolderSummary +----CamelIMAPXSummary +----CamelVeeSummary
"build-content" gboolean : Read / Write "deleted-count" guint : Read "folder" CamelFolder* : Read / Write / Construct Only "junk-count" guint : Read "junk-not-deleted-count" guint : Read "need-preview" gboolean : Read / Write "saved-count" guint : Read "unread-count" guint : Read "visible-count" guint : Read
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 enum { CAMEL_MESSAGE_ANSWERED = 1 << 0, CAMEL_MESSAGE_DELETED = 1 << 1, CAMEL_MESSAGE_DRAFT = 1 << 2, CAMEL_MESSAGE_FLAGGED = 1 << 3, CAMEL_MESSAGE_SEEN = 1 << 4, /* these aren't really system flag bits, but are convenience flags */ CAMEL_MESSAGE_ATTACHMENTS = 1 << 5, CAMEL_MESSAGE_ANSWERED_ALL = 1 << 6, CAMEL_MESSAGE_JUNK = 1 << 7, CAMEL_MESSAGE_SECURE = 1 << 8, CAMEL_MESSAGE_USER_NOT_DELETABLE = 1 << 9, CAMEL_MESSAGE_HIDDEN = 1 << 10, CAMEL_MESSAGE_NOTJUNK = 1 << 11, CAMEL_MESSAGE_FORWARDED = 1 << 12, /* following flags are for the folder, and are not really permanent flags */ CAMEL_MESSAGE_FOLDER_FLAGGED = 1 << 16, /* for use by the folder implementation */ /* flags after 1 << 16 are used by camel providers, * if adding non permanent flags, add them to the end */ CAMEL_MESSAGE_JUNK_LEARN = 1 << 30, /* used when setting CAMEL_MESSAGE_JUNK flag * to say that we request junk plugin * to learn that message as junk/non junk */ CAMEL_MESSAGE_USER = 1 << 31 /* supports user flags */ } CamelMessageFlags;
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;
typedef enum { CAMEL_FOLDER_SUMMARY_DIRTY = 1 << 0, CAMEL_FOLDER_SUMMARY_IN_MEMORY_ONLY = 1 << 1 } CamelFolderSummaryFlags;
typedef enum { CAMEL_FOLDER_SUMMARY_SUMMARY_LOCK, CAMEL_FOLDER_SUMMARY_IO_LOCK, CAMEL_FOLDER_SUMMARY_FILTER_LOCK, CAMEL_FOLDER_SUMMARY_ALLOC_LOCK, CAMEL_FOLDER_SUMMARY_REF_LOCK } CamelFolderSummaryLock;
Since 2.32
CamelFolderSummary * camel_folder_summary_new (struct _CamelFolder *folder
);
Create a new CamelFolderSummary object.
|
parent CamelFolder object |
Returns : |
a new CamelFolderSummary object |
struct _CamelFolder * camel_folder_summary_get_folder (CamelFolderSummary *summary
);
guint32 camel_folder_summary_get_saved_count
(CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Count of saved infos. |
Since 3.4
guint32 camel_folder_summary_get_unread_count
(CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Count of unread infos. |
Since 3.4
guint32 camel_folder_summary_get_deleted_count
(CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Count of deleted infos. |
Since 3.4
guint32 camel_folder_summary_get_junk_count (CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Count of junk infos. |
Since 3.4
guint32 camel_folder_summary_get_junk_not_deleted_count
(CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Count of junk and not deleted infos. |
Since 3.4
guint32 camel_folder_summary_get_visible_count
(CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Count of visible (not junk and not deleted) infos. |
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.
|
a CamelFolderSummary object |
|
a CamelIndex |
CamelIndex * camel_folder_summary_get_index (CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
a CamelIndex used to index body content. |
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.
|
a CamelFolderSummary object |
|
to build or not to build the content |
gboolean camel_folder_summary_get_build_content
(CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
Whether to build CamelMessageInfo.content. |
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.
|
a CamelFolderSummary object |
Returns : |
the next unique uid value |
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.
|
a CamelFolderSummary object |
|
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
);
|
a CamelFolderSummary object |
Returns : |
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.
|
a CamelFolderSummary object |
Returns : |
the next uid as an unsigned integer string. This string must be freed by the caller. |
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.
|
a CamelFolderSummary object |
CamelMessageInfo * camel_folder_summary_info_new_from_header (CamelFolderSummary *summary
,struct _camel_header_raw *headers
);
Create a new info record from a header.
|
a CamelFolderSummary object |
|
rfc822 headers |
Returns : |
the newly allocated record which must be freed with
camel_message_info_free()
|
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.
|
a CamelFolderSummary object |
|
a CamelMimeParser object |
Returns : |
the newly allocated record which must be freed with
camel_message_info_free()
|
CamelMessageInfo * camel_folder_summary_info_new_from_message (CamelFolderSummary *summary
,CamelMimeMessage *message
,const gchar *bodystructure
);
Create a summary item from a message.
|
a CamelFodlerSummary object |
|
a CamelMimeMessage object |
|
a bodystructure or NULL |
Returns : |
the newly allocated record which must be freed using
camel_message_info_free()
|
CamelMessageContentInfo * camel_folder_summary_content_info_new
(CamelFolderSummary *summary
);
Allocate a new CamelMessageContentInfo, suitable for adding to this summary.
|
a CamelFolderSummary object |
Returns : |
a newly allocated CamelMessageContentInfo |
void camel_folder_summary_content_info_free (CamelFolderSummary *summary
,CamelMessageContentInfo *ci
);
Free the content info ci
, and all associated memory.
|
a CamelFolderSummary object |
|
a CamelMessageContentInfo |
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.
|
a CamelFolderSummary object |
|
rfc822 headers |
Returns : |
the newly added record |
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.
|
a CamelFolderSummary object |
|
a CamelMimeParser object |
Returns : |
the newly added record |
CamelMessageInfo * camel_folder_summary_add_from_message (CamelFolderSummary *summary
,CamelMimeMessage *message
);
Add a summary item from an existing message.
|
a CamelFolderSummary object |
|
a CamelMimeMessage object |
Returns : |
the newly added record |
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.
|
a CamelFolderSummary object |
|
a CamelMessageInfo |
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.
|
a CamelFolderSummary object |
|
a CamelMessageInfo |
Returns : |
Whether the info was found and removed from the summary . |
gboolean camel_folder_summary_remove_uid (CamelFolderSummary *summary
,const gchar *uid
);
Remove a specific info record from the summary, by uid
.
|
a CamelFolderSummary object |
|
a uid |
Returns : |
Whether the uid was found and removed from the summary . |
gboolean camel_folder_summary_remove_uids (CamelFolderSummary *summary
,GList *uids
);
Remove a specific info record from the summary, by uid
.
|
a CamelFolderSummary object |
|
a GList of uids |
Returns : |
Whether the uid was found and removed from the summary . |
Since 3.6
gboolean camel_folder_summary_clear (CamelFolderSummary *summary
,GError **error
);
Empty the summary contents.
|
a CamelFolderSummary object |
guint camel_folder_summary_count (CamelFolderSummary *summary
);
Get the number of summary items stored in this summary.
|
a CamelFolderSummary object |
Returns : |
the number of items in the 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.
|
a CamelFolderSummary object |
|
a uid |
Returns : |
if the uid is present in the summary or not (TRUE or FALSE ) |
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.
|
a CamelFolderSummary object |
|
a uid |
Returns : |
the summary item, or NULL if the uid uid is not available |
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()
|
a CamelFolderSummary object |
Returns : |
a GPtrArray of uids |
Since 3.4
void camel_folder_summary_free_array (GPtrArray *array
);
Free's array and its elements returned from camel_folder_summary_get_array()
.
|
a GPtrArray returned from camel_folder_summary_get_array()
|
Since 3.4
GHashTable * camel_folder_summary_get_hash (CamelFolderSummary *summary
);
|
a CamelFolderSummary object |
Returns : |
hash of current stored 'uids' in summary, where key is 'uid'
from the string pool, and value is 1. The returned pointer should
be freed with g_hash_table_destroy() .
Note: When searching for values always use uids from the string pool. |
Since 3.6
gboolean camel_folder_summary_replace_flags (CamelFolderSummary *summary
,CamelMessageInfo *info
);
Updates internal counts based on the flags in info
.
|
a CamelFolderSummary |
|
a CamelMessageInfo |
Returns : |
Whether any count changed |
Since 3.6
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.
|
CamelFolderSummary object |
|
return location for a GError, or NULL
|
Since 2.32
void camel_folder_summary_lock (CamelFolderSummary *summary
,CamelFolderSummaryLock lock
);
Locks summary
's lock
. Unlock it with camel_folder_summary_unlock()
.
|
a CamelFolderSummary |
|
lock type to lock |
Since 2.32
void camel_folder_summary_unlock (CamelFolderSummary *summary
,CamelFolderSummaryLock lock
);
Unlocks summary
's lock
, previously locked with camel_folder_summary_lock()
.
|
a CamelFolderSummary |
|
lock type to unlock |
Since 2.32
gboolean camel_flag_get (CamelFlag **list
,const gchar *name
);
Find the state of the flag name
in list
.
|
the address of a CamelFlag list |
|
name of the flag to get |
Returns : |
the state of the flag (TRUE or FALSE ) |
gboolean camel_flag_set (CamelFlag **list
,const gchar *name
,gboolean value
);
Set the state of a flag name
in the list list
to value
.
|
the address of a CamelFlag list |
|
name of the flag to set or change |
|
the value to set on the flag |
Returns : |
TRUE if the value of the flag has been changed or FALSE
otherwise |
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.
|
the address of a CamelFlag list |
Returns : |
the number of flags in the list |
void camel_flag_list_free (CamelFlag **list
);
Free the memory associated with the flag list list
.
|
the address of a CamelFlag list |
CamelMessageFlags camel_system_flag (const gchar *name
);
|
name of a system flag |
Returns : |
the integer value of the system flag string |
gboolean camel_system_flag_get (CamelMessageFlags flags
,const gchar *name
);
Find the state of the flag name
in flags
.
|
bitwise system flags |
|
name of the flag to check for |
Returns : |
TRUE if the named flag is set or FALSE otherwise |
const gchar * camel_tag_get (CamelTag **list
,const gchar *name
);
Find the flag name
in list
and get the value.
|
the address of a CamelTag list |
|
name of the tag to get |
Returns : |
the value of the flag or NULL if unset |
gboolean camel_tag_set (CamelTag **list
,const gchar *name
,const gchar *value
);
Set the tag name
in the tag list list
to value
.
|
the address of a CamelTag list |
|
name of the tag to set |
|
value to set on the tag |
Returns : |
TRUE if the value on the tag changed or FALSE otherwise |
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
.
|
the address of a CamelTag list |
Returns : |
the number of tags |
void camel_tag_list_free (CamelTag **list
);
Free the tag list list
.
|
the address of a CamelTag list |
gpointer camel_message_info_new (CamelFolderSummary *summary
);
Create a new CamelMessageInfo.
|
a CamelFolderSummary object or NULL
|
Returns : |
a new CamelMessageInfo |
gpointer camel_message_info_ref (gpointer info
);
Reference an info.
|
a 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
.
|
a CamelFolderSummary object or NULL
|
|
raw header |
Returns : |
a new CamelMessageInfo |
void camel_message_info_free (gpointer info
);
Unref's and potentially frees a CamelMessageInfo and its contents.
|
a CamelMessageInfo |
gpointer camel_message_info_clone (gconstpointer info
);
Duplicate a CamelMessageInfo.
|
a CamelMessageInfo |
Returns : |
the duplicated CamelMessageInfo |
gconstpointer camel_message_info_ptr (const CamelMessageInfo *mi
,gint id
);
Generic accessor method for getting pointer data.
|
a CamelMessageInfo |
|
info to get |
Returns : |
the pointer data |
guint32 camel_message_info_uint32 (const CamelMessageInfo *mi
,gint id
);
Generic accessor method for getting 32bit gint data.
|
a CamelMessageInfo |
|
info to get |
Returns : |
the gint data |
time_t camel_message_info_time (const CamelMessageInfo *mi
,gint id
);
Generic accessor method for getting time_t data.
|
a CamelMessageInfo |
|
info to get |
Returns : |
the 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!
|
a CamelMessageInfo |
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!
|
a CamelMessageInfo |
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!
|
a CamelMessageInfo |
Since 2.30
gboolean camel_message_info_user_flag (const CamelMessageInfo *mi
,const gchar *id
);
Get the state of a user flag named id
.
|
a CamelMessageInfo |
|
user flag to get |
Returns : |
the state of the user flag |
const gchar * camel_message_info_user_tag (const CamelMessageInfo *mi
,const gchar *id
);
Get the value of a user tag named id
.
|
a CamelMessageInfo |
|
user tag to get |
Returns : |
the value of the user tag |
gboolean camel_message_info_set_flags (CamelMessageInfo *mi
,CamelMessageFlags flags
,guint32 set
);
Change the state of the system flags on the CamelMessageInfo
|
a CamelMessageInfo |
|
mask of flags to change |
|
state the flags should be changed to |
Returns : |
TRUE if any of the flags changed or FALSE otherwise |
gboolean camel_message_info_set_user_flag (CamelMessageInfo *mi
,const gchar *id
,gboolean state
);
Set the state of a user flag on a CamelMessageInfo.
|
a CamelMessageInfo |
|
name of the user flag to set |
|
state to set the flag to |
Returns : |
TRUE if the state changed or FALSE otherwise |
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.
|
a CamelMessageInfo |
|
name of the user tag to set |
|
value to set |
Returns : |
TRUE if the value changed or FALSE otherwise |
const CamelMessageContentInfo * camel_folder_summary_guess_content_info (CamelMessageInfo *mi
,CamelContentType *ctype
);
FIXME Document me!
|
a CamelMessageInfo |
|
a CamelContentType |
Since 2.30
"build-content"
property "build-content" gboolean : Read / Write
Whether to build CamelMessageInfo.content.
Default value: FALSE
"deleted-count"
property "deleted-count" guint : Read
How many deleted infos is saved in a summary.
Default value: 0
"folder"
property"folder" CamelFolder* : Read / Write / Construct Only
The CamelFolder to which the folder summary belongs.
"junk-count"
property "junk-count" guint : Read
How many junk infos is saved in a summary.
Default value: 0
"junk-not-deleted-count"
property "junk-not-deleted-count" guint : Read
How many junk and not deleted infos is saved in a summary.
Default value: 0
"saved-count"
property "saved-count" guint : Read
How many infos is saved in a summary.
Default value: 0
"unread-count"
property "unread-count" guint : Read
How many unread infos is saved in a summary.
Default value: 0