FaxOutgoingMessage object

The FaxOutgoingMessage object is used by a fax client application to retrieve information about a fax message in the archive of outbound faxes. The archive contains faxes transmitted successfully by the fax service. The object enables you to retrieve information about the fax recipient, contained in the FaxRecipient object, and information about the fax sender, contained in the FaxSender object. It 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.

Members

The FaxOutgoingMessage object has these types of members:

Methods

The FaxOutgoingMessage object has these methods.

Method Description
[CopyTiff](-mfax-faxoutgoingmessage-copytiff-vb.md) The [CopyTiff](-mfax-faxoutgoingmessage-copytiff-vb.md) method copies the TIFF Class F file associated with the outbound fax message, to a file on the local computer.
[Delete](-mfax-faxoutgoingmessage-delete-vb.md) The [Delete](-mfax-faxoutgoingmessage-delete-vb.md) method deletes the fax message from the outbound archive.
[Refresh](-mfax-faxoutgoingmessage-refresh-vb.md) Refreshes FaxOutgoingMessage object information from the fax server. When the [Refresh](-mfax-faxoutgoingmessage-refresh-vb.md) method is called, any configuration changes made after the last [Save](-mfax-faxoutgoingmessage-save-vb.md) method call are lost.
[!Note]
This method is supported only on Windows Vista and later.

[Save](-mfax-faxoutgoingmessage-save-vb.md) Saves the FaxOutgoingMessage object's data.
[!Note]
This method is supported only on Windows Vista and later.

 

Properties

The FaxOutgoingMessage object has these properties.

Property Access type Description
[CSID](-mfax-faxoutgoingmessage-csid-vb.md)
Read-only
The [CSID](-mfax-faxoutgoingmessage-csid-vb.md) property is a null-terminated string that contains the CSID for the fax message.
[DeviceName](-mfax-faxoutgoingmessage-devicename-vb.md)
Read-only
The [DeviceName](-mfax-faxoutgoingmessage-devicename-vb.md) property is a null-terminated string that contains the name of the device on which the fax message was transmitted.
[DocumentName](-mfax-faxoutgoingmessage-documentname-vb.md)
Read-only
The [DocumentName](-mfax-faxoutgoingmessage-documentname-vb.md) property is a null-terminated string that contains the user-friendly name to display for the fax message.
[HasCoverPage](-mfax-faxoutgoingmessage-hascoverpage-vb.md)
Read-only
Indicates if the fax has a cover page.
[!Note]
This property is supported only on Windows Vista and later.

[Id](-mfax-faxoutgoingmessage-id-vb.md)
Read-only
The [Id](-mfax-faxoutgoingmessage-id-vb.md) property is a null-terminated string that contains a unique identifier for the outbound fax message.
[OriginalScheduledTime](-mfax-faxoutgoingmessage-originalscheduledtime-vb.md)
Read-only
The [OriginalScheduledTime](-mfax-faxoutgoingmessage-originalscheduledtime-vb.md) property specifies the time that the fax message was originally scheduled for transmission.
[Pages](-mfax-faxoutgoingmessage-pages-vb.md)
Read-only
The [Pages](-mfax-faxoutgoingmessage-pages-vb.md) property is a number that indicates the total number of pages in the outbound fax message.
[Priority](-mfax-faxoutgoingmessage-priority-vb.md)
Read-only
The [Priority](-mfax-faxoutgoingmessage-priority-vb.md) property specifies the priority used when sending the fax; for example, normal, low, or high priority.
[Read](-mfax-faxoutgoingmessage-read-vb.md)
Read/write
Indicates if the fax has been read.
[!Note]
This property is supported only on Windows Vista and later.

[ReceiptAddress](-mfax-faxoutgoingmessage-receiptaddress-vb.md)
Read-only
Specifies the address to which the delivery report is sent.
[!Note]
This property is supported only on Windows Vista and later.

[ReceiptType](-mfax-faxoutgoingmessage-receipttype-vb.md)
Read-only
Specifies the type of delivery report that is sent following an attempted transmission.
[!Note]
This property is supported only on Windows Vista and later.

[Recipient](-mfax-faxoutgoingmessage-recipient.md)
Read-only
The [Recipient](-mfax-faxoutgoingmessage-recipient.md) property retrieves an object containing information about the recipient of the fax message.
[Retries](-mfax-faxoutgoingmessage-retries-vb.md)
Read-only
The [Retries](-mfax-faxoutgoingmessage-retries-vb.md) property is a value that indicates the number of times that the fax service attempted to transmit an outgoing fax after the initial transmission attempt failed.
[Sender](-mfax-faxoutgoingmessage-sender.md)
Read-only
The [Sender](-mfax-faxoutgoingmessage-sender.md) property retrieves an object containing information about the sender of the fax message.
[Size](-mfax-faxoutgoingmessage-size-vb.md)
Read-only
The Size property is a value that indicates the size of the TIFF Class F file associated with the outbound fax message.
[Subject](-mfax-faxoutgoingmessage-subject-vb.md)
Read-only
The [Subject](-mfax-faxoutgoingmessage-subject-vb.md) property is a null-terminated string that contains the contents of the subject field on the cover page of the fax.
[SubmissionId](-mfax-faxoutgoingmessage-submissionid-vb.md)
Read-only
The [SubmissionId](-mfax-faxoutgoingmessage-submissionid-vb.md) property is a null-terminated string that contains the unique identifier assigned to the fax message during the submission process. All fax jobs created by the same submission process share the same unique submission ID.
[SubmissionTime](-mfax-faxoutgoingmessage-submissiontime-vb.md)
Read-only
The [SubmissionTime](-mfax-faxoutgoingmessage-submissiontime-vb.md) property indicates the time that the outbound fax message was submitted for processing.
[TransmissionEnd](-mfax-faxoutgoingmessage-transmissionend-vb.md)
Read-only
The [TransmissionEnd](-mfax-faxoutgoingmessage-transmissionend-vb.md) property indicates the time that the fax outbound message completed transmission.
[TransmissionStart](-mfax-faxoutgoingmessage-transmissionstart-vb.md)
Read-only
The [TransmissionStart](-mfax-faxoutgoingmessage-transmissionstart-vb.md) property indicates the time that the fax outbound message began transmitting.
[TSID](-mfax-faxoutgoingmessage-tsid-vb.md)
Read-only
The [TSID](-mfax-faxoutgoingmessage-tsid-vb.md) property is a null-terminated string that contains the TSID associated with the fax outbound message.

 

Remarks

A FaxOutgoingMessage object is accessed through a FaxOutgoingArchive object or a FaxOutgoingMessageIterator object.

faxoutgoingarchive, faxoutgoingmessageiterator and faxoutgoingmessage objects

To create a FaxOutgoingMessage object in Microsoft Visual Basic, call the GetMessage method of the FaxOutgoingArchive object, or retrieve the Message property of the FaxOutgoingMessageIterator object.

To create a FaxOutgoingMessage object in C++, call the GetMessage method, or the Message method.

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_FaxOutgoingMessage