FaxIncomingMessage object

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.

Members

The FaxIncomingMessage object has these types of members:

• Methods
• Properties

Methods

The FaxIncomingMessage object has these methods.

Method	Description
[CopyTiff](-mfax-faxincomingmessage-copytiff-vb.md)	The [CopyTiff](-mfax-faxincomingmessage-copytiff-vb.md) method copies the TIFF Class F file associated with the inbound fax message to a file on the local computer.
[Delete](-mfax-faxincomingmessage-delete-vb.md)	The [Delete](-mfax-faxincomingmessage-delete-vb.md) method deletes the specified fax message from the inbound fax archive.
[Reassign](-mfax-faxincomingmessage-reassign-vb.md)	[Reassign](-mfax-glossary.md) the fax to one or more recipients. It also commits changes to the [Subject](-mfax-faxincomingmessage-subject-vb.md), [SenderName](-mfax-faxincomingmessage-sendername-vb.md), [SenderFaxNumber](-mfax-faxincomingmessage-senderfaxnumber-vb.md), and [HasCoverPage](-mfax-faxincomingmessage-hascoverpage-vb.md) properties. [!Note] This method is supported only in Windows Vista and later.
[Refresh](-mfax-faxincomingmessage-refresh-vb.md)	Refreshes FaxIncomingMessage object information from the fax server. When the [Refresh](-mfax-faxincomingmessage-refresh-vb.md) method is called, any configuration changes made after the last [Save](-mfax-faxincomingmessage-save-vb.md) method call are lost, except for the properties that are committed with the [Reassign](-mfax-faxincomingmessage-reassign-vb.md) method: [Subject](-mfax-faxincomingmessage-subject-vb.md), [SenderName](-mfax-faxincomingmessage-sendername-vb.md), [SenderFaxNumber](-mfax-faxincomingmessage-senderfaxnumber-vb.md), and [HasCoverPage](-mfax-faxincomingmessage-hascoverpage-vb.md). [!Note] This method is supported only in Windows Vista and later.
[Save](-mfax-faxincomingmessage-save-vb.md)	Saves the FaxIncomingMessage object's data. [!Note] This method is supported only in Windows Vista and later.

 

Properties

The FaxIncomingMessage object has these properties.

Property	Access type	Description
[CallerId](-mfax-faxincomingmessage-callerid-vb.md)	Read-only	The [CallerId](-mfax-faxincomingmessage-callerid-vb.md) property is a null-terminated string that identifies the calling device associated with the inbound fax message.
[CSID](-mfax-faxincomingmessage-csid-vb.md)	Read-only	The [CSID](-mfax-faxincomingmessage-csid-vb.md) property is a null-terminated string that contains the CSID for the inbound fax message.
[DeviceName](-mfax-faxincomingmessage-devicename-vb.md)	Read-only	The [DeviceName](-mfax-faxincomingmessage-devicename-vb.md) property is a null-terminated string that contains the name of the device on which the inbound fax message was received.
[HasCoverPage](-mfax-faxincomingmessage-hascoverpage-vb.md)	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](-mfax-faxincomingmessage-id-vb.md)	Read-only	The [Id](-mfax-faxincomingmessage-id-vb.md) property is a null-terminated string that contains a unique ID for the inbound fax message.
[Pages](-mfax-faxincomingmessage-pages-vb.md)	Read-only	The [Pages](-mfax-faxincomingmessage-pages-vb.md) property is a value that indicates the total number of pages in the inbound fax message.
[Read](-mfax-faxincomingmessage-read-vb.md)	Read/write	A flag that indicates if the fax has been read. [!Note] This property is supported only in Windows Vista and later.
[Recipients](-mfax-faxincomingmessage-recipients-vb.md)	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](-mfax-faxincomingmessage-retries-vb.md)	Read-only	The [Retries](-mfax-faxincomingmessage-retries-vb.md) 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](-mfax-faxincomingmessage-routinginformation-vb.md)	Read-only	The [RoutingInformation](-mfax-faxincomingmessage-routinginformation-vb.md) property is a null-terminated string that indicates inbound routing information for the fax message.
[SenderFaxNumber](-mfax-faxincomingmessage-senderfaxnumber-vb.md)	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](-mfax-faxincomingmessage-sendername-vb.md)	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](-mfax-faxincomingmessage-size-vb.md)	Read-only	The [Size](-mfax-faxincomingmessage-size-vb.md) property is a value that indicates the size of the TIFF Class F file associated with the inbound fax message.
[Subject](-mfax-faxincomingmessage-subject-vb.md)	Read/write	The [Subject](-mfax-faxincomingmessage-subject-vb.md) 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](-mfax-faxincomingmessage-transmissionend-vb.md)	Read-only	The [TransmissionEnd](-mfax-faxincomingmessage-transmissionend-vb.md) property indicates the time that the inbound fax message completed transmission.
[TransmissionStart](-mfax-faxincomingmessage-transmissionstart-vb.md)	Read-only	The [TransmissionStart](-mfax-faxincomingmessage-transmissionstart-vb.md) property indicates the time that the inbound fax message began transmitting.
[TSID](-mfax-faxincomingmessage-tsid-vb.md)	Read-only	The [TSID](-mfax-faxincomingmessage-tsid-vb.md) property is a null-terminated string that contains the TSID associated with the inbound fax message.
[WasReAssigned](-mfax-faxincomingmessage-wasreassigned-vb.md)	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 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Faxcomex.h
DLL	Fxscomex.dll
IID	CLSID_FaxIncomingMessage

See also

Fax Service Extended COM Object Model

FaxIncomingArchive

FaxIncomingMessageIterator

IFaxIncomingMessage