EDataServer.SourceCamel

Subclasses:

None

Methods

Inherited:

EDataServer.SourceExtension (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	generate_subtype (protocol, settings_type)
class	get_extension_name (protocol)
class	get_type_name (protocol)
class	register_types ()
	get_settings ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
settings	Camel.Settings	r	The Camel.Settings instance being proxied

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	EDataServer.SourceExtension	r

Class Details

class EDataServer.SourceCamel(**kwargs)

Bases:

EDataServer.SourceExtension

Abstract:

Yes

Structure:

EDataServer.SourceCamelClass

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

New in version 3.6.

classmethod generate_subtype(protocol, settings_type)

Parameters:

• protocol (str) – a Camel.Provider protocol

• settings_type (GObject.GType) – a subtype of Camel.Settings

Returns:

the GObject.GType of the generated EDataServer.SourceCamel subtype

Return type:

GObject.GType

Generates a custom EDataServer.SourceCamel subtype for protocol. Instances of the new subtype will contain a Camel.Settings instance of type settings_type.

This function is called as Camel.part of EDataServer.SourceCamel.register_types() and should not be called explicitly, except by some groupware packages that need to share package-specific settings across their mail, calendar and address book components. In that case the groupware package may choose to subclass Camel.Settings rather than EDataServer.SourceExtension since libcamel is the lowest common denominator across all components. This function provides a way for the calendar and address book components of such a package to generate an EDataServer.SourceCamel subtype for its Camel.Settings subtype without having to load all available Camel.Provider modules.

New in version 3.6.

classmethod get_extension_name(protocol)

Parameters:

protocol (str) – a Camel.Provider protocol

Returns:

the EDataServer.SourceCamel extension name for protocol

Return type:

str

Returns the extension name for the EDataServer.SourceCamel subtype for protocol. The extension name can then be passed to EDataServer.Source.get_extension() to obtain an instance of the EDataServer.SourceCamel subtype.

For example, given a protocol named “imap” the function would return “Imap Backend”.

New in version 3.6.

classmethod get_type_name(protocol)

Parameters:

protocol (str) – a Camel.Provider protocol

Returns:

the EDataServer.SourceCamel type name for protocol

Return type:

str

Returns the GObject.GType name of the registered EDataServer.SourceCamel subtype for protocol.

For example, given a protocol named “imap” the function would return “ESourceCamelImap”.

New in version 3.6.

classmethod register_types()

Creates and registers subclasses of EDataServer.SourceCamel for each available Camel.Provider. This function should be called once during application or library initialization.

New in version 3.6.

get_settings()

Returns:

a configured Camel.Settings instance

Return type:

Camel.Settings

Returns self's EDataServer.SourceCamel :settings instance, pre-configured from the EDataServer.Source to which self belongs. Changes to the EDataServer.Source will automatically propagate to the EDataServer.SourceCamel :settings instance and vice versa.

This is essentially the glue that binds EDataServer.Source to Camel.Service. See EDataServer.Source.camel_configure_service().

New in version 3.6.

Property Details

EDataServer.SourceCamel.props.settings

Name:

settings

Type:

Camel.Settings

Default Value:

None

Flags:

READABLE

The Camel.Settings instance being proxied