Top | ![]() |
![]() |
![]() |
![]() |
gboolean | check-all | Read / Write / Construct |
gboolean | check-subscribed | Read / Write / Construct |
guint | concurrent-connections | Read / Write / Construct |
CamelSortType | fetch-order | Read / Write / Construct |
gboolean | filter-all | Read / Write / Construct |
gboolean | filter-junk | Read / Write / Construct |
gboolean | filter-junk-inbox | Read / Write / Construct |
gboolean | full-update-on-metered-network | Read / Write / Construct |
gboolean | ignore-other-users-namespace | Read / Write / Construct |
gboolean | ignore-shared-folders-namespace | Read / Write / Construct |
char * | namespace | Read / Write / Construct |
char * | real-junk-path | Read / Write / Construct |
char * | real-trash-path | Read / Write / Construct |
char * | shell-command | Read / Write / Construct |
gboolean | use-idle | Read / Write / Construct |
gboolean | use-multi-fetch | Read / Write / Construct |
gboolean | use-namespace | Read / Write / Construct |
gboolean | use-qresync | Read / Write / Construct |
gboolean | use-real-junk-path | Read / Write / Construct |
gboolean | use-real-trash-path | Read / Write / Construct |
gboolean | use-shell-command | Read / Write / Construct |
gboolean | use-subscriptions | Read / Write / Construct |
GObject ╰── CamelSettings ╰── CamelStoreSettings ╰── CamelOfflineSettings ╰── CamelIMAPXSettings
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.
Since: 3.20
void camel_imapx_settings_set_use_multi_fetch (CamelIMAPXSettings *settings
,guint use_multi_fetch
);
Sets whether can download large messages in chunks.
Since: 3.20
gboolean
camel_imapx_settings_get_check_all (CamelIMAPXSettings *settings
);
Returns whether to check all folders for new messages.
Since: 3.2
void camel_imapx_settings_set_check_all (CamelIMAPXSettings *settings
,gboolean check_all
);
Sets whether to check all folders for new messages.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.16
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.
Since: 3.16
CamelSortType
camel_imapx_settings_get_fetch_order (CamelIMAPXSettings *settings
);
Returns the order in which new messages should be fetched.
Since: 3.2
void camel_imapx_settings_set_fetch_order (CamelIMAPXSettings *settings
,CamelSortType fetch_order
);
Sets the order in which new messages should be fetched.
Since: 3.2
gboolean
camel_imapx_settings_get_filter_all (CamelIMAPXSettings *settings
);
Returns whether apply filters in all folders.
Since: 3.4
void camel_imapx_settings_set_filter_all (CamelIMAPXSettings *settings
,gboolean filter_all
);
Sets whether to apply filters in all folders.
Since: 3.4
gboolean
camel_imapx_settings_get_filter_junk (CamelIMAPXSettings *settings
);
Returns whether to automatically find and tag junk messages amongst new messages in all folders.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
const gchar *
camel_imapx_settings_get_namespace (CamelIMAPXSettings *settings
);
Returns the custom IMAP namespace in which to find folders.
Since: 3.2
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.
Since: 3.4
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.
Since: 3.2
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.2
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.
Since: 3.4
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.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
gboolean
camel_imapx_settings_get_ignore_other_users_namespace
(CamelIMAPXSettings *settings
);
Returns whether to ignore namespace for other users.
Since: 3.16
void camel_imapx_settings_set_ignore_other_users_namespace (CamelIMAPXSettings *settings
,gboolean ignore
);
Sets whether to ignore other users namespace.
Since: 3.16
gboolean
camel_imapx_settings_get_ignore_shared_folders_namespace
(CamelIMAPXSettings *settings
);
Returns whether to ignore namespace for shared folders.
Since: 3.16
void camel_imapx_settings_set_ignore_shared_folders_namespace (CamelIMAPXSettings *settings
,gboolean ignore
);
Sets whether to ignore shared folders namespace.
Since: 3.16
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.
Since: 3.2
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.
Since: 3.2
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.8
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.
Since: 3.2
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 |
||
use_shell_command |
whether to use a custom shell command to connect to the server |
Since: 3.2
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.
Since: 3.2
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.
Since: 3.2
gboolean
camel_imapx_settings_get_full_update_on_metered_network
(CamelIMAPXSettings *settings
);
Returns whether to allow full folder update on metered network. With this off the folder update skips updates of the known messages, which can lead to not removing removed messages or not updating flags of the old messages. The option is meant to save bandwidth usage on the metered network.
Since: 3.34
void camel_imapx_settings_set_full_update_on_metered_network (CamelIMAPXSettings *settings
,gboolean full_update_on_metered_network
);
Sets whether to allow full folder update on metered network.
Since: 3.34
“check-all”
property“check-all” gboolean
Check all folders for new messages.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“check-subscribed”
property“check-subscribed” gboolean
Check only subscribed folders for new messages.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“concurrent-connections”
property“concurrent-connections” guint
Number of concurrent IMAP connections to use.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Allowed values: [1,7]
Default value: 3
“fetch-order”
property“fetch-order” CamelSortType
Order in which new messages should be fetched.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: CAMEL_SORT_ASCENDING
“filter-all”
property“filter-all” gboolean
Whether to apply filters in all folders.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“filter-junk”
property“filter-junk” gboolean
Whether to filter junk from all folders.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“filter-junk-inbox”
property“filter-junk-inbox” gboolean
Whether to filter junk from Inbox only.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“full-update-on-metered-network”
property“full-update-on-metered-network” gboolean
Whether can do full folder update even on metered network.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: TRUE
“ignore-other-users-namespace”
property“ignore-other-users-namespace” gboolean
Whether to ignore other users namespace.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“ignore-shared-folders-namespace”
property“ignore-shared-folders-namespace” gboolean
Whether to ignore shared folders namespace.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“namespace”
property “namespace” char *
Custom IMAP namespace.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: NULL
“real-junk-path”
property “real-junk-path” char *
Path for a non-virtual Junk folder.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: NULL
“real-trash-path”
property “real-trash-path” char *
Path for a non-virtual Trash folder.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: NULL
“shell-command”
property “shell-command” char *
Shell command for connecting to the server.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: "ssh -C -l %u %h exec /usr/sbin/imapd"
“use-idle”
property“use-idle” gboolean
Whether to use the IDLE IMAP extension.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: TRUE
“use-multi-fetch”
property“use-multi-fetch” gboolean
Whether allow downloading of large messages in chunks.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“use-namespace”
property“use-namespace” gboolean
Whether to use a custom IMAP namespace.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“use-qresync”
property“use-qresync” gboolean
Whether to use the QRESYNC IMAP extension.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“use-real-junk-path”
property“use-real-junk-path” gboolean
Whether to use a non-virtual Junk folder.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“use-real-trash-path”
property“use-real-trash-path” gboolean
Whether to use a non-virtual Trash folder.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“use-shell-command”
property“use-shell-command” gboolean
Whether to use a custom shellcommand to connect to the server.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE
“use-subscriptions”
property“use-subscriptions” gboolean
Whether to honor folder subscriptions.
Owner: CamelIMAPXSettings
Flags: Read / Write / Construct
Default value: FALSE