![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
struct CamelPOP3Settings; gint camel_pop3_settings_get_delete_after_days (CamelPOP3Settings *settings
); void camel_pop3_settings_set_delete_after_days (CamelPOP3Settings *settings
,gint delete_after_days
); gboolean camel_pop3_settings_get_delete_expunged (CamelPOP3Settings *settings
); void camel_pop3_settings_set_delete_expunged (CamelPOP3Settings *settings
,gboolean delete_expunged
); gboolean camel_pop3_settings_get_disable_extensions (CamelPOP3Settings *settings
); void camel_pop3_settings_set_disable_extensions (CamelPOP3Settings *settings
,gboolean disable_extensions
); gboolean camel_pop3_settings_get_keep_on_server (CamelPOP3Settings *settings
); void camel_pop3_settings_set_keep_on_server (CamelPOP3Settings *settings
,gboolean keep_on_server
); gboolean camel_pop3_settings_get_auto_fetch (CamelPOP3Settings *settings
); void camel_pop3_settings_set_auto_fetch (CamelPOP3Settings *settings
,gboolean auto_fetch
); gboolean camel_pop3_settings_get_mobile_mode (CamelPOP3Settings *settings
); void camel_pop3_settings_set_mobile_mode (CamelPOP3Settings *settings
,gboolean mobile_mode
); gboolean camel_pop3_settings_get_batch_fetch_count (CamelPOP3Settings *settings
); void camel_pop3_settings_set_batch_fetch_count (CamelPOP3Settings *settings
,gint batch_fetch_count
);
"auto-fetch" gboolean : Read / Write / Construct "batch-fetch-count" gint : Read / Write / Construct "delete-after-days" gint : Read / Write / Construct "delete-expunged" gboolean : Read / Write / Construct "disable-extensions" gboolean : Read / Write / Construct "keep-on-server" gboolean : Read / Write / Construct "mobile-mode" gboolean : Read / Write / Construct
gint camel_pop3_settings_get_delete_after_days
(CamelPOP3Settings *settings
);
Returns the number of days to leave messages on the POP3 server before
automatically deleting them. If the value is zero, messages will not
be automatically deleted. The settings
's "keep-on-server"
property must be TRUE
for this to have any effect.
|
a CamelPOP3Settings |
Returns : |
the number of days to leave messages on the server before automatically deleting them |
Since 3.2
void camel_pop3_settings_set_delete_after_days (CamelPOP3Settings *settings
,gint delete_after_days
);
Sets the number of days to leave messages on the POP3 server before
automatically deleting them. If the value is zero, messages will not
be automatically deleted. The settings
's "keep-on-server"
property must be TRUE
for this to have any effect.
|
a CamelPOP3Settings |
|
the number of days to leave messages on the server before automatically deleting them |
Since 3.2
gboolean camel_pop3_settings_get_delete_expunged
(CamelPOP3Settings *settings
);
Returns whether to delete corresponding messages left on the POP3 server
when expunging the local CamelSettings. The settings
's
"keep-on-server" property must be TRUE
for this to have
any effect.
|
a CamelPOP3Settings |
Returns : |
whether to delete corresponding messages on the server when expunging the local CamelSettings |
Since 3.2
void camel_pop3_settings_set_delete_expunged (CamelPOP3Settings *settings
,gboolean delete_expunged
);
Sets whether to delete corresponding messages left on the POP3 server
when expunging the local CamelSettings. The settings
's
"keep-on-server" property must be TRUE
for this to have
any effect.
|
a CamelPOP3Settings |
|
whether to delete corresponding messages on the server when expunging the local CamelSettings |
Since 3.2
gboolean camel_pop3_settings_get_disable_extensions
(CamelPOP3Settings *settings
);
Returns whether to disable support for POP3 extensions. If TRUE
, the
CamelPOP3Engine will refrain from issuing a "CAPA" command to the server
upon connection.
|
a CamelPOP3Settings |
Returns : |
whether to disable support for POP3 extensions |
Since 3.2
void camel_pop3_settings_set_disable_extensions (CamelPOP3Settings *settings
,gboolean disable_extensions
);
Sets whether to disable support for POP3 extensions. If TRUE
, the
CamelPOP3Engine will refrain from issuing a "CAPA" command to the server
upon connection.
|
a CamelPOP3Settings |
|
whether to disable support for POP3 extensions |
Since 3.2
gboolean camel_pop3_settings_get_keep_on_server
(CamelPOP3Settings *settings
);
Returns whether to leave messages on the remote POP3 server after downloading them to the local Inbox.
|
a CamelPOP3Settings |
Returns : |
whether to leave messages on the POP3 server |
Since 3.2
void camel_pop3_settings_set_keep_on_server (CamelPOP3Settings *settings
,gboolean keep_on_server
);
Sets whether to leave messages on the remote POP3 server after downloading them to the local Inbox.
|
a CamelPOP3Settings |
|
whether to leave messages on the POP3 server |
Since 3.2
gboolean camel_pop3_settings_get_auto_fetch (CamelPOP3Settings *settings
);
Returns whether to download additional mails that may be downloaded later on
|
a CamelPOP3Settings |
Returns : |
whether to download additional mails |
Since 3.4
void camel_pop3_settings_set_auto_fetch (CamelPOP3Settings *settings
,gboolean auto_fetch
);
Sets whether to download additional mails that may be downloaded later on
|
a CamelPOP3Settings |
|
whether to download additional mails |
Since 3.4
gboolean camel_pop3_settings_get_mobile_mode (CamelPOP3Settings *settings
);
Returns whether the provider is operating in mobile mode.
|
a CamelPOP3Settings |
Returns : |
Whether the provider is operating in mobile mode. |
Since 3.4
void camel_pop3_settings_set_mobile_mode (CamelPOP3Settings *settings
,gboolean mobile_mode
);
Sets whether the provider should operate in mobile mode.
|
a CamelPOP3Settings |
|
whether the backend should operate in mobile mode. |
Since 3.4
gboolean camel_pop3_settings_get_batch_fetch_count
(CamelPOP3Settings *settings
);
Returns the batch fetch count while fetching mails.
|
a CamelPOP3Settings |
Returns : |
the batch fetch count. |
Since 3.4
void camel_pop3_settings_set_batch_fetch_count (CamelPOP3Settings *settings
,gint batch_fetch_count
);
Sets the number of mails to download in a batch.
|
a CamelPOP3Settings |
|
number of mails to download in a batch. |
Since 3.4
"auto-fetch"
property "auto-fetch" gboolean : Read / Write / Construct
Automatically fetch additional mails that may be downloaded later.
Default value: TRUE
"batch-fetch-count"
property "batch-fetch-count" gint : Read / Write / Construct
Number of messages to download in a batch.
Allowed values: >= -1
Default value: -1
"delete-after-days"
property "delete-after-days" gint : Read / Write / Construct
Delete messages left on server after N days.
Allowed values: [0,365]
Default value: 0
"delete-expunged"
property "delete-expunged" gboolean : Read / Write / Construct
Delete expunged from local Inbox.
Default value: FALSE
"disable-extensions"
property "disable-extensions" gboolean : Read / Write / Construct
Disable support for all POP3 extensions.
Default value: FALSE
"keep-on-server"
property "keep-on-server" gboolean : Read / Write / Construct
Leave messages on POP3 server.
Default value: FALSE