CamelVeeSummary: Camel Reference Manual

## CamelVeeSummary CamelVeeSummary |

## Functions

CamelFolderSummary * | camel_vee_summary_new ()
CamelVeeMessageInfo * | camel_vee_summary_add ()
void | camel_vee_summary_remove ()
gboolean | camel_vee_summary_replace_flags ()
GHashTable * | camel_vee_summary_get_uids_for_subfolder ()
CamelStoreSearchIndex * | camel_vee_summary_to_match_index ()

## Object Hierarchy

        GObject
        ╰── CamelFolderSummary
            ╰── CamelVeeSummary

## Description

## Functions

### camel_vee_summary_new ()

    CamelFolderSummary *
    camel_vee_summary_new (CamelFolder *parent);

This will create a new CamelVeeSummary object and read in the summary data from disk, if it exists.

#### Parameters

parent | Folder its attached to. |

#### Returns

A new CamelVeeSummary object.

### camel_vee_summary_add ()

    CamelVeeMessageInfo *
    camel_vee_summary_add (CamelVeeSummary *summary,
                           CamelFolder *subfolder,
                           const gchar *vuid);

Unref returned pointer with `g_object_unref()`

[skip]

#### Parameters

summary | the CamelVeeSummary |
subfolder | a CamelFolder the `vuid` references |
vuid | a message UID as referenced in the `summary` |

#### Returns

A new CamelVeeMessageInfo object.

[transfer full]

Since: 3.58

### camel_vee_summary_remove ()

    void
    camel_vee_summary_remove (CamelVeeSummary *summary,
                              CamelFolder *subfolder,
                              const gchar *vuid);

Removes the given `vuid` of the `subfolder` from the `summary` .

[skip]

#### Parameters

summary | a CamelVeeSummary |
subfolder | a CamelFolder to which `vuid` belongs |
vuid | a virtual message info UID to remove |

Since: 3.58

### camel_vee_summary_replace_flags ()

    gboolean
    camel_vee_summary_replace_flags (CamelVeeSummary *vsummary,
                                     const gchar *vuid);

Makes sure `vsummary` flags on `uid` corresponds to those in the subfolder of vee-folder, and updates internal counts on `vsummary` as well.

[skip]

#### Parameters

vsummary | a CamelVeeSummary |
vuid | a message UID to update flags for |

#### Returns

whether any count changed

Since: 3.58

### camel_vee_summary_get_uids_for_subfolder ()

    GHashTable *
    camel_vee_summary_get_uids_for_subfolder
                                   (CamelVeeSummary *summary,
                                    CamelFolder *subfolder);

Returns a hash table of all virtual message info UID-s known to the `summary` . The key of the hash table is the virtual message info UID, the value is only the number 1.

[skip]

#### Parameters

summary | a CamelVeeSummary |
subfolder | a CamelFolder |

#### Returns

a GHashTable with all the virtual mesasge info UID-s knwn to the `summary` .

[element-type utf8 gint][transfer container]

Since: 3.6

### camel_vee_summary_to_match_index ()

    CamelStoreSearchIndex *
    camel_vee_summary_to_match_index (CamelVeeSummary *self);

Converts current content of the `self` into an array of match indexes CamelStoreSearchIndex.

[skip]

#### Parameters

self | a CamelVeeSummary |

#### Returns

a new CamelStoreSearchIndex representing real folders belonging to the `self` .

[transfer full]

Since: 3.58