FolderCollection Class Reference

A collection of Folders in the Account. More...

Inheritance diagram for FolderCollection:

Public Member Functions
Folder	AddNew (String name)
	Adds a new folder to the FolderCollection.
void	CopyTo (Folder[] array, Int32 index)
	Copy the folders in this collection to an array.
void	Remove (Folder folder)
	Remove a folder from the Yahoo! Mail account and the collection

Protected Member Functions
override void	OnClear ()
	Called by the CollectionBase.Clear method.
override void	OnRemove (Int32 index, Object value)
	Called when a folder is removed from the collection

Properties
Folder	this[Int32 index] [get]
	Gets the folder at the specified index.

Detailed Description

A collection of Folders in the Account.

Member Function Documentation

Folder AddNew

(

String

name

)

Adds a new folder to the FolderCollection.

Parameters

name	The name of the new folder

Returns

The new Folder created

void CopyTo	(	Folder[]	array,
		Int32	index
	)

Copy the folders in this collection to an array.

Parameters

array	The target array
index	The index in array where copying will start

override void OnClear ( )

protected

Called by the CollectionBase.Clear method.

Exceptions

NotSupportedException

Always thrown.

You cannot remove all folders from the collection, as some folders are system folders and cannot be removed. Use the Remove method to remove individual folders.

override void OnRemove ( Int32  index, Object  value  )

protected

Called when a folder is removed from the collection

Parameters

index	The index at which value can be found
value	The Folder to remove from index .

Exceptions

InvalidOperationException

The Folder.IsSystem property of value is true.

void Remove

(

Folder

folder

)

Remove a folder from the Yahoo! Mail account and the collection

Parameters

folder

The folder to remove

Exceptions

InvalidOperationException

The Folder.IsSystem property of folder is true.

Property Documentation

Folder this[Int32 index]

get

Gets the folder at the specified index.

Parameters

index

The zero-based index of the folder to get.

Returns

The folder at the specified index

---

The documentation for this class was generated from the following file:

• FolderCollection.cs