struct ESourceWebdav

struct ESourceWebdav;

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

Since 3.6

E_SOURCE_EXTENSION_WEBDAV_BACKEND

#define E_SOURCE_EXTENSION_WEBDAV_BACKEND "WebDAV Backend"

Pass this extension name to e_source_get_extension() to access ESourceWebdav. This is also used as a group name in key files.

Since 3.6

e_source_webdav_get_avoid_ifmatch ()

gboolean            e_source_webdav_get_avoid_ifmatch   (ESourceWebdav *extension);

This setting works around a bug in older Apache mod_dav versions.

Since 3.6

e_source_webdav_set_avoid_ifmatch ()

void                e_source_webdav_set_avoid_ifmatch   (ESourceWebdav *extension,
                                                         gboolean avoid_ifmatch);

This setting works around a bug in older Apache mod_dav versions.

Since 3.6

e_source_webdav_get_calendar_auto_schedule ()

gboolean            e_source_webdav_get_calendar_auto_schedule
                                                        (ESourceWebdav *extension);

FIXME Document me!

Since 3.6

e_source_webdav_set_calendar_auto_schedule ()

void                e_source_webdav_set_calendar_auto_schedule
                                                        (ESourceWebdav *extension,
                                                         gboolean calendar_auto_schedule);

FIXME Document me!

Since 3.6

e_source_webdav_get_display_name ()

const gchar *       e_source_webdav_get_display_name    (ESourceWebdav *extension);

Returns the last known display name of a WebDAV resource, which may differ from the "display-name" property of the ESource to which extension belongs.

Since 3.6

e_source_webdav_dup_display_name ()

gchar *             e_source_webdav_dup_display_name    (ESourceWebdav *extension);

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

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

Since 3.6

e_source_webdav_set_display_name ()

void                e_source_webdav_set_display_name    (ESourceWebdav *extension,
                                                         const gchar *display_name);

Updates the last known display name of a WebDAV resource, which may differ from the "display-name" property of the ESource to which extension belongs.

The internal copy of display_name is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

Since 3.6

e_source_webdav_get_email_address ()

const gchar *       e_source_webdav_get_email_address   (ESourceWebdav *extension);

Returns the user's email address which can be passed to a CalDAV server if the user wishes to receive scheduling messages.

Since 3.6

e_source_webdav_dup_email_address ()

gchar *             e_source_webdav_dup_email_address   (ESourceWebdav *extension);

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

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

Since 3.6

e_source_webdav_set_email_address ()

void                e_source_webdav_set_email_address   (ESourceWebdav *extension,
                                                         const gchar *email_address);

Sets the user's email address which can be passed to a CalDAV server if the user wishes to receive scheduling messages.

The internal copy of email_address is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

Since 3.6

e_source_webdav_get_resource_path ()

const gchar *       e_source_webdav_get_resource_path   (ESourceWebdav *extension);

Returns the absolute path to a resource on a WebDAV server.

Since 3.6

e_source_webdav_dup_resource_path ()

gchar *             e_source_webdav_dup_resource_path   (ESourceWebdav *extension);

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

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

Since 3.6

e_source_webdav_set_resource_path ()

void                e_source_webdav_set_resource_path   (ESourceWebdav *extension,
                                                         const gchar *resource_path);

Sets the absolute path to a resource on a WebDAV server.

The internal copy of resource_path is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

Since 3.6

e_source_webdav_get_resource_query ()

const gchar *       e_source_webdav_get_resource_query  (ESourceWebdav *extension);

Returns the URI query required to access a resource on a WebDAV server.

This is typically used when the "resource-path" points not to the resource itself but to a web program that generates the resource content on-the-fly. The "resource-query" holds the input values for the program.

Since 3.6

e_source_webdav_dup_resource_query ()

gchar *             e_source_webdav_dup_resource_query  (ESourceWebdav *extension);

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

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

Since 3.6

e_source_webdav_set_resource_query ()

void                e_source_webdav_set_resource_query  (ESourceWebdav *extension,
                                                         const gchar *resource_query);

Sets the URI query required to access a resource on a WebDAV server.

This is typically used when the "resource-path" points not to the resource itself but to a web program that generates the resource content on-the-fly. The "resource-query" holds the input values for the program.

The internal copy of resource_query is automatically stripped of leading and trailing whitespace. If the resulting string is empty, NULL is set instead.

Since 3.6

e_source_webdav_get_ssl_trust ()

const gchar *       e_source_webdav_get_ssl_trust       (ESourceWebdav *extension);

Returns an SSL certificate trust for the extension. The value encodes three parameters, divided by a pipe '|', the first is users preference, can be one of "reject", "accept", "temporary-reject" and "temporary-accept". The second is a host name for which the trust was set. Finally the last is a SHA1 hash of the certificate. This is not meant to be changed by a caller, it is supposed to be manipulated with e_source_webdav_prepare_ssl_trust_prompt() and e_source_webdav_store_ssl_trust_prompt().

Since 3.8

e_source_webdav_dup_ssl_trust ()

gchar *             e_source_webdav_dup_ssl_trust       (ESourceWebdav *extension);

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

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

Since 3.8

e_source_webdav_set_ssl_trust ()

void                e_source_webdav_set_ssl_trust       (ESourceWebdav *extension,
                                                         const gchar *ssl_trust);

Sets the SSL certificate trust. See e_source_webdav_get_ssl_trust() for more infomation about its content and how to use it.

Since 3.8

e_source_webdav_dup_soup_uri ()

SoupURI *           e_source_webdav_dup_soup_uri        (ESourceWebdav *extension);

This is a convenience function which returns a newly-allocated SoupURI, its contents assembled from the ESourceAuthentication extension, the ESourceSecurity extension, and extension itself. Free the returned SoupURI with soup_uri_free().

Since 3.6

e_source_webdav_set_soup_uri ()

void                e_source_webdav_set_soup_uri        (ESourceWebdav *extension,
                                                         SoupURI *soup_uri);

This is a convenience function which propagates the components of uri to the ESourceAuthentication extension, the ESourceSecurity extension, and extension itself. (The "fragment" component of uri is ignored.)

Since 3.6

enum ETrustPromptResponse

typedef enum {
	E_TRUST_PROMPT_RESPONSE_UNKNOWN			= -1,
	E_TRUST_PROMPT_RESPONSE_REJECT			=  0,
	E_TRUST_PROMPT_RESPONSE_ACCEPT			=  1,
	E_TRUST_PROMPT_RESPONSE_ACCEPT_TEMPORARILY =  2,
	E_TRUST_PROMPT_RESPONSE_REJECT_TEMPORARILY =  3
} ETrustPromptResponse;

XXX Document me!

Since 3.8

e_source_webdav_prepare_ssl_trust_prompt ()

ETrustPromptResponse e_source_webdav_prepare_ssl_trust_prompt
                                                        (ESourceWebdav *extension,
                                                         SoupMessage *message,
                                                         struct _ESourceRegistry *registry,
                                                         struct _ENamedParameters *parameters);

Checks messages's certificate against currently stored trust response and either returns what to do immediately, or returns E_TRUST_PROMPT_RESPONSE_UNKNOWN and populates parameters with necessary values for a trust prompt.

Since 3.8

e_source_webdav_prepare_ssl_trust_prompt_with_parent ()

ETrustPromptResponse e_source_webdav_prepare_ssl_trust_prompt_with_parent
                                                        (ESourceWebdav *extension,
                                                         SoupMessage *message,
                                                         ESource *parent_source,
                                                         struct _ENamedParameters *parameters);

The same as e_source_webdav_prepare_ssl_trust_prompt(), only takes parent_source directly, instead of an ESourceRegistry.

See e_source_webdav_prepare_ssl_trust_prompt() for more details.

Since 3.8

e_source_webdav_store_ssl_trust_prompt ()

void                e_source_webdav_store_ssl_trust_prompt
                                                        (ESourceWebdav *extension,
                                                         SoupMessage *message,
                                                         ETrustPromptResponse response);

Stores user's response from a trust prompt, thus it is re-used the next time it'll be needed. An E_TRUST_PROMPT_RESPONSE_UNKNOWN is treated as a temporary reject, which means the user will be asked again.

Since 3.8

e_source_webdav_unset_temporary_ssl_trust ()

void                e_source_webdav_unset_temporary_ssl_trust
                                                        (ESourceWebdav *extension);

Unsets temporary trust set on this extension, but keeps it as is for other values.

Since 3.8

e_source_webdav_get_ignore_invalid_cert ()

gboolean            e_source_webdav_get_ignore_invalid_cert
                                                        (ESourceWebdav *extension);

Returns TRUE if invalid SSL certificates should be ignored.

This option allows SSL certificates to be accepted even if they have signed by an unrecognized Certificate Authority.

Since 3.6

e_source_webdav_set_ignore_invalid_cert ()

void                e_source_webdav_set_ignore_invalid_cert
                                                        (ESourceWebdav *extension,
                                                         gboolean ignore_invalid_cert);

Sets whether invalid SSL certificates should be ignored.

This option allows SSL certificates to be accepted even if they have signed by an unrecognized Certificate Authority.

Since 3.6

The "avoid-ifmatch" property

  "avoid-ifmatch"            gboolean              : Read / Write / Construct

Work around a bug in old Apache servers.

Default value: FALSE

The "calendar-auto-schedule" property

  "calendar-auto-schedule"   gboolean              : Read / Write / Construct

Whether the server handles meeting invitations (CalDAV-only).

Default value: FALSE

The "display-name" property

  "display-name"             gchar*                : Read / Write / Construct

Display name of the WebDAV resource.

Default value: ""

The "email-address" property

  "email-address"            gchar*                : Read / Write / Construct

The user's email address.

Default value: ""

The "ignore-invalid-cert" property

  "ignore-invalid-cert"      gboolean              : Read / Write / Construct

Ignore invalid SSL certificates.

Default value: FALSE

The "resource-path" property

  "resource-path"            gchar*                : Read / Write / Construct

Absolute path to a WebDAV resource.

Default value: NULL

The "resource-query" property

  "resource-query"           gchar*                : Read / Write / Construct

Query to access a WebDAV resource.

Default value: NULL

The "soup-uri" property

  "soup-uri"                 SoupURI*              : Read / Write

WebDAV service as a SoupURI.

The "ssl-trust" property

  "ssl-trust"                gchar*                : Read / Write / Construct

SSL certificate trust setting, for invalid server certificates.

Default value: NULL