FaxRecipients Collection Object

The FaxRecipients collection object contains one or more FaxRecipient objects and specifies the recipients of a fax message.

Properties

Methods

Remarks

Because a fax message may have several recipients, use the Item property to reference a particular FaxRecipient object.

Back to Top

Add Method

The Add method creates and returns a new FaxRecipient object in the FaxRecipients collection. The Add method also creates server based resources associated with the new recipient.

Syntax

ObjRecipients.Add(FaxRecipient)

Back to Top

Count Property

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

Syntax

ObjRecipients.Count

Data Type

Long

Back to Top

Item Property

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

Syntax

ObjRecipients.Item(Index)

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

Data Type

FaxRecipient object

Remarks

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

Back to Top

Remove Method

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

Syntax

ObjRecipients.Remove(Index)

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

Remarks

The Remove method is irreversible. The recipient will be deleted permanently from the FaxRecipients collection.

Back to Top

RemoveAll Method

The RemoveAll method deletes all FaxRecipient objects from the collection. Server based resources associated with the recipients are also deleted.

Syntax

ObjRecipients.RemoveAll

Remarks

The RemoveAll method is irreversible. All recipients will be deleted permanently from the FaxRecipients collection. To delete only a single FaxRecipient object, use the Remove method specific to that object.

Back to Top