CamelIMAPXSettings

CamelIMAPXSettings

Synopsis

struct              CamelIMAPXSettings;
guint               camel_imapx_settings_get_use_multi_fetch
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_multi_fetch
                                                        (CamelIMAPXSettings *settings,
                                                         guint use_multi_fetch);
gboolean            camel_imapx_settings_get_check_all  (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_check_all  (CamelIMAPXSettings *settings,
                                                         gboolean check_all);
gboolean            camel_imapx_settings_get_check_subscribed
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_check_subscribed
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean check_subscribed);
CamelSortType       camel_imapx_settings_get_fetch_order
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_fetch_order
                                                        (CamelIMAPXSettings *settings,
                                                         CamelSortType fetch_order);
gboolean            camel_imapx_settings_get_filter_all (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_filter_all (CamelIMAPXSettings *settings,
                                                         gboolean filter_all);
gboolean            camel_imapx_settings_get_filter_junk
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_filter_junk
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean filter_junk);
gboolean            camel_imapx_settings_get_filter_junk_inbox
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_filter_junk_inbox
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean filter_junk_inbox);
const gchar *       camel_imapx_settings_get_namespace  (CamelIMAPXSettings *settings);
gchar *             camel_imapx_settings_dup_namespace  (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_namespace  (CamelIMAPXSettings *settings,
                                                         const gchar *namespace_);
const gchar *       camel_imapx_settings_get_real_junk_path
                                                        (CamelIMAPXSettings *settings);
gchar *             camel_imapx_settings_dup_real_junk_path
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_real_junk_path
                                                        (CamelIMAPXSettings *settings,
                                                         const gchar *real_junk_path);
const gchar *       camel_imapx_settings_get_real_trash_path
                                                        (CamelIMAPXSettings *settings);
gchar *             camel_imapx_settings_dup_real_trash_path
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_real_trash_path
                                                        (CamelIMAPXSettings *settings,
                                                         const gchar *real_trash_path);
const gchar *       camel_imapx_settings_get_shell_command
                                                        (CamelIMAPXSettings *settings);
gchar *             camel_imapx_settings_dup_shell_command
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_shell_command
                                                        (CamelIMAPXSettings *settings,
                                                         const gchar *shell_command);
gboolean            camel_imapx_settings_get_use_idle   (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_idle   (CamelIMAPXSettings *settings,
                                                         gboolean use_idle);
gboolean            camel_imapx_settings_get_use_namespace
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_namespace
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_namespace);
gboolean            camel_imapx_settings_get_use_qresync
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_qresync
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_qresync);
gboolean            camel_imapx_settings_get_use_real_junk_path
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_real_junk_path
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_real_junk_path);
gboolean            camel_imapx_settings_get_use_real_trash_path
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_real_trash_path
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_real_trash_path);
gboolean            camel_imapx_settings_get_use_shell_command
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_shell_command
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_shell_command);
gboolean            camel_imapx_settings_get_use_subscriptions
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_use_subscriptions
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_subscriptions);
guint               camel_imapx_settings_get_concurrent_connections
                                                        (CamelIMAPXSettings *settings);
gboolean            camel_imapx_settings_get_ignore_other_users_namespace
                                                        (CamelIMAPXSettings *settings);
gboolean            camel_imapx_settings_get_ignore_shared_folders_namespace
                                                        (CamelIMAPXSettings *settings);
void                camel_imapx_settings_set_concurrent_connections
                                                        (CamelIMAPXSettings *settings,
                                                         guint concurrent_connections);
void                camel_imapx_settings_set_ignore_other_users_namespace
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean ignore);
void                camel_imapx_settings_set_ignore_shared_folders_namespace
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean ignore);

Object Hierarchy

  GObject
   +----CamelSettings
         +----CamelStoreSettings
               +----CamelOfflineSettings
                     +----CamelIMAPXSettings

Implemented Interfaces

CamelIMAPXSettings implements CamelNetworkSettings.

Properties

  "check-all"                gboolean              : Read / Write / Construct
  "check-subscribed"         gboolean              : Read / Write / Construct
  "concurrent-connections"   guint                 : Read / Write / Construct
  "fetch-order"              CamelSortType         : Read / Write / Construct
  "filter-all"               gboolean              : Read / Write / Construct
  "filter-junk"              gboolean              : Read / Write / Construct
  "filter-junk-inbox"        gboolean              : Read / Write / Construct
  "ignore-other-users-namespace" gboolean              : Read / Write / Construct
  "ignore-shared-folders-namespace" gboolean              : Read / Write / Construct
  "namespace"                gchar*                : Read / Write / Construct
  "real-junk-path"           gchar*                : Read / Write / Construct
  "real-trash-path"          gchar*                : Read / Write / Construct
  "shell-command"            gchar*                : Read / Write / Construct
  "use-idle"                 gboolean              : Read / Write / Construct
  "use-multi-fetch"          gboolean              : Read / Write / Construct
  "use-namespace"            gboolean              : Read / Write / Construct
  "use-qresync"              gboolean              : Read / Write / Construct
  "use-real-junk-path"       gboolean              : Read / Write / Construct
  "use-real-trash-path"      gboolean              : Read / Write / Construct
  "use-shell-command"        gboolean              : Read / Write / Construct
  "use-subscriptions"        gboolean              : Read / Write / Construct

Description

Details

struct CamelIMAPXSettings

struct CamelIMAPXSettings;

camel_imapx_settings_get_use_multi_fetch ()

guint               camel_imapx_settings_get_use_multi_fetch
                                                        (CamelIMAPXSettings *settings);

Returns whether large messages can be downloaded in chunks. The default is TRUE, but some server can be slower when the messages are downloaded in parts, rather than in one call.

settings :

a CamelIMAPXSettings

Returns :

whether large messages can be downloaded in chunks

Since 3.20


camel_imapx_settings_set_use_multi_fetch ()

void                camel_imapx_settings_set_use_multi_fetch
                                                        (CamelIMAPXSettings *settings,
                                                         guint use_multi_fetch);

Sets whether can download large messages in chunks.

settings :

a CamelIMAPXSettings

use_multi_fetch :

whether can download large messages in chunks

Since 3.20


camel_imapx_settings_get_check_all ()

gboolean            camel_imapx_settings_get_check_all  (CamelIMAPXSettings *settings);

Returns whether to check all folders for new messages.

settings :

a CamelIMAPXSettings

Returns :

whether to check all folders for new messages

Since 3.2


camel_imapx_settings_set_check_all ()

void                camel_imapx_settings_set_check_all  (CamelIMAPXSettings *settings,
                                                         gboolean check_all);

Sets whether to check all folders for new messages.

settings :

a CamelIMAPXSettings

check_all :

whether to check all folders for new messages

Since 3.2


camel_imapx_settings_get_check_subscribed ()

gboolean            camel_imapx_settings_get_check_subscribed
                                                        (CamelIMAPXSettings *settings);

Returns whether to check only subscribed folders for new messages. Note that "check-all", if TRUE, overrides this setting.

settings :

a CamelIMAPXSettings

Returns :

whether to check only subscribed folders for new messages

Since 3.2


camel_imapx_settings_set_check_subscribed ()

void                camel_imapx_settings_set_check_subscribed
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean check_subscribed);

Sets whether to check only subscribed folders for new messages. Note that "check-all", if TRUE, overrides this setting.

settings :

a CamelIMAPXSettings

check_subscribed :

whether to check only subscribed folders for new messages

Since 3.2


camel_imapx_settings_get_fetch_order ()

CamelSortType       camel_imapx_settings_get_fetch_order
                                                        (CamelIMAPXSettings *settings);

Returns the order in which new messages should be fetched.

settings :

a CamelIMAPXSettings

Returns :

the order in which new messages should be fetched

Since 3.2


camel_imapx_settings_set_fetch_order ()

void                camel_imapx_settings_set_fetch_order
                                                        (CamelIMAPXSettings *settings,
                                                         CamelSortType fetch_order);

Sets the order in which new messages should be fetched.

settings :

a CamelIMAPXSettings

fetch_order :

the order in which new messages should be fetched

Since 3.2


camel_imapx_settings_get_filter_all ()

gboolean            camel_imapx_settings_get_filter_all (CamelIMAPXSettings *settings);

Returns whether apply filters in all folders.

settings :

a CamelIMAPXSettings

Returns :

whether to apply filters in all folders

Since 3.4


camel_imapx_settings_set_filter_all ()

void                camel_imapx_settings_set_filter_all (CamelIMAPXSettings *settings,
                                                         gboolean filter_all);

Sets whether to apply filters in all folders.

settings :

a CamelIMAPXSettings

filter_all :

whether to apply filters in all folders

Since 3.4


camel_imapx_settings_get_filter_junk ()

gboolean            camel_imapx_settings_get_filter_junk
                                                        (CamelIMAPXSettings *settings);

Returns whether to automatically find and tag junk messages amongst new messages in all folders.

settings :

a CamelIMAPXSettings

Returns :

whether to filter junk in all folders

Since 3.2


camel_imapx_settings_set_filter_junk ()

void                camel_imapx_settings_set_filter_junk
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean filter_junk);

Sets whether to automatically find and tag junk messages amongst new messages in all folders.

settings :

a CamelIMAPXSettings

filter_junk :

whether to filter junk in all folders

Since 3.2


camel_imapx_settings_get_filter_junk_inbox ()

gboolean            camel_imapx_settings_get_filter_junk_inbox
                                                        (CamelIMAPXSettings *settings);

Returns whether to automatically find and tag junk messages amongst new messages in the Inbox folder only.

settings :

a CamelIMAPXSettings

Returns :

whether to filter junk in Inbox only

Since 3.2


camel_imapx_settings_set_filter_junk_inbox ()

void                camel_imapx_settings_set_filter_junk_inbox
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean filter_junk_inbox);

Sets whether to automatically find and tag junk messages amongst new messages in the Inbox folder only.

settings :

a CamelIMAPXSettings

filter_junk_inbox :

whether to filter junk in Inbox only

Since 3.2


camel_imapx_settings_get_namespace ()

const gchar *       camel_imapx_settings_get_namespace  (CamelIMAPXSettings *settings);

Returns the custom IMAP namespace in which to find folders.

settings :

a CamelIMAPXSettings

Returns :

the custom IMAP namespace, or NULL

Since 3.2


camel_imapx_settings_dup_namespace ()

gchar *             camel_imapx_settings_dup_namespace  (CamelIMAPXSettings *settings);

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

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

settings :

a CamelIMAPXSettings

Returns :

a newly-allocated copy of "namespace"

Since 3.4


camel_imapx_settings_set_namespace ()

void                camel_imapx_settings_set_namespace  (CamelIMAPXSettings *settings,
                                                         const gchar *namespace_);

Sets the custom IMAP namespace in which to find folders. If namespace_ is NULL, the default namespace is used.

settings :

a CamelIMAPXSettings

namespace_ :

an IMAP namespace, or NULL

Since 3.2


camel_imapx_settings_get_real_junk_path ()

const gchar *       camel_imapx_settings_get_real_junk_path
                                                        (CamelIMAPXSettings *settings);

Returns the path to a real, non-virtual Junk folder to be used instead of Camel's standard virtual Junk folder.

settings :

a CamelIMAPXSettings

Returns :

path to a real junk folder

Since 3.8


camel_imapx_settings_dup_real_junk_path ()

gchar *             camel_imapx_settings_dup_real_junk_path
                                                        (CamelIMAPXSettings *settings);

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

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

settings :

a CamelIMAPXSettings

Returns :

a newly-allocated copy of "real-junk-path"

Since 3.8


camel_imapx_settings_set_real_junk_path ()

void                camel_imapx_settings_set_real_junk_path
                                                        (CamelIMAPXSettings *settings,
                                                         const gchar *real_junk_path);

Sets the path to a real, non-virtual Junk folder to be used instead of Camel's standard virtual Junk folder.

settings :

a CamelIMAPXSettings

real_junk_path :

path to a real Junk folder, or NULL

Since 3.8


camel_imapx_settings_get_real_trash_path ()

const gchar *       camel_imapx_settings_get_real_trash_path
                                                        (CamelIMAPXSettings *settings);

Returns the path to a real, non-virtual Trash folder to be used instead of Camel's standard virtual Trash folder.

settings :

a CamelIMAPXSettings

Returns :

path to a real Trash folder

Since 3.8


camel_imapx_settings_dup_real_trash_path ()

gchar *             camel_imapx_settings_dup_real_trash_path
                                                        (CamelIMAPXSettings *settings);

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

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

settings :

a CamelIMAPXSettings

Returns :

a newly-allocated copy of "real-trash-path"

Since 3.8


camel_imapx_settings_set_real_trash_path ()

void                camel_imapx_settings_set_real_trash_path
                                                        (CamelIMAPXSettings *settings,
                                                         const gchar *real_trash_path);

Sets the path to a real, non-virtual Trash folder to be used instead of Camel's standard virtual Trash folder.

settings :

a CamelIMAPXSettings

real_trash_path :

path to a real Trash folder, or NULL

Since 3.8


camel_imapx_settings_get_shell_command ()

const gchar *       camel_imapx_settings_get_shell_command
                                                        (CamelIMAPXSettings *settings);

Returns an optional shell command used to establish an input/output stream with an IMAP server. Normally the input/output stream is established through a network socket.

This option is useful only to a select few advanced users who likely administer their own IMAP server. Most users will not understand what this option menas or how to use it. Probably not worth exposing in a graphical interface.

settings :

a CamelIMAPXSettings

Returns :

shell command for connecting to the server, or NULL

Since 3.2


camel_imapx_settings_dup_shell_command ()

gchar *             camel_imapx_settings_dup_shell_command
                                                        (CamelIMAPXSettings *settings);

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

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

settings :

a CamelIMAPXSettings

Returns :

a newly-allocated copy of "shell-command"

Since 3.4


camel_imapx_settings_set_shell_command ()

void                camel_imapx_settings_set_shell_command
                                                        (CamelIMAPXSettings *settings,
                                                         const gchar *shell_command);

Sets an optional shell command used to establish an input/output stream with an IMAP server. Normally the input/output stream is established through a network socket.

This option is useful only to a select few advanced users who likely administer their own IMAP server. Most users will not understand what this option means or how to use it. Probably not worth exposing in a graphical interface.

settings :

a CamelIMAPXSettings

shell_command :

shell command for connecting to the server, or NULL

Since 3.2


camel_imapx_settings_get_use_idle ()

gboolean            camel_imapx_settings_get_use_idle   (CamelIMAPXSettings *settings);

Returns whether to use the IMAP IDLE extension if the server supports it. See RFC 2177 for more details.

settings :

a CamelIMAPXSettings

Returns :

whether to use the IDLE extension

Since 3.2


camel_imapx_settings_set_use_idle ()

void                camel_imapx_settings_set_use_idle   (CamelIMAPXSettings *settings,
                                                         gboolean use_idle);

Sets whether to use the IMAP IDLE extension if the server supports it. See RFC 2177 for more details.

settings :

a CamelIMAPXSettings

use_idle :

whether to use the IDLE extension

Since 3.2


camel_imapx_settings_get_use_namespace ()

gboolean            camel_imapx_settings_get_use_namespace
                                                        (CamelIMAPXSettings *settings);

Returns whether to use a custom IMAP namespace to find folders. The namespace itself is given by the "namespace" property.

settings :

a CamelIMAPXSettings

Returns :

whether to use a custom IMAP namespace

Since 3.2


camel_imapx_settings_set_use_namespace ()

void                camel_imapx_settings_set_use_namespace
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_namespace);

Sets whether to use a custom IMAP namespace to find folders. The namespace itself is given by the "namespace" property.

settings :

a CamelIMAPXSettings

use_namespace :

whether to use a custom IMAP namespace

Since 3.2


camel_imapx_settings_get_use_qresync ()

gboolean            camel_imapx_settings_get_use_qresync
                                                        (CamelIMAPXSettings *settings);

Returns whether to use the Quick Mailbox Resynchronization (QRESYNC) IMAP extension if the server supports it. See RFC 5162 for more details.

settings :

a CamelIMAPXSettings

Returns :

whether to use the QRESYNC extension

Since 3.2


camel_imapx_settings_set_use_qresync ()

void                camel_imapx_settings_set_use_qresync
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_qresync);

Sets whether to use the Quick Mailbox Resynchronization (QRESYNC) IMAP extension if the server supports it. See RFC 5162 for more details.

settings :

a CamelIMAPXSettings

use_qresync :

whether to use the QRESYNC extension

Since 3.2


camel_imapx_settings_get_use_real_junk_path ()

gboolean            camel_imapx_settings_get_use_real_junk_path
                                                        (CamelIMAPXSettings *settings);

Returns whether to use a real, non-virtual Junk folder instead of Camel's standard virtual Junk folder.

settings :

a CamelIMAPXSettings

Returns :

whether to use a real Junk folder

Since 3.8


camel_imapx_settings_set_use_real_junk_path ()

void                camel_imapx_settings_set_use_real_junk_path
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_real_junk_path);

Sets whether to use a real, non-virtual Junk folder instead of Camel's standard virtual Junk folder.

settings :

a CamelIMAPXSettings

use_real_junk_path :

whether to use a real Junk folder

Since 3.8


camel_imapx_settings_get_use_real_trash_path ()

gboolean            camel_imapx_settings_get_use_real_trash_path
                                                        (CamelIMAPXSettings *settings);

Returns whether to use a real, non-virtual Trash folder instead of Camel's standard virtual Trash folder.

settings :

a CamelIMAPXSettings

Returns :

whether to use a real Trash folder

Since 3.8


camel_imapx_settings_set_use_real_trash_path ()

void                camel_imapx_settings_set_use_real_trash_path
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_real_trash_path);

Sets whether to use a real, non-virtual Trash folder instead of Camel's standard virtual Trash folder.

settings :

a CamelIMAPXSettings

use_real_trash_path :

whether to use a real Trash folder

Since 3.8


camel_imapx_settings_get_use_shell_command ()

gboolean            camel_imapx_settings_get_use_shell_command
                                                        (CamelIMAPXSettings *settings);

Returns whether to use a custom shell command to establish an input/output stream with an IMAP server, instead of the more common method of opening a network socket. The shell command itself is given by the "shell-command" property.

This option is useful only to a select few advanced users who likely administer their own IMAP server. Most users will not understand what this option means or how to use it. Probably not worth exposing in a graphical interface.

settings :

a CamelIMAPXSettings

Returns :

whether to use a custom shell command to connect to the server

Since 3.2


camel_imapx_settings_set_use_shell_command ()

void                camel_imapx_settings_set_use_shell_command
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_shell_command);

Sets whether to use a custom shell command to establish an input/output stream with an IMAP server, instead of the more common method of opening a network socket. The shell command itself is given by the "shell-command" property.

This option is useful only to a select few advanced users who likely administer their own IMAP server. Most users will not understand what this option means or how to use it. Probably not worth exposing in a graphical interface.

settings :

a CamelIMAPXSettings

use_shell_command :

whether to use a custom shell command to connect to the server

Since 3.2


camel_imapx_settings_get_use_subscriptions ()

gboolean            camel_imapx_settings_get_use_subscriptions
                                                        (CamelIMAPXSettings *settings);

Returns whether to list and operate only on subscribed folders, or to list and operate on all available folders regardless of subscriptions.

settings :

a CamelIMAPXSettings

Returns :

whether to honor folder subscriptions

Since 3.2


camel_imapx_settings_set_use_subscriptions ()

void                camel_imapx_settings_set_use_subscriptions
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean use_subscriptions);

Sets whether to list and operate only on subscribed folders, or to list and operate on all available folders regardless of subscriptions.

settings :

a CamelIMAPXSettings

use_subscriptions :

whether to honor folder subscriptions

Since 3.2


camel_imapx_settings_get_concurrent_connections ()

guint               camel_imapx_settings_get_concurrent_connections
                                                        (CamelIMAPXSettings *settings);

Returns the number of concurrent network connections to the IMAP server to use for faster command/response processing.

settings :

a CamelIMAPXSettings

Returns :

the number of concurrent connections to use

Since 3.16


camel_imapx_settings_get_ignore_other_users_namespace ()

gboolean            camel_imapx_settings_get_ignore_other_users_namespace
                                                        (CamelIMAPXSettings *settings);

Returns whether to ignore namespace for other users.

settings :

a CamelIMAPXSettings

Returns :

whether to ignore namespace for other users

Since 3.16


camel_imapx_settings_get_ignore_shared_folders_namespace ()

gboolean            camel_imapx_settings_get_ignore_shared_folders_namespace
                                                        (CamelIMAPXSettings *settings);

Returns whether to ignore namespace for shared folders.

settings :

a CamelIMAPXSettings

Returns :

whether to ignore namespace for shared folders

Since 3.16


camel_imapx_settings_set_concurrent_connections ()

void                camel_imapx_settings_set_concurrent_connections
                                                        (CamelIMAPXSettings *settings,
                                                         guint concurrent_connections);

Sets the number of concurrent network connections to the IMAP server to use for faster command/response processing.

The minimum number of connections is 1, the maximum is 7. The concurrent_connections value will be clamped to these limits if necessary.

settings :

a CamelIMAPXSettings

concurrent_connections :

the number of concurrent connections to use

Since 3.16


camel_imapx_settings_set_ignore_other_users_namespace ()

void                camel_imapx_settings_set_ignore_other_users_namespace
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean ignore);

Sets whether to ignore other users namespace.

settings :

a CamelIMAPXSettings

ignore :

whether to ignore the namespace

Since 3.16


camel_imapx_settings_set_ignore_shared_folders_namespace ()

void                camel_imapx_settings_set_ignore_shared_folders_namespace
                                                        (CamelIMAPXSettings *settings,
                                                         gboolean ignore);

Sets whether to ignore shared folders namespace.

settings :

a CamelIMAPXSettings

ignore :

whether to ignore the namespace

Since 3.16

Property Details

The "check-all" property

  "check-all"                gboolean              : Read / Write / Construct

Check all folders for new messages.

Default value: FALSE


The "check-subscribed" property

  "check-subscribed"         gboolean              : Read / Write / Construct

Check only subscribed folders for new messages.

Default value: FALSE


The "concurrent-connections" property

  "concurrent-connections"   guint                 : Read / Write / Construct

Number of concurrent IMAP connections to use.

Allowed values: [1,7]

Default value: 3


The "fetch-order" property

  "fetch-order"              CamelSortType         : Read / Write / Construct

Order in which new messages should be fetched.

Default value: CAMEL_SORT_ASCENDING


The "filter-all" property

  "filter-all"               gboolean              : Read / Write / Construct

Whether to apply filters in all folders.

Default value: FALSE


The "filter-junk" property

  "filter-junk"              gboolean              : Read / Write / Construct

Whether to filter junk from all folders.

Default value: FALSE


The "filter-junk-inbox" property

  "filter-junk-inbox"        gboolean              : Read / Write / Construct

Whether to filter junk from Inbox only.

Default value: FALSE


The "ignore-other-users-namespace" property

  "ignore-other-users-namespace" gboolean              : Read / Write / Construct

Whether to ignore other users namespace.

Default value: FALSE


The "ignore-shared-folders-namespace" property

  "ignore-shared-folders-namespace" gboolean              : Read / Write / Construct

Whether to ignore shared folders namespace.

Default value: FALSE


The "namespace" property

  "namespace"                gchar*                : Read / Write / Construct

Custom IMAP namespace.

Default value: NULL


The "real-junk-path" property

  "real-junk-path"           gchar*                : Read / Write / Construct

Path for a non-virtual Junk folder.

Default value: NULL


The "real-trash-path" property

  "real-trash-path"          gchar*                : Read / Write / Construct

Path for a non-virtual Trash folder.

Default value: NULL


The "shell-command" property

  "shell-command"            gchar*                : Read / Write / Construct

Shell command for connecting to the server.

Default value: "ssh -C -l %u %h exec /usr/sbin/imapd"


The "use-idle" property

  "use-idle"                 gboolean              : Read / Write / Construct

Whether to use the IDLE IMAP extension.

Default value: FALSE


The "use-multi-fetch" property

  "use-multi-fetch"          gboolean              : Read / Write / Construct

Whether allow downloading of large messages in chunks.

Default value: FALSE


The "use-namespace" property

  "use-namespace"            gboolean              : Read / Write / Construct

Whether to use a custom IMAP namespace.

Default value: FALSE


The "use-qresync" property

  "use-qresync"              gboolean              : Read / Write / Construct

Whether to use the QRESYNC IMAP extension.

Default value: FALSE


The "use-real-junk-path" property

  "use-real-junk-path"       gboolean              : Read / Write / Construct

Whether to use a non-virtual Junk folder.

Default value: FALSE


The "use-real-trash-path" property

  "use-real-trash-path"      gboolean              : Read / Write / Construct

Whether to use a non-virtual Trash folder.

Default value: FALSE


The "use-shell-command" property

  "use-shell-command"        gboolean              : Read / Write / Construct

Whether to use a custom shell command to connect to the server.

Default value: FALSE


The "use-subscriptions" property

  "use-subscriptions"        gboolean              : Read / Write / Construct

Whether to honor folder subscriptions.

Default value: FALSE