FaxMessage Object

The FaxMessage object represents a single fax message in a folder.

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 current message activity value. Read-only.

Syntax

ObjMessage.Activity

Data Type

Long

Remarks

The activity value of a fax message reflects the current device status during the message processing. For example, an outbound message may be pending, however, its activity value may be defined as "negotiating" or "ringing."

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

Back to Top

AddOutboxRecipient Method

Documentation forthcoming.

Syntax

ObjMessage.AddOutboxRecipient(FaxRecipient FaxRecip)

Remarks

Back to Top

Attachments Property

The Attachments property returns a FaxAttachments collection object. Read-only.

Syntax

ObjMessage.Attachments

Data Type

FaxAttachments object

Back to Top

BillingCode Property

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

Syntax

ObjMessage.BillingCode

Data Type

String

Remarks

*The BillingCode property is Read-Only when the message 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 message object if it is pending.

Syntax

ObjMessage.Cancel ( )

Remarks

Only pending fax messages can be canceled. Requests to cancel a fax message with any other status will be ignored.

Back to Top

CoverPage Property

The CoverPage property returns or sets the FaxCoverPage object associated with the fax message. Read/write*.

Syntax

ObjMessage.CoverPage

Data Type

FaxCoverPage object

Remarks

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

Back to Top

CreateOutboxMessage Method

Documentation forthcoming.

Syntax

ObjMessage.CreateOutboxMessage

Remarks

Back to Top

CreateOutboxRecipient Method

Documentation forthcoming

Syntax

ObjMessage.CreateOutboxRecipient

Remarks

Back to Top

Delete Method

The Delete method removes the message object from its parent FaxMessages collection, and deletes any fax server based resources associated with the FaxMessage object.

Syntax

ObjMessage.Delete( )

Remarks

The Delete method moves the FaxMessage object to the Deleted Items folder, if this option is enabled for the current user. If the option is not enabled, or if the message is already in the Deleted Items folder, the Delete method permanently removes the fax message from the FaxMessages collection, and it cannot be restored.

Before calling Delete, your application should prompt the user to verify whether the fax message should be deleted.

Back to Top

ExpireTime Property

The ExpireTime property returns or sets the "do not send after" date and time for the FaxMessage object. Read/write*.

Syntax

ObjMessage.ExpireTime

Data Type

Date

Remarks

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

Back to Top

Fields Property

The Fields property returns a FaxFields collection object. Read-only.

Syntax

ObjMessage.Fields

Data Type

FaxFields object

Remarks

The Fields property returns all of the fields associated with a FaxMessage object.

Back to Top

Flags Property

The Flags property returns or sets the message object's flag setting. Read/write*.

Syntax

ObjMessage.Flags

Data Type

Long

Remarks

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

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

Back to Top

FolderID Property

The FolderID property returns the unique 32-bit identifier assigned to the folder to which the fax message belongs. Read-only.

Syntax

ObjMessage.FolderID

Data Type

Long

Remarks

The FolderID property can be used to retrieve the folder at a later time, using the FaxSession object’s GetFolder method.

Back to Top

GetFieldValue Method

The GetFieldValue method returns the value of the FieldID you specify.

Syntax

ObjMessage.GetFieldValue (FieldID)

Back to Top

HoldForPreview Property

The HoldForPreview property returns or sets the flag that holds the rendered fax message at the fax server for preview by the user. Read/write*.

Syntax

ObjMessage.HoldForPreview

Data Type

Boolean

Remarks

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

When this property is set to TRUE (non-zero), the fax message will be rendered and held at the fax server until released by the sending user.

Back to Top

Index Property

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

Syntax

ObjMessage.Index

Data Type

Long

Remarks

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

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

Back to Top

JobType Property

The JobType property returns or sets the application that scheduled the fax message object (for example, Web Agent, Email). Read/write*.

Syntax

ObjMessage.JobType

Data Type

Long

Remarks

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

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

Back to Top

ManagerID Property

The ManagerID property returns the unique 32-bit identifier that identifies the manager authorized to approve the FaxMessage object. Read-only.

Syntax

ObjMessage.ManagerID

Data Type

Long

Back to Top

MessageID Property

The MessageID property returns the unique 32-bit identifier assigned to the FaxMessage object. Read-only.

Syntax

ObjMessage.MessageID

Data Type

Long

Remarks

The MessageID property can be used to retrieve this message at a later time, using the FaxSession object’s GetMessage method.

Back to Top

MoveTo Method

The MoveTo method moves the FaxMessage object to another folder.

Syntax

ObjMessage.MoveTo (FolderID)

Remarks

The MoveTo method moves the fax message to the folder having the FolderID you specify. The FolderID is the unique identifier of the destination FaxFolder object into which this message is to be moved.

All properties that have been set on this message are moved, whether they have read-only or read/write access. Each property is moved with its value and access unchanged.

Back to Top

Pages Property

The Pages property returns the numbers of pages in the FaxMessage object. Read-only.

Syntax

ObjMessage.Pages

Data Type

Long

Back to Top

Priority Property

The Priority property returns or sets the priority assigned to the fax message. Read/write*.

Syntax

ObjMessage.Priority

Data Type

Long

Remarks

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

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

Back to Top

Recipients Property

The Recipients property returns the FaxRecipients collection object associated with the fax message. Read-only.

Syntax

ObjMessage.Recipients

Data Type

FaxRecipients object

Back to Top

RecipientsFilter Property

The RecipientsFilter returns or sets the recipient filter flags for the Recipient object. See the FaxMsg_RecipFilter_Flags definitions for more information.

Syntax

ObjMessage.RecipientsFilter

Data Type

Long

Back to Top

Refresh Method

The Refresh method reloads the FaxMessage object from the fax server. The contents of the current FaxRecipients and FaxAttachments collections will be discarded.

Syntax

ObjMessage.Refresh ( )

Back to Top

ReleaseMessage Method

The ReleaseMessage method causes the fax message object to be released, approved, or denied, depending on the action value assigned by the method.

Syntax

ObjMessage.ReleaseMessage (action value)

Remarks

The ReleaseMessage method alters the status of the fax message.

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

Back to Top

Resolution Property

The Resolution property returns or sets the resolution of the fax message text. Read/write*.

Syntax

ObjMessage.Resolution

Data Type

Long

Remarks

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

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

Back to Top

Route Method

The Route method routes the FaxMessage object to another user.

Syntax

ObjMessage.Route (UserID)

Remarks

The Route method moves the fax message to the user having the UserID you specify. The UserID is the unique identifier of the destination FaxUser object to which this message is to be routed.

All properties that have been set on this message are routed, whether they have read-only or read/write access. Each property is moved with its value and access unchanged.

Back to Top

Send Method

The Send method sends the specified fax message to the recipients.

Syntax

ObjMessage.Send (MessageID)

Remarks

The Send method moves the fax message to the current user’s Outbox folder. After the fax message is transmitted, the message is removed from the Outbox and copied to the Sent items folder.

You should compose new fax messages in either the Inbox or the Outbox. The Send method only deals with fax messages located in these folders.

Back to Top

Sender Property

The Sender property returns or sets the sender of the fax message. Read/write*.

Syntax

ObjMessage.Sender

Data Type

String

Remarks

The Sender property defaults to the FaxUser's DisplayName property.

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

Back to Top

SendOffPeak Property

The SendOffPeak property returns or sets the flag that sends the fax message at an off-peak time, as defined by the fax server properties. Read/write*.

Syntax

ObjMessage.SendOffPeak

Data Type

Boolean

Remarks

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

When this property is set to TRUE (non-zero), the fax message will be sent during the off-peak time interval defined at the fax server.

Back to Top

SendTime Property

The SendTime property returns or sets the date and time the FaxMessage was sent. Read/write*.

Syntax

ObjMessage.SendTime

Data Type

Date

Remarks

The SendTime property represents the "do not send before" date and time for new FaxMessage objects.

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

Back to Top

SetFieldValue Method

The SetFieldValue method sets a value for the FieldID you specify.

Syntax

ObjMessage.SetFieldValue (FieldID, NewVal)

where FieldID is the unique identifier of the field you want to define and NewVal is the new value of the field.

Back to Top

SetTextFromFile Method

The SetTextFromFile method sets the FaxMessage text using an external file you specify as the source.

Syntax

ObjMessage.SetTextFromFile (FileName)

where FileName is a string pointing to the file containing the message text.

Back to Top

StartOnCoverPage Property

The StartOnCoverPage property returns or sets the flag that begins the fax message text on the cover page. Read/write*.

Syntax

ObjMessage.StartOnCoverPage

Data Type

Boolean

Remarks

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

When this property is set to TRUE (non-zero), there must be a cover page associated with the outbound fax message.

Back to Top

Status Property

The Status property returns the status of the FaxMessage object (for example, Pending or Complete). Read-only.

Syntax

ObjMessage.Status

Data Type

Long

Remarks

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

Back to Top

Subject Property

The Subject property returns or sets the subject of the fax message as a string. Read/write*.

Syntax

ObjMessage.Subject

Data Type

String

Remarks

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

Back to Top

Text Property

The Text property returns or sets the fax message text. Read/write*.

Syntax

ObjMessage.Text

Data Type

String

Remarks

The Text property is a plain text representation of the message text and does not support formatted text.

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

Back to Top

Type Property

The Type property returns the message class for the message, indicating either a sent or received message. Read-only.

Syntax

ObjMessage.Type

Data Type

Long

Remarks

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

Back to Top

Unread Property

The Unread property returns or sets a flag that indicates whether the fax message has been read by the current user. Read/write.

Syntax

ObjMessage.Unread

Data Type

Boolean

Remarks

The Unread property should initially be TRUE (1) for all fax messages. Each receiving user sets the Unread property to False as the user reads the received fax message.

Back to Top

UserId Property

The UserId property returns the object ID of the Message "owner". This is the sender, in the case of outbound faxes, or the user currently routed to, in the case of inbound faxes. Read only.

Syntax

ObjMessage.UserId

Data Type

Long

Back to Top