Camel.FolderChangeInfo¶

Fields¶

Name	Type	Access
uid_added	[`object`]	r/w
uid_changed	[`object`]	r/w
uid_recent	[`object`]	r/w
uid_removed	[`object`]	r/w

Methods¶

class	`new` ()
	`add_source` (uid)
	`add_source_list` (list)
	`add_uid` (uid)
	`add_update` (uid)
	`add_update_list` (list)
	`build_diff` ()
	`cat` (src)
	`change_uid` (uid)
	`changed` ()
	`clear` ()
	`copy` ()
	`free` ()
	`get_added_uids` ()
	`get_changed_uids` ()
	`get_recent_uids` ()
	`get_removed_uids` ()
	`recent_uid` (uid)
	`remove_uid` (uid)

Details¶

class Camel.FolderChangeInfo¶

classmethod new()¶

Returns:: a new Camel.FolderChangeInfo
Return type:: Camel.FolderChangeInfo

Create a new folder change info structure.

Change info structures are not MT-SAFE and must be locked for exclusive access externally.

add_source(uid)¶

Parameters:: uid (str) – a uid

Add a source uid for generating a changeset.

add_source_list(list)¶

Parameters:: list ([str]) – a list of uids

Add a list of source uid’s for generating a changeset.

add_uid(uid)¶

Parameters:: uid (str) – a uid

Add a new uid to the changeinfo.

add_update(uid)¶

Parameters:: uid (str) – a uid

Add a uid from the updated list, used to generate a changeset diff.

add_update_list(list)¶

Parameters:: list ([str]) – a list of uids

Add a list of uid’s from the updated list.

build_diff()¶: Compare the source uid set to the updated uid set and generate the differences into the added and removed lists.

cat(src)¶

Parameters:: src (Camel.FolderChangeInfo) – a Camel.FolderChangeInfo to append from

Concatenate one change info onto antoher. Can be used to copy them too.

change_uid(uid)¶

Parameters:: uid (str) – a uid

Add a uid to the changed uid list.

changed()¶

Returns:: True if the changeset contains any changes or False otherwise
Return type:: bool

Gets whether or not there have been any changes.

clear()¶: Empty out the change info; called after changes have been processed.

copy()¶

Returns:: Copy of the self.
Return type:: Camel.FolderChangeInfo

Creates a copy of the self.

New in version 3.24.

free()¶: Free memory associated with the folder change info lists.

get_added_uids()¶

Returns:: An array of added UIDs.
Return type:: [str]

Returns an array of added messages UIDs. The returned array, the same as its content, is owned by the self.

New in version 3.24.

get_changed_uids()¶

Returns:: An array of changed UIDs.
Return type:: [str]

Returns an array of changed messages UIDs. The returned array, the same as its content, is owned by the self.

New in version 3.24.

get_recent_uids()¶

Returns:: An array of recent UIDs.
Return type:: [str]

Returns an array of recent messages UIDs. The returned array, the same as its content, is owned by the self.

New in version 3.24.

get_removed_uids()¶

Returns:: An array of removed UIDs.
Return type:: [str]

Returns an array of removed messages UIDs. The returned array, the same as its content, is owned by the self.

New in version 3.24.

recent_uid(uid)¶

Parameters:: uid (str) – a uid

Add a recent uid to the changedinfo. This will also add the uid to the uid_filter array for potential filtering

remove_uid(uid)¶

Parameters:: uid (str) – a uid

Add a uid to the removed uid list.