struct ESourceCollection

struct ESourceCollection;

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

Since 3.6

E_SOURCE_EXTENSION_COLLECTION

#define E_SOURCE_EXTENSION_COLLECTION "Collection"

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

Since 3.6

e_source_collection_get_identity ()

const gchar *       e_source_collection_get_identity    (ESourceCollection *extension);

Returns the string used to uniquely identify the user account at the service provider. Often this is an email address or user name.

Since 3.6

e_source_collection_dup_identity ()

gchar *             e_source_collection_dup_identity    (ESourceCollection *extension);

Thread-safe variation of e_source_collection_get_identity(). 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_collection_set_identity ()

void                e_source_collection_set_identity    (ESourceCollection *extension,
                                                         const gchar *identity);

Sets the string used to uniquely identify the user account at the service provider. Often this is an email address or user name.

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

Since 3.6

e_source_collection_get_calendar_enabled ()

gboolean            e_source_collection_get_calendar_enabled
                                                        (ESourceCollection *extension);

Returns whether calendar sources within the collection should be enabled.

An ECollectionBackend running within the registry D-Bus service will automatically synchronize any calendar sources it maintains with the "calendar-enabled" property.

Since 3.6

e_source_collection_set_calendar_enabled ()

void                e_source_collection_set_calendar_enabled
                                                        (ESourceCollection *extension,
                                                         gboolean calendar_enabled);

Sets whether calendar sources within the collection should be enabled.

An ECollectionBackend running within the registry D-Bus service will automatically synchronize any calendar sources it maintains with the "calendar-enabled" property.

Calling this function from a registry service client has no effect until the change is submitted to the registry service through e_source_write(), but there should rarely be any need for clients to call this.

Since 3.6

e_source_collection_get_contacts_enabled ()

gboolean            e_source_collection_get_contacts_enabled
                                                        (ESourceCollection *extension);

Returns whether address book sources within the collection should be enabled.

An ECollectionBackend running within the registry D-Bus service will automatically synchronize any address book sources it maintains with the "contacts-enabled" property.

Since 3.6

e_source_collection_set_contacts_enabled ()

void                e_source_collection_set_contacts_enabled
                                                        (ESourceCollection *extension,
                                                         gboolean contacts_enabled);

Sets whether address book sources within the collection should be enabled.

An ECollectionBackend running within the registry D-Bus service will automatically synchronize any address book sources it maintains with the "contacts-enabled" property.

Calling this function from a registry service client has no effect until the change is submitted to the registry service through e_source_write(), but there should rarely be any need for clients to call this.

Since 3.6

e_source_collection_get_mail_enabled ()

gboolean            e_source_collection_get_mail_enabled
                                                        (ESourceCollection *extension);

Returns whether mail sources within the collection should be enabled.

An ECollectionBackend running within the registry D-Bus service will automatically synchronize any mail sources it maintains with the "mail-enabled" property.

Since 3.6

e_source_collection_set_mail_enabled ()

void                e_source_collection_set_mail_enabled
                                                        (ESourceCollection *extension,
                                                         gboolean mail_enabled);

Sets whether mail sources within the collection should be enabled.

An ECollectionBackend running within the registry D-Bus service will automatically synchronize any mail sources it maintains with the "mail-enabled" property.

Calling this function from a registry service client has no effect until the changes is submitted to the registry service through e_source_write(), but there should rarely be any need for clients to call this.

Since 3.6

The "calendar-enabled" property

  "calendar-enabled"         gboolean              : Read / Write / Construct

Whether calendar resources are enabled.

Default value: TRUE

The "contacts-enabled" property

  "contacts-enabled"         gboolean              : Read / Write / Construct

Whether contact resources are enabled.

Default value: TRUE

The "identity" property

  "identity"                 gchar*                : Read / Write / Construct

Uniquely identifies the account at the service provider.

Default value: NULL

The "mail-enabled" property

  "mail-enabled"             gboolean              : Read / Write / Construct

Whether mail resources are enabled.

Default value: TRUE