FaxIncomingMessage object

Applies to: desktop apps only

The FaxIncomingMessage messaging object is used by a fax client application to retrieve information about a received fax message in the archive of inbound faxes. The archive contains faxes received successfully by the fax service. The object also includes methods to delete a message from the archive and to copy the Tagged Image File Format Class F (TIFF Class F) file associated with the fax message, to a file on the local computer.

A FaxIncomingMessage object is accessed through a FaxIncomingArchive object or a FaxIncomingMessageIterator object.

FaxIncomingArchive, FaxIncomingMessageIterator, and FaxIncomingMessage objects

Members

The FaxIncomingMessage object has these types of members:

Methods

The FaxIncomingMessage object has these methods.

MethodDescription
CopyTiff

The CopyTiff method copies the TIFF Class F file associated with the inbound fax message to a file on the local computer.

Delete

The Delete method deletes the specified fax message from the inbound fax archive.

Reassign

Reassign the fax to one or more recipients. It also commits changes to the Subject, SenderName, SenderFaxNumber, and HasCoverPage properties.

Note  This method is supported only in Windows Vista and later.

Refresh

Refreshes FaxIncomingMessage object information from the fax server. When the Refresh method is called, any configuration changes made after the last Save method call are lost, except for the properties that are committed with the Reassign method: Subject, SenderName, SenderFaxNumber, and HasCoverPage.

Note  This method is supported only in Windows Vista and later.

Save

Saves the FaxIncomingMessage object's data.

Note  This method is supported only in Windows Vista and later.

 

Properties

The FaxIncomingMessage object has these properties.

PropertyAccess typeDescription

CallerId

Read-only

The CallerId property is a null-terminated string that identifies the calling device associated with the inbound fax message.

CSID

Read-only

The CSID property is a null-terminated string that contains the CSID for the inbound fax message.

DeviceName

Read-only

The DeviceName property is a null-terminated string that contains the name of the device on which the inbound fax message was received.

HasCoverPage

Read/write

A flag that indicates whether the fax has a cover page.

Note  This property is supported only in Windows Vista and later.

Id

Read-only

The Id property is a null-terminated string that contains a unique ID for the inbound fax message.

Pages

Read-only

The Pages property is a value that indicates the total number of pages in the inbound fax message.

Read

Read/write

A flag that indicates if the fax has been read.

Note  This property is supported only in Windows Vista and later.

Recipients

Read/write

Contains the recipients associated with the inbound fax message. This property is a null-terminated string.

Note  This property is supported only in Windows Vista and later.

Retries

Read-only

The Retries property is a value that indicates the number of times that the fax service attempted to route an inbound fax message after the initial routing attempt failed.

RoutingInformation

Read-only

The RoutingInformation property is a null-terminated string that indicates inbound routing information for the fax message.

SenderFaxNumber

Read/write

Contains the sender's fax number associated with the inbound fax message. This property is a null-terminated string.

Note  This property is supported only in Windows Vista and later.

SenderName

Read/write

Contains the name of the sender that is associated with the inbound fax message. This property is a null-terminated string.

Note  This property is supported only in Windows Vista and later.

Size

Read-only

The Size property is a value that indicates the size of the TIFF Class F file associated with the inbound fax message.

Subject

Read/write

The Subject property contains the subject associated with the inbound fax message. This property is a null-terminated string.

Note  This property is supported only in Windows Vista and later.

TransmissionEnd

Read-only

The TransmissionEnd property indicates the time that the inbound fax message completed transmission.

TransmissionStart

Read-only

The TransmissionStart property indicates the time that the inbound fax message began transmitting.

TSID

Read-only

The TSID property is a null-terminated string that contains the TSID associated with the inbound fax message.

WasReAssigned

Read-only

Indicates if the fax has been reassigned.

Note  This property is supported only in Windows Vista and later.

 

Remarks

To create a FaxIncomingMessage object in Microsoft Visual Basic, call the GetMessage method of the FaxIncomingArchive object or the Message property of the FaxIncomingMessageIterator object.

The FaxIncomingMessage object implements the IFaxIncomingMessage interface in Windows XP and earlier. It implements the IFaxIncomingMessage2 interface in Windows Vista and later.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

DLL

Fxscomex.dll

IID

CLSID_FaxIncomingMessage

See also

Fax Service Extended COM Object Model
FaxIncomingArchive
FaxIncomingMessageIterator
IFaxIncomingMessage

 

 

Build date: 5/5/2012

Community Additions

ADD
Show: