EmailFolder Class

Ipswitch.Messaging.Framework

Encapsulates an email folder

Inheritance Hierarchy

SystemObject
Ipswitch.Messaging.FrameworkFolderEmail
Ipswitch.Messaging.Framework.MailEmailFolder

Namespace: Ipswitch.Messaging.Framework.Mail
Assembly: Ipswitch.Messaging.Framework (in Ipswitch.Messaging.Framework.dll) Version: 1.0.0.0

Syntax

C++

Copy

public class EmailFolder : Folder<Email>, 
	IDisposable

public ref class EmailFolder : public Folder<Email^>, 
	IDisposable

The EmailFolder type exposes the following members.

Constructors

	Name	Description
	EmailFolder(User)	Constructor
	EmailFolder(User, String)	Constructor

Top

Methods

	Name	Description
	Add	Add a message. (Overrides FolderTAdd(T).)
	AddByUid	Add a message. (Overrides FolderTAddByUid(T).)
	Clear	Deletes all the messages in a folder (Overrides FolderTClear.)
	Close	Close the folder
	Delete	Remove the folder from the owning user's folder collection. (Inherited from FolderT.)
	Dispose	Dispose of the object
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Get(Guid)	Gets a message by GUID. (Overrides FolderTGet(Guid).)
	Get(UInt32)	Gets a message by uidl
	GetEasLiteItems	Gets the items that fall between the Start and End and items already sent to the device.
	GetFilteredItems	Gets the items that fall between the Start and End in the Specified sorting order.
	GetFilteredLiteItems	Gets the items that fall between the Start and End in the Specified sorting order.
	getFolderOwnerLevel	(Inherited from FolderT.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetItem	(Overrides FolderTGetItem(Guid).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MoveTo(Guid)	Move the folder to a new parent. (Inherited from FolderT.)
	MoveTo(String)	Move the folder to a new parent. (Inherited from FolderT.)
	Save	Saves any changes made to this folder by adding or updating it in the owning user's folder collection. (Inherited from FolderT.)
	Search	Searches a mailbox for messages placing the search results in the file specified by the searchFile parameter
	ToString	Returns a string representing the folder. (Inherited from FolderT.)

Top

Properties

	Name	Description
	AutoResponder	Gets or sets the autoresponder settings asscoaited with this folder.
	CanAddItems	Gets a value that indicates whether new items can be added to this folder. (Inherited from FolderT.)
	CanDeleteItems	Gets a value that indicates whether items from this folder can be deleted. (Inherited from FolderT.)
	CanEditItems	Gets a value that indicates whether items from this folder can be modified. (Inherited from FolderT.)
	CanReadItems	Gets a value that indicates whether items in this folder can be read. (Inherited from FolderT.)
	Count	The number of messages in the folder (Overrides FolderTCount.)
	Created	The date and time the folder was created (Overrides FolderTCreated.)
	DisplayName	Gets or sets a string used to identify this folder for display purposes. (Inherited from FolderT.)
	Exists	Gets a value that indicates whether this folder was retrieved from some user's folders. This value will be true if the folder was retrieved from a user's folder collection; otherwise, false. (Inherited from FolderT.)
	FolderPath	The file system path to the folder
	FolderType
	FriendlyPath
	Id	Gets or sets a Guid that can be used to uniquly identify this folder. (Inherited from FolderT.)
	IsDefaultFolder	Gets a value that indicates whether this folder is the default folder for it's type Inbox, Contacts, Calendar, etc... (Inherited from FolderT.)
	IsPublic	Gets a value that indicates whether this folder is a public folder. Public folders do not have an owning user. (Inherited from FolderT.)
	Items	The items in the folder (Overrides FolderTItems.)
	ItemType	Gets the type of items that this folder contains. (Inherited from FolderT.)
	LastItemChange	Gets the date and time of the last instance where some item in this folder was changed or added. (Overrides FolderTLastItemChange.)
	LiteItems	This enumerator allows for very quick enumeration of the messages in this folder by only populating the Id, Flags, and ReceivedDate fields of the Email object returned. If you need more fields than that do not use this enumerator or use Folder.Get(Email.Id) when you run across an email you need. (Overrides FolderTLiteItems.)
	Modified	Gets the date and time that the folder was last modified. (Overrides FolderTModified.)
	OriginalDisplayName	Gets the original value of DisplayName when this folder was created or last saved. (Inherited from FolderT.)
	OriginalId	Gets the original value of Id set when this folder was created or last saved. (Inherited from FolderT.)
	OriginalParentId	Gets the original value of ParentId set when this folder was created or last saved. (Inherited from FolderT.)
	Owner	Gets information about the user that owns this folder. (Inherited from FolderT.)
	OwnerLevel	(Inherited from FolderT.)
	ParentId	Gets the identifier used to uniquly identify the parent of this folder. (Inherited from FolderT.)
	ReadOnly	Gets a value that indicates whether this folder can be renamed, moved, or otherwise modified. Note that this does not apply to the items in the folder, only the folder itself. This value will be true if the folder can be modified; otherwise, false. (Inherited from FolderT.)
	Size	The size of the folder
	Subfolders	Gets an enumerable collection of subfolders each of which have this folder as its parent folder. (Inherited from FolderT.)
	Unread	The number of unread messages in the folder

Top

Reference

Ipswitch.Messaging.Framework.Mail Namespace