Camel.FolderThread¶
Fields¶
Name |
Type |
Access |
Description |
---|---|---|---|
folder |
r/w |
||
node_chunks |
r/w |
||
refcount |
r/w |
||
subject |
r/w |
||
summary |
[ |
r/w |
|
tree |
r/w |
Methods¶
class |
|
|
|
|
|
|
Details¶
- class Camel.FolderThread¶
- classmethod new(folder, uids, thread_subject)¶
- Parameters:
folder (
Camel.Folder
) – aCamel.Folder
uids ([
str
]) – The subset of uid’s to thread. IfNone
, then thread all UID-s in the folderthread_subject (
bool
) – thread based on subject also
- Returns:
A
Camel.FolderThread
contianing a tree ofCamel.FolderThreadNode
's which represent the threaded structure of the messages.- Return type:
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
]) – aGLib.PtrArray
array of UID-s
Adds new uids into the threaded tree.
- ref()¶
- Returns:
the referenced self
- Return type:
Increase the reference of self
- unref()¶
Free all memory associated with the thread descriptor self.