Camel.FolderThread

Fields

Name	Type	Access	Description
folder	Camel.Folder	r/w
node_chunks	Camel.MemChunk	r/w
refcount	int	r/w
subject	int	r/w
summary	[object]	r/w
tree	object	r/w

Methods

class	new (folder, uids, thread_subject)
	apply (uids)
	ref ()
	unref ()

Details

class Camel.FolderThread

classmethod new(folder, uids, thread_subject)

Parameters:

• folder (Camel.Folder) – a Camel.Folder

• uids ([str]) – The subset of uid’s to thread. If None, then thread all UID-s in the folder

• thread_subject (bool) – thread based on subject also

Returns:

A Camel.FolderThread contianing a tree of Camel.FolderThreadNode's which represent the threaded structure of the messages.

Return type:

Camel.FolderThread

Thread a (subset) of the messages in a folder. And sort the result in summary order.

If thread_subject is True, messages with related subjects will also be threaded. The default behaviour is to only thread based on message-id.

This function is probably to be removed soon.

apply(uids)

Parameters:

uids ([str]) – a GLib.PtrArray array of UID-s

Adds new uids into the threaded tree.

ref()

Returns:

the referenced self

Return type:

Camel.FolderThread

Increase the reference of self

unref()

Free all memory associated with the thread descriptor self.