FaxFolders Collection Object

The FaxFolders collection object can contain zero or more FaxFolder objects.

Properties

Methods

Remarks

Because a user may have created many custom folders, use the Item property to reference a particular FaxFolder object.

Back to Top

Add Method

The Add method creates and returns a new FaxFolder object in the FaxFolders collection. The Add method also creates server based resources associated with the folder.

Syntax

ObjFolders.Add(Name)

where Name is the display name of the folder.

Back to Top

Count Property

The Count property returns the number of FaxFolder objects contained in the collection. Read-only.

Syntax

ObjFolders.Count

Data Type

Long

Back to Top

Item Property

The Item property returns a single FaxFolder object from the collection. Read-only.

Syntax

ObjFolders.Item(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of Count property).

Data Type

FaxFolder object

Remarks

The Item property is the default property of the FaxFolders object.

Back to Top

Remove Method

The Remove method deletes the FaxFolder object with the specified index from the collection. Server based resources associated with the folder are also deleted.

Syntax

ObjFolders.Remove(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of Count property).

Remarks

Remove will fail with an invalid argument error if this folder is a system defined folder (e.g. Inbox, Outbox, Deleted Items, Sent Items, Unrouted or Pending Approval).

Back to Top

RemoveAll Method

The RemoveAll method deletes all FaxFolder objects from the collection. Server-based resources associated with the folders are also deleted.

Syntax

ObjFolders.RemoveAll

Remarks

The RemoveAll method will not delete system defined folders (e.g. Inbox, Outbox, etc.). This operation is permanent - it cannot be undone.

Back to Top