CamelLocalSettings

CamelLocalSettings

Functions

Types and Values

Description

Functions

camel_local_settings_get_path ()

const gchar *
camel_local_settings_get_path (CamelLocalSettings *settings);

Returns the file path to the root of the local mail store.

Parameters

settings

a CamelLocalSettings

 

Returns

the file path to the local store

Since: 3.4


camel_local_settings_dup_path ()

gchar *
camel_local_settings_dup_path (CamelLocalSettings *settings);

Thread-safe variation of camel_local_settings_get_path(). Use this function when accessing settings from multiple threads.

The returned string should be freed with g_free() when no longer needed.

Parameters

settings

a CamelLocalSettings

 

Returns

a newly-allocated copy of “path”

Since: 3.4


camel_local_settings_set_path ()

void
camel_local_settings_set_path (CamelLocalSettings *settings,
                               const gchar *path);

Sets the file path to the root of the local mail store. Any trailing directory separator characters will be stripped off of the “path” property.

Parameters

settings

a CamelLocalSettings

 

path

the file path to the local store

 

Since: 3.4


camel_local_settings_get_filter_all ()

gboolean
camel_local_settings_get_filter_all (CamelLocalSettings *settings);

Returns whether apply filters in all folders.

Parameters

settings

a CamelLocalSettings

 

Returns

whether to apply filters in all folders

Since: 3.24


camel_local_settings_set_filter_all ()

void
camel_local_settings_set_filter_all (CamelLocalSettings *settings,
                                     gboolean filter_all);

Sets whether to apply filters in all folders.

Parameters

settings

a CamelLocalSettings

 

filter_all

whether to apply filters in all folders

 

Since: 3.24


camel_local_settings_get_filter_junk ()

gboolean
camel_local_settings_get_filter_junk (CamelLocalSettings *settings);

Returns whether to check new messages for junk.

Parameters

settings

a CamelLocalSettings

 

Returns

whether to check new messages for junk

Since: 3.24


camel_local_settings_set_filter_junk ()

void
camel_local_settings_set_filter_junk (CamelLocalSettings *settings,
                                      gboolean filter_junk);

Sets whether to check new messages for junk.

Parameters

settings

a CamelLocalSettings

 

filter_junk

whether to check new messages for junk

 

Since: 3.24

Types and Values

struct CamelLocalSettings

struct CamelLocalSettings {
};

Contains only private data that should be read and manipulated using the functions below.

Since: 3.4