Edit

Share via


Folder Class

Definition

Represents a generic folder.

public ref class Folder : Microsoft::Exchange::WebServices::Data::ServiceObject
public class Folder : Microsoft.Exchange.WebServices.Data.ServiceObject
Public Class Folder
Inherits ServiceObject
Inheritance
Derived

Constructors

Folder(ExchangeService)

Initializes an unsaved local instance of the Folder class.

Properties

ArchiveTag

Gets or sets the archive tag. The ArchiveTag property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

ChildFolderCount

Gets the number of child folders in this this folder.

DisplayName

Gets or sets the display name of the folder.

EffectiveRights

Gets a value that indicates the effective rights that the current authenticated user has on the folder.

ExtendedProperties

Gets a list of extended properties that are associated with the folder.

FolderClass

Gets or sets the custom class name of this folder.

Id

Gets the identifier of the folder.

IsDirty

Gets a value that indicates whether the object has been modified.

(Inherited from ServiceObject)
IsNew

Indicates whether this object exists in the Exchange database or if it is a local object that has not been saved to the Exchange database.

(Inherited from ServiceObject)
Item[PropertyDefinitionBase]

Gets the value of the specified property in this instance.

(Inherited from ServiceObject)
ManagedFolderInformation

Gets the Messaging Records Management (MRM) information that is associated with the folder.

ParentFolderId

Gets the identifier of this folder's parent folder.

Permissions

Gets or sets a list of permissions for the folder.

PolicyTag

Gets or sets the policy tag. The PolicyTag property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

Schema

Gets the schema that is associated with this type of object.

(Inherited from ServiceObject)
Service

Gets the Exchange service for this object.

(Inherited from ServiceObject)
TotalCount

Gets the total number of items that are contained in the folder.

UnreadCount

Gets the number of unread items in the folder.

WellKnownFolderName

Gets one of the common folder names listed in the WellKnownFolderName enumeration. The WellKnownFolderName property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

Methods

Bind(ExchangeService, FolderId)

Binds to an existing folder, whatever its actual type is, and loads its first class properties.

Bind(ExchangeService, FolderId, PropertySet)

Binds to an existing folder, whatever its actual type is, and loads the specified set of properties.

Bind(ExchangeService, WellKnownFolderName)

Binds to an existing folder, whatever its actual type is, and loads its first class properties.

Bind(ExchangeService, WellKnownFolderName, PropertySet)

Binds to an existing folder, whatever its actual type is, and loads the specified set of properties.

Copy(FolderId)

Copies this folder into a specific folder.

Copy(WellKnownFolderName)

Copies this folder into the specified folder.

Delete(DeleteMode)

Deletes the folder.

Empty(DeleteMode, Boolean)

Empties the folder. Optionally, enables you to empty subfolders.

FindFolders(FolderView)

Obtains a list of folders by searching the subfolders of this folder.

FindFolders(SearchFilter, FolderView)

Returns a list of folders by searching the subfolders in the specified view that satisfy the specified search filter criteria.

FindItems(ItemView)

Obtains a list of items by searching the contents of this folder.

FindItems(ItemView, Grouping)

Obtains a list of items by searching the contents of this folder in the specified view and grouped by the specified property.

FindItems(SearchFilter, ItemView)

Obtains a list of items by searching the contents of this folder.

FindItems(SearchFilter, ItemView, Grouping)

Returns a list of items by searching the contents of this folder, using the specified search filter.

FindItems(String, ItemView)

Returns a list of items by searching the contents of this folder with the specified query string.

FindItems(String, ItemView, Grouping)

Returns a list of items by searching the contents of this folder.

GetLoadedPropertyDefinitions()

Provides the collection of loaded property definitions.

(Inherited from ServiceObject)
Load()

Loads the first-class properties.

(Inherited from ServiceObject)
Load(PropertySet)

Loads the specified set of properties.

(Inherited from ServiceObject)
MarkAllItemsAsRead(Boolean)

Marks all items in folder as read. The MarkAllItemsAsRead(Boolean) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

MarkAllItemsAsUnread(Boolean)

Marks all items in folder as unread. The MarkAllItemsAsUnread(Boolean) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

Move(FolderId)

Moves this folder to a specific folder.

Move(WellKnownFolderName)

Moves this folder to the specified folder.

RemoveExtendedProperty(ExtendedPropertyDefinition)

Removes an extended property from the folder.

Save(FolderId)

Saves this folder in a specific folder.

Save(WellKnownFolderName)

Saves this folder in a specific folder.

SetExtendedProperty(ExtendedPropertyDefinition, Object)

Sets the specified extended property.

TryGetProperty(PropertyDefinitionBase, Object)

Tries to get the value of a specified property.

(Inherited from ServiceObject)
TryGetProperty<T>(PropertyDefinitionBase, T)

Tries to get the value of a specified property.

(Inherited from ServiceObject)
Update()

Applies the local changes that have been made to this folder.

Applies to