Class: Viewpoint::EWS::Folder

Inherits:
GenericFolder show all
Defined in:
lib/model/folder.rb

Overview

This class represents a FolderType object in the Exchange Data store. This is the type of folder that mail messages will be found in.

Instance Attribute Summary

Attributes inherited from GenericFolder

#change_key, #folder_id, #parent_id, #subscription_id, #sync_state, #watermark

Attributes included from Model

#ews_methods, #ews_methods_undef

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from GenericFolder

#add_subfolder, #clear_sync_state!, #delete!, #find_items, folder_names, #get_events, get_folder, get_folder_by_name, get_folder_by_path, #get_item, #get_items, #items_between, #items_since, #search_by_subject, #subscribe, #subscribed?, #sync_items!, #sync_items_since!, #todays_items, #unsubscribe

Constructor Details

#initialize(folder) ⇒ Folder

Initialize with an item of FolderType. This is typically the folder used to house mail messages.



40
41
42
43
 
# File 'lib/model/folder.rb', line 40

def initialize(folder)
  super(folder)
  define_int_var :unread_count
end

Class Method Details

.find_folders(root = :msgfolderroot, traversal = 'Deep', shape = 'Default', folder_type = 'IPF.Note') ⇒ Array

Find folders of type Folder (message folders)

Parameters:

  • root (String, Symbol) (defaults to: :msgfolderroot) —

    An folder id, either a DistinguishedFolderId (must me a Symbol) or a FolderId (String)

  • traversal (String) (defaults to: 'Deep') —

    Shallow/Deep/SoftDeleted

  • shape (String) (defaults to: 'Default') —

    the shape to return IdOnly/Default/AllProperties

  • folder_type (optional, String) (defaults to: 'IPF.Note') —

    an optional folder type to limit the search to like ‘IPF.Task’

Returns:

  • (Array) —

    Returns an Array of Folder or subclasses of Folder

See Also:



33
34
35
 
# File 'lib/model/folder.rb', line 33

def self.find_folders(root = :msgfolderroot, traversal = 'Deep', shape = 'Default', folder_type = 'IPF.Note')
  super(root, traversal, shape, folder_type)
end