![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
struct CamelIMAPXSettings; guint camel_imapx_settings_get_batch_fetch_count (CamelIMAPXSettings *settings
); void camel_imapx_settings_set_batch_fetch_count (CamelIMAPXSettings *settings
,guint batch_fetch_count
); 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
); gboolean camel_imapx_settings_get_mobile_mode (CamelIMAPXSettings *settings
); void camel_imapx_settings_set_mobile_mode (CamelIMAPXSettings *settings
,gboolean mobile_mode
); 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
);
GObject +----CamelSettings +----CamelStoreSettings +----CamelOfflineSettings +----CamelIMAPXSettings
"batch-fetch-count" guint : Read / Write / Construct "check-all" gboolean : Read / Write / Construct "check-subscribed" gboolean : 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 "mobile-mode" 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-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
guint camel_imapx_settings_get_batch_fetch_count
(CamelIMAPXSettings *settings
);
Returns the number of message envelopes to fetch at once.
This is a tunable performance parameter and probably should not be exposed in a graphical user interface.
|
a CamelIMAPXSettings |
Returns : |
number of message envelopes to fetch at once |
Since 3.2
void camel_imapx_settings_set_batch_fetch_count (CamelIMAPXSettings *settings
,guint batch_fetch_count
);
Sets the number of message envelopes to fetch at once.
This is a tunable performance parameter and probably should not be exposed in a graphical user interface.
|
a CamelIMAPXSettings |
|
number of message envelopes to fetch at once |
Since 3.2
gboolean camel_imapx_settings_get_check_all (CamelIMAPXSettings *settings
);
Returns whether to check all folders for new messages.
|
a CamelIMAPXSettings |
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.
|
a CamelIMAPXSettings |
|
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.
|
a CamelIMAPXSettings |
Returns : |
whether to check only subscribed folders for new messages |
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.
|
a CamelIMAPXSettings |
|
whether to check only subscribed folders for new messages |
Since 3.2
CamelSortType camel_imapx_settings_get_fetch_order
(CamelIMAPXSettings *settings
);
Returns the order in which new messages should be fetched.
|
a CamelIMAPXSettings |
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.
|
a CamelIMAPXSettings |
|
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.
|
a CamelIMAPXSettings |
Returns : |
whether to 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.
|
a CamelIMAPXSettings |
|
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.
|
a CamelIMAPXSettings |
Returns : |
whether to filter junk 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.
|
a CamelIMAPXSettings |
|
whether to filter junk 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.
|
a CamelIMAPXSettings |
Returns : |
whether to filter junk in Inbox 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.
|
a CamelIMAPXSettings |
|
whether to filter junk in Inbox only |
Since 3.2
gboolean camel_imapx_settings_get_mobile_mode
(CamelIMAPXSettings *settings
);
|
a CamelIMAPXSettings |
Returns : |
whether the backend is operating in mobile mode. |
Since 3.2
void camel_imapx_settings_set_mobile_mode (CamelIMAPXSettings *settings
,gboolean mobile_mode
);
Sets the mode of operation as mobile or not for the backend.
|
a CamelIMAPXSettings |
|
whether to operate in mobile mode. |
Since 3.2
const gchar * camel_imapx_settings_get_namespace (CamelIMAPXSettings *settings
);
Returns the custom IMAP namespace in which to find folders.
|
a CamelIMAPXSettings |
Returns : |
the custom IMAP namespace, or NULL
|
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.
|
a CamelIMAPXSettings |
Returns : |
a newly-allocated copy of "namespace" |
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.
|
a CamelIMAPXSettings |
|
an IMAP namespace, or NULL
|
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.
|
a CamelIMAPXSettings |
Returns : |
path to a real 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.
|
a CamelIMAPXSettings |
Returns : |
a newly-allocated copy of "real-junk-path" |
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.
|
a CamelIMAPXSettings |
|
path to a real Junk folder, or NULL
|
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.
|
a CamelIMAPXSettings |
Returns : |
path to a real 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.
|
a CamelIMAPXSettings |
Returns : |
a newly-allocated copy of "real-trash-path" |
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.
|
a CamelIMAPXSettings |
|
path to a real Trash folder, or NULL
|
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.
|
a CamelIMAPXSettings |
Returns : |
shell command for connecting to the server, or NULL
|
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.
|
a CamelIMAPXSettings |
Returns : |
a newly-allocated copy of "shell-command" |
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.
|
a CamelIMAPXSettings |
|
shell command for connecting to the server, or NULL
|
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.
|
a CamelIMAPXSettings |
Returns : |
whether to use the IDLE extension |
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.
|
a CamelIMAPXSettings |
|
whether to use the IDLE extension |
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.
|
a CamelIMAPXSettings |
Returns : |
whether to use a custom IMAP namespace |
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.
|
a CamelIMAPXSettings |
|
whether to use a custom IMAP namespace |
Since 3.2
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.
|
a CamelIMAPXSettings |
Returns : |
whether to use the QRESYNC extension |
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.
|
a CamelIMAPXSettings |
|
whether to use the QRESYNC extension |
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.
|
a CamelIMAPXSettings |
Returns : |
whether to use a real 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.
|
a CamelIMAPXSettings |
|
whether to use a real 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.
|
a CamelIMAPXSettings |
Returns : |
whether to use a real 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.
|
a CamelIMAPXSettings |
|
whether to use a real 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.
|
a CamelIMAPXSettings |
Returns : |
whether to use a custom shell command to connect to the server |
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.
|
a CamelIMAPXSettings |
|
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.
|
a CamelIMAPXSettings |
Returns : |
whether to honor folder 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.
|
a CamelIMAPXSettings |
|
whether to honor folder subscriptions |
Since 3.2
"batch-fetch-count"
property "batch-fetch-count" guint : Read / Write / Construct
Number of envelopes to fetch at once.
Default value: 500
"check-all"
property "check-all" gboolean : Read / Write / Construct
Check all folders for new messages.
Default value: FALSE
"check-subscribed"
property "check-subscribed" gboolean : Read / Write / Construct
Check only subscribed folders for new messages.
Default value: FALSE
"fetch-order"
property"fetch-order" CamelSortType : Read / Write / Construct
Order in which new messages should be fetched.
Default value: CAMEL_SORT_ASCENDING
"filter-all"
property "filter-all" gboolean : Read / Write / Construct
Whether to apply filters in all folders.
Default value: FALSE
"filter-junk"
property "filter-junk" gboolean : Read / Write / Construct
Whether to filter junk from all folders.
Default value: FALSE
"filter-junk-inbox"
property "filter-junk-inbox" gboolean : Read / Write / Construct
Whether to filter junk from Inbox only.
Default value: FALSE
"mobile-mode"
property "mobile-mode" gboolean : Read / Write / Construct
Mobile mode which adjusts the IMAPX for Mobile clients.
Default value: FALSE
"namespace"
property "namespace" gchar* : Read / Write / Construct
Custom IMAP namespace.
Default value: NULL
"real-junk-path"
property "real-junk-path" gchar* : Read / Write / Construct
Path for a non-virtual Junk folder.
Default value: NULL
"real-trash-path"
property "real-trash-path" gchar* : Read / Write / Construct
Path for a non-virtual Trash folder.
Default value: NULL
"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"
"use-idle"
property "use-idle" gboolean : Read / Write / Construct
Whether to use the IDLE IMAP extension.
Default value: FALSE
"use-namespace"
property "use-namespace" gboolean : Read / Write / Construct
Whether to use a custom IMAP namespace.
Default value: FALSE
"use-qresync"
property "use-qresync" gboolean : Read / Write / Construct
Whether to use the QRESYNC IMAP extension.
Default value: FALSE
"use-real-junk-path"
property "use-real-junk-path" gboolean : Read / Write / Construct
Whether to use a non-virtual Junk folder.
Default value: FALSE
"use-real-trash-path"
property "use-real-trash-path" gboolean : Read / Write / Construct
Whether to use a non-virtual Trash folder.
Default value: FALSE
"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