Callbacks

	CipherCloneFunc (value)
	CopyFunc (object)
	DBCollate (enc, length1, data1, length2, data2)
	DBSelectCB (user_data, colvalues, colnames)
	DataCacheRemoveFunc (cdc, filename, *user_data)
	FilterPlaySoundFunc (driver, filename, *user_data)
	FilterShellFunc (driver, argc, argv, *user_data)
	FilterStatusFunc (driver, status, pc, desc, *user_data)
	FilterSystemBeepFunc (driver, *user_data)
	ForeachInfoData (mi_data, subfolder, *user_data)
	ForeachPartFunc (message, part, parent_part, *user_data)
	GeneratePreviewFunc (part, *user_data)
	IndexNorm (index, word, *user_data)
	MessageContentInfoTraverseCallback (ci, depth, *user_data)
	ProviderAutoDetectFunc (url)
	SessionCallback (session, cancellable, *user_data)
	TextIndexFunc (idx, word, buffer)
	UrlScanFunc (in_, pos, inend, match)

Details

Camel.CipherCloneFunc(value)

Parameters:

value (object or None) –

Return type:

object or None

Camel.CopyFunc(object)

Parameters:

object (object or None) –

Return type:

object or None

Camel.DBCollate(enc, length1, data1, length2, data2)

Parameters:

• enc (object or None) – a used encoding (SQLITE_UTF8)

• length1 (int) – length of the data1

• data1 (object or None) – the first value, of lenth length1

• length2 (int) – length of the data2

• data2 (object or None) – the second value, of lenth length2

Returns:

less than zero, zero, or greater than zero value, the same as for example strcmp() does.

Return type:

int

A collation callback function.

New in version 2.24.

Camel.DBSelectCB(user_data, colvalues, colnames)

Parameters:

• user_data (object or None) – a callback user data

• colvalues ([str]) – array of column values, as UTF-8 strings

• colnames ([str]) – array of column names

Returns:

0 to continue the SELECT execution, non-zero to abort the execution.

Return type:

int

A callback called for the SELECT statements. The items at the same index of colvalues and colnames correspond to each other.

New in version 2.24.

Camel.DataCacheRemoveFunc(cdc, filename, *user_data)

Parameters:

• cdc (Camel.DataCache) – a Camel.DataCache

• filename (str) – a file name found in the cache

• user_data (object or None) – user data passed to Camel.DataCache.foreach_remove()

Returns:

True, to delete the file, False to keep in in the cache

Return type:

bool

A callback called for each found file in the cache, used by Camel.DataCache.foreach_remove(). The filename corresponds to the result of Camel.DataCache.get_filename().

New in version 3.26.

Camel.FilterPlaySoundFunc(driver, filename, *user_data)

Parameters:

• driver (Camel.FilterDriver) –

• filename (str) –

• user_data (object or None) –

Camel.FilterShellFunc(driver, argc, argv, *user_data)

Parameters:

• driver (Camel.FilterDriver) –

• argc (int) –

• argv (str) –

• user_data (object or None) –

Camel.FilterStatusFunc(driver, status, pc, desc, *user_data)

Parameters:

• driver (Camel.FilterDriver) –

• status (object or None) –

• pc (int) –

• desc (str) –

• user_data (object or None) –

Camel.FilterSystemBeepFunc(driver, *user_data)

Parameters:

• driver (Camel.FilterDriver) –

• user_data (object or None) –

Camel.ForeachInfoData(mi_data, subfolder, *user_data)

Parameters:

• mi_data (Camel.VeeMessageInfoData) – a Camel.VeeMessageInfoData

• subfolder (Camel.Folder) – a Camel.Folder which mi_data references

• user_data (object or None) – custom user data

A callback prototype for Camel.VeeDataCache.foreach_message_info_data()

Camel.ForeachPartFunc(message, part, parent_part, *user_data)

Parameters:

• message (Camel.MimeMessage) – a Camel.MimeMessage

• part (Camel.MimePart) – a Camel.MimePart, for which the function is called

• parent_part (Camel.MimePart or None) – a Camel.MimePart, parent of the part; can be None

• user_data (object or None) – user data, as passed to Camel.MimeMessage.foreach_part()

Returns:

True, when the traverse should continue, False to stop traversing parts of the message

Return type:

bool

Callback used to traverse parts of the message using Camel.MimeMessage.foreach_part().

New in version 3.34.

Camel.GeneratePreviewFunc(part, *user_data)

Parameters:

• part (object or None) – either a Camel.MimePart or a Camel.Multipart

• user_data (object or None) – user data for the function

Returns:

valid UTF-8 encoded preview text for the part, or None, when cannot handle the part

Return type:

str or None

A custom function to generate preview text for the content of the part. The part can be either a Camel.MimePart or a Camel.Multipart, depending in which context it is called.

The preview is supposed to be up to Camel.MAX_PREVIEW_LENGTH characters long, in a plain text format.

New in version 3.52.

Camel.IndexNorm(index, word, *user_data)

Parameters:

• index (Camel.Index) –

• word (str) –

• user_data (object or None) –

Return type:

str

Camel.MessageContentInfoTraverseCallback(ci, depth, *user_data)

Parameters:

• ci (Camel.MessageContentInfo) – a Camel.MessageContentInfo

• depth (int) – the current depth

• user_data (object or None) – data passed to Camel.MessageContentInfo.traverse()

Returns:

True to continue processing or False to stop it.

Return type:

bool

This is the callback signature for Camel.MessageContentInfo.traverse().

New in version 3.36.

Camel.ProviderAutoDetectFunc(url)

Parameters:

url (Camel.URL) – a Camel.URL

Returns:

0 on success or -1 on fail.

auto_detected:

output GLib.HashTable of auto-detected values

Return type:

(int, auto_detected: {str: str})

Function used in Camel.Provider.auto_detect().

Camel.SessionCallback(session, cancellable, *user_data)

Parameters:

• session (Camel.Session) – a Camel.Session

• cancellable (Gio.Cancellable or None) – a Camel.Operation cast as a Gio.Cancellable

• user_data (object or None) – data passed to Camel.Session.submit_job()

This is the callback signature for jobs submitted to the Camel.Session via Camel.Session.submit_job(). The error pointer is always non-None, so it’s safe to dereference to check if a GLib.Error has been set.

New in version 3.2.

Camel.TextIndexFunc(idx, word, buffer)

Parameters:

• idx (Camel.TextIndex) –

• word (str) –

• buffer (str) –

Camel.UrlScanFunc(in_, pos, inend, match)

Parameters:

• in (str) –

• pos (str) –

• inend (str) –

• match (Camel.UrlMatch) –

Return type:

bool