|
Fairport
v1.0.38
|
|
Fairport
v1.0.38
|
A folder in a PST file. More...
#include <folder.h>
Inheritance diagram for fairport::folder: Collaboration diagram for fairport::folder:Public Types | |
| typedef boost::transform_iterator < message_transform_row, const_table_row_iter > | message_iterator |
| Message iterator type; a transform iterator over a table row iterator. | |
| typedef boost::transform_iterator < folder_transform_row, folder_filter_iterator > | folder_iterator |
| Folder iterator type; a transform iterator over a filter iterator over table row iterator. | |
| typedef boost::transform_iterator < search_folder_transform_row, search_folder_filter_iterator > | search_folder_iterator |
| Search folder iterator type; a transform iterator over a filter iterator over table row iterator. | |
| typedef boost::transform_iterator < contact_transform_row, row_filter_iterator > | contact_iterator |
| Contact iterator type; a transform iterator over a filter iterator over a table row iterator. | |
| typedef boost::transform_iterator < task_transform_row, row_filter_iterator > | task_iterator |
| Task iterator type; a transform iterator over a filter iterator over a table row iterator. | |
Public Member Functions | |
| folder (const node &n) | |
| Construct a folder object. | |
| folder_iterator | sub_folder_begin () const |
| Get an iterator to the first folder in this folder. | |
| folder_iterator | sub_folder_end () const |
| Get the end folder iterator. | |
| search_folder_iterator | sub_search_folder_begin () const |
| Get an iterator to the first search folder in this folder. | |
| search_folder_iterator | sub_search_folder_end () const |
| Get the end search folder iterator. | |
| folder | open_sub_folder (const std::wstring &name) |
| Open a specific subfolder in this folder, not recursive. | |
| message_iterator | message_begin () const |
| message_iterator | message_end () const |
| contact_iterator | contact_begin () const |
| contact_iterator | contact_end () const |
| task_iterator | task_begin () const |
| task_iterator | task_end () const |
| message_iterator | associated_message_begin () const |
| Get an iterator to the first associated message in this folder. | |
| message_iterator | associated_message_end () const |
| Get the end associated message iterator. | |
| std::wstring | get_name () const |
| size_t | get_subfolder_count () const |
| Get the number of sub folders in this folder. | |
| size_t | get_unread_message_count () const |
| size_t | get_message_count () const |
| size_t | get_associated_message_count () const |
| Get the number of associated messages in this folder. | |
| table & | get_hierarchy_table () |
| Get the hierarchy table of this folder. | |
| table & | get_contents_table () |
| table & | get_associated_contents_table () |
| Get the associated contents table of this folder. | |
| const table & | get_hierarchy_table () const |
| const table & | get_contents_table () const |
| const table & | get_associated_contents_table () const |
A folder in a PST file.
The folder object allows access to subfolders, messages, and associated messages which are contained in the folder. Similar to the PST Layer object, the folder also offers a way to lookup subfolders by name.
A folder currently doesn't have a concept of sorting. This was deemed unnecessary because of the iterator based approach used for exposing sub messages and folders - one can use these iterators to build up a container of messages or folders to be sorted, and calling std::sort directly with an arbitrary sorting functor.
| typedef boost::transform_iterator<contact_transform_row, row_filter_iterator> fairport::folder::contact_iterator |
| typedef boost::transform_iterator<folder_transform_row, folder_filter_iterator> fairport::folder::folder_iterator |
| typedef boost::transform_iterator<message_transform_row, const_table_row_iter> fairport::folder::message_iterator |
| typedef boost::transform_iterator<search_folder_transform_row, search_folder_filter_iterator> fairport::folder::search_folder_iterator |
| typedef boost::transform_iterator<task_transform_row, row_filter_iterator> fairport::folder::task_iterator |
| fairport::folder::folder | ( | const node & | n | ) | [inline] |
| message_iterator fairport::folder::associated_message_begin | ( | ) | const [inline] |
| message_iterator fairport::folder::associated_message_end | ( | ) | const [inline] |
| contact_iterator fairport::folder::contact_begin | ( | ) | const [inline] |
| contact_iterator fairport::folder::contact_end | ( | ) | const [inline] |
| fairport::table & fairport::folder::get_associated_contents_table | ( | ) | [inline] |
| const fairport::table & fairport::folder::get_associated_contents_table | ( | ) | const [inline] |
| size_t fairport::folder::get_associated_message_count | ( | ) | const [inline] |
| fairport::table & fairport::folder::get_contents_table | ( | ) | [inline] |
| const fairport::table & fairport::folder::get_contents_table | ( | ) | const [inline] |
| fairport::table & fairport::folder::get_hierarchy_table | ( | ) | [inline] |
| const fairport::table & fairport::folder::get_hierarchy_table | ( | ) | const [inline] |
| size_t fairport::folder::get_message_count | ( | ) | const [inline] |
| std::wstring fairport::folder::get_name | ( | ) | const [inline] |
| size_t fairport::folder::get_subfolder_count | ( | ) | const [inline] |
| size_t fairport::folder::get_unread_message_count | ( | ) | const [inline] |
| message_iterator fairport::folder::message_begin | ( | ) | const [inline] |
| message_iterator fairport::folder::message_end | ( | ) | const [inline] |
| fairport::folder fairport::folder::open_sub_folder | ( | const std::wstring & | name | ) | [inline] |
Open a specific subfolder in this folder, not recursive.
| [in] | name | The name of the folder to open |
| key_not_found<std::wstring> | If a folder of the specified name was not found in this folder |
| folder_iterator fairport::folder::sub_folder_begin | ( | ) | const [inline] |
| folder_iterator fairport::folder::sub_folder_end | ( | ) | const [inline] |
| search_folder_iterator fairport::folder::sub_search_folder_begin | ( | ) | const [inline] |
| search_folder_iterator fairport::folder::sub_search_folder_end | ( | ) | const [inline] |
| task_iterator fairport::folder::task_begin | ( | ) | const [inline] |
| task_iterator fairport::folder::task_end | ( | ) | const [inline] |
1.7.5.1 
