FaxFolder Object

The FaxFolder object represents a folder, or message container, within the AFM object model. The folder can contain subfolders and messages.

Properties

Methods

Remarks

The FaxFolder object provides access to the default and custom fax folders defined for the currently logged on user. The object can be obtained through the FaxSession object's RootFolder property.

The FaxFolder object references one or more FaxFolders objects and FaxMessages objects.

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

Back to Top

Created Property

The Created property returns the date and time the folder was created. Read-only.

Syntax

ObjFolder.Created

Data Type

Date

Back to Top

Delete Method

The Delete method removes the FaxFolder object from its parent FaxFolders collection, and deletes any fax server based resources associated with the FaxFolder object.

Syntax

ObjFolder.Delete( )

Remarks

The Delete method will permanently delete the folder object - the operation cannot be undone.

The Delete method will cancel all FaxMessage objects referenced by the FaxFolder collection and move them to the Deleted Items folder.

Delete will fail with an invalid argument error if the folder you are attempting to delete is a system defined folder (e.g., Inbox, Outbox, Deleted Items, Sent Items, Unrouted or Pending Approval).

Back to Top

Description Property

The Description property returns or sets a description for the folder. Read/write.

Syntax

ObjFolder.Description

Data Type

String

Remarks

The Update method must be called in order for changes to the Description property to become permanent.

Back to Top

Fields Property

[Undocumented in first release]

Back to Top

Flags

The Flags property returns or sets the flags associated with the folder. Read/write.

Syntax

ObjFolder.Flags

Data Type

Long

Remarks

See the FaxMsg_FolderFlags definitions for flag values.

Back to Top

FolderID Property

The FolderID property returns the unique 32-bit identifier assigned to the folder. Read-only.

Syntax

ObjFolder.FolderID

Data Type

Long

Remarks

The FolderID property can be used to retrieve this folder at a later time, using the FaxSession object’s GetFolder method.

Back to Top

Folders Property

The Folders property returns a FaxFolders collection object of the subfolders of the folder. Read-only.

Syntax

ObjFolder.Folders

Data Type

FaxFolders object

Back to Top

Index Property

The Index property returns the index of this folder within its parent FaxFolders collection. Read-only.

Syntax

ObjFolder.Index

Data Type

Long

Remarks

A folder's index property may change if items are removed from the parent FaxFolder's collection.

The first object in the collection has an Index value of 1.

Back to Top

IsSubFolder Method

The IsSubFolder method queries the current fax folder's relationship to another fax folder you specify.

Syntax

ObjFolder.IsSubFolder(FolderId)

Remarks

The IsSubFolder method returns a Boolean value. A non-zero value is returned if the FolderID you specify is a sub-folder of the current fax folder object.

Back to Top

Messages Property

The Messages property returns a FaxMessages collection object within the folder. Read-only.

Syntax

ObjFolder.Messages

Data Type

FaxMessages object

Back to Top

Modified Property

The Modified property returns the date and time when the folder was last modified. Read-only.

Syntax

ObjFolder.Modified

Data Type

Date

Back to Top

MoveTo Method

The MoveTo method moves this folder into the folder that has the FolderID you specify.

Syntax

ObjFolder.MoveTo(FolderId)

Remarks

MoveTo will fail with an invalid argument error if the folder you are attempting to move is a system defined folder (e.g. Inbox, Outbox, Deleted Items, Sent Items, Unrouted or Pending Approval).

Back to Top

Name Property

The name property returns or sets the name of the folder. Read/write.

Syntax

ObjFolder.Name

Data Type

String

Remarks

The Update method must be called in order for changes to the Name property to become permanent.

Attempts to set the Name property of a system defined folder (e.g. Inbox, Outbox, Deleted Items, Sent Items, Unrouted or Pending Approval) will fail with an invalid argument error.

Back to Top

ParentFolderID Property

The ParentFolderId property returns the unique 32-bit ID assigned to the parent folder of the folder. Read-only.

Syntax

ObjFolder.ParentFolderID

Data Type

Long

Remarks

The ParentFolderID property does not refer to the parent FaxFolders collection object, but rather to the folder of which this folder is a subfolder.

Back to Top

SortOrder Property

The SortOrder property returns or sets a sort order associated with the primary sort property. Read/write.

Syntax

ObjFolder.SortOrder

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_Sort enumeration.

Back to Top

SortOrder2 Property

The SortOrder2 property returns or sets a sort order associated with the secondary sort property. Read/write.

Syntax

ObjFolder.SortOrder2

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_Sort enumeration.

Back to Top

SortProperty Property

The SortProperty property returns or sets the primary sort property of the folder. This defines the field by which the folder FaxMessage objects will be sorted. Read/write.

Syntax

ObjFolder.SortProperty

Data Type

Long

Remarks

The SortProperty property is used as a secondary sort key when a reference to the folder Messages collection is obtained via the Messages property. Valid values for this property are defined by the FaxMsg_MessageProperties enumeration.

Back to Top

SortProperty2 Property

The SortProperty2 property returns or sets the secondary sort property of the folder. This defines the secondary field by which the folder FaxMessage objects will be sorted. Read/write.

Syntax

ObjFolder.SortProperty2

Data Type

Long

Remarks

The SortProperty2 property is used as a secondary sort key when a reference to the folder Messages collection is obtained via the Messages property. Valid values for this property are defined by the FaxMsg_MessageProperties enumeration.

Back to Top

Update Method

The Update method saves changes made to the FaxFolder object.

Syntax

ObjFolder.Update (Commit)

where Commit can be either TRUE (non-zero) or FALSE (0).

Back to Top