FaxRecipient Object

The FaxRecipient object represents a single fax message recipient.

Properties

* - Read/write properties marked with an asterisk become Read-only after the message has been "Sent."

Methods

Back to Top

Activity Property

The Activity property returns the transmission status to the fax recipient object. Read-only.

Syntax

ObjRecipient.Activity

Data Type

Long

Remarks

The activity value of a fax recipient reflects the current transmission status during the message processing. For example, message delivery to a recipient may be pending, however, the activity value may be defined as "negotiating" or "ringing."

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

Back to Top

Address Property

The Address property returns or sets the address defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.Address

Data Type

String

Remarks

*The Address property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

BillingCode Property

The BillingCode property returns or sets the billing code defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.BillingCode

Data Type

String

Remarks

*The BillingCode property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

Cancel Method

The Cancel method cancels the fax recipient object if it is pending.

Syntax

ObjRecipient.Cancel ( )

Remarks

Only pending fax messages to the FaxRecipient object can be canceled. Requests to cancel a fax message to a recipient having any other status will be ignored.

Back to Top

City Property

The City property returns or sets the city code defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.City

Data Type

String

Remarks

*The City property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

Company Property

The Company property returns or sets the company string defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.Company

Data Type

String

Remarks

*The Company property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

ConnectSpeed Property

The ConnectSpeed property returns the speed of the connection while the fax message was being delivered to the FaxRecipient. Read-only.

Syntax

ObjRecipient.ConnectSpeed

Data Type

Long

Back to Top

ConnectTime Property

The ConnectTime property returns the duration of time required to deliver the fax message to the FaxRecipient. Read-only.

Syntax

ObjRecipient.ConnectTime

Data Type

Long

Back to Top

Country Property

The Country property returns or sets the country defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.Country

Data Type

String

Remarks

*The Country property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

DateTime Property

The DateTime property returns the date and time at which the fax message was delivered to the FaxRecipient. Read-only.

Syntax

ObjRecipient.DateTime

Data Type

Date

Back to Top

Delete Method

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

Syntax

ObjRecipient.Delete( )

Remarks

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

Back to Top

Device Property

The Device property returns the device that handled the fax transmission. Read-only.

Syntax

ObjRecipient.Device

Data Type

Long

Back to Top

Department Property

The Department property returns or sets the department defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.Department

Data Type

String

Remarks

*The Department property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

FaxNumber Property

The FaxNumber property returns or sets the destination fax number defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.FaxNumber

Data Type

String

Remarks

*The FaxNumber property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

Index Property

The Index property returns the index of the recipient object within its parent FaxRecipients collection. The index reflects this recipient’s position within the parent collection. Read-only.

Syntax

ObjRecipient.Index

Data Type

Long

Remarks

A recipient's index property may change if other recipient items are removed from the parent FaxRecipients collection.

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

Back to Top

MfgErrorCode Property

The MfgErrorCode property returns the error code experienced by the fax device during transmission to the FaxRecipient. Read-only.

Syntax

ObjRecipient.MfgErrorCode

Data Type

Long

Back to Top

Name Property

The Name property returns or sets the name of the FaxRecipient object as a string. Read/write*.

Syntax

ObjRecipient.Name

Data Type

String

Remarks

*The Name property is Read-Only when the recipient object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

NumberDialed Property

The NumberDialed property returns the dialed destination fax number string. Read-only.

Syntax

ObjRecipient.NumberDialed

Data Type

String

Back to Top

Pages Property

The Pages property returns the number of pages associated with the FaxRecipient object. Read-only.

Syntax

ObjRecipient.Pages

Data Type

Long

Back to Top

PagesSent Property

The PagesSent property returns the numbers of successfully sent pages associated with the FaxRecipient object. Read-only.

Syntax

ObjRecipient.PagesSent

Data Type

Long

Back to Top

PhonebookEntry Property

The PhonebookEntry property returns or sets the FaxRecipient object from/to a FaxPhonebookEntry. Read/write*.

Syntax

ObjRecipient.PhonebookEntry

Data Type

Long

Remarks

Use the PhonebookEntry property as an alternative to setting individual properties for a FaxRecipient object. Simply set the PhonebookEntry property and the FaxRecipient object will gather all properties associated with the recipient.

*The PhonebookEntry property is Read-Only when the recipient object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

RefreshStatus Method

The RefreshStatus method refreshes the fax recipient's transmission status.

Syntax

ObjRecipient.RefreshStatus( )

Back to Top

RemoteCSI Property

The RemoteCSI property returns the recipient's call subscriber identifier (CSI) registered at the remote fax machine. Read-only.

Syntax

ObjRecipient.RemoteCSI

Data Type

String

Back to Top

RetryCount Property

The RetryCount property returns the number of retries required to deliver the fax message to the FaxRecipient. Read-only.

Syntax

ObjRecipient.RetryCount

Data Type

Long

Back to Top

RoutingInfo Property

The RoutingInfo property returns the fax recipient's routing information (DID/DTMF codes, caller ID, sub-address, etc.). Read-only.

Syntax

ObjRecipient.RoutingInfo

Data Type

String

Back to Top

State Property

The State property returns or sets the state defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.State

Data Type

String

Remarks

*The State property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

Status Property

The Status property returns the status of the FaxRecipient object (for example, Pending, Complete, No Answer). Read-only.

Syntax

ObjRecipient.Status

Data Type

Long

Remarks

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

Back to Top

UserDefined1 - Userdefined4 Properties

The UserDefinedX properties return or set the 4 properties set aside for custom usage, Read/write*.

Syntax

ObjRecipient.UserDefined1

Data Type

String

Remarks

*The UserDefined properties are Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top

WriteCoverPageToFile Method

The WriteCoverPageToFile method copies the rendered cover page image to the filename you specify.

Syntax

ObjRecipient.WriteCoverPageToFile( )

Back to Top

ZipCode Property

The ZipCode property returns or sets the ZIP code defined for the fax recipient. Read/write*.

Syntax

ObjRecipient.ZipCode

Data Type

String

Remarks

*The ZipCode property is Read-Only when the recipient object is contained within a "sent" message. After a fax message has been sent, any change to this property is ignored.

Back to Top