TMsvEntry functions and members used in fax message entries

TMsvEntry member

Description

Attachment()

Not used by Fax MTM

(A fax message entry can own an Symbian OS attachment entry which holds the rendered image file for that message. Despite this, since the fax protocol does not support sending “attachments” to other fax machines, the attachment flag is not used by the Fax MTM.)

Complete()

Sending: only messages marked as complete will be sent by the Fax MTM.

Receiving: while a fax is being received, its message entry in the Inbox is set to InPreparation()==ETrue, Complete()==EFalse and Visible()==EFalse.

The message will only be marked as complete, visible and not in preparation, once the entire fax has been received.

Connected()

Normally set to EFalse.

This flag is set to ETrue while the message is being sent to indicate to clients that the message is currently in transit and hence should not be opened at this time. The flag is set to EFalse once the attempt to send the message has been completed. Any changes made to the message while the Connected() flag is set to ETrue will be ignored by the Fax MTM, i.e. the original message will be sent even if the contents of the message have subsequently been altered by a client.

Description()

Sending: optional field with human-readable text, which may simply be “fax”

Details()

Sending: optional human-readable text identifying the first receipient

Receiving: optional human-readable text to identify the sending machine (e.g. “Symbian Ltd”)

Failed()

If the MTM is unable to send the fax message, then the Failed() flag is set on that message.

If there is more than one recipient of the fax message, the flag will be set if the message fails to be sent to any of the recipients.

The Failed() flag will be set only if the message has not been rescheduled for another attempt to send that message.

If the flag has been set, the iError member variable of the message entry contains the error code that describes that failure.

iBioUid

Not supported for fax

iDate

The time and date the message was originally created.

After an attempt has been made to send the message, iDate will be set to the home time to indicate when that attempt was made. If the message is to be scheduled, then iDate is the time the message should be sent.

For received fax messages, this is set to the time that the message was received.

iError

Error code which occurred when attempt was made to send the fax message (normally KErrNone)

iMtm

Set to KUidMsgTypefax

iMtmData1

Reserved.

iMtmData2

Reserved

iMtmData3

Reserved

InPreparation()

See Complete().

iRelatedId

Not used by Fax MTM.

iServiceId

Identifies the fax service that created the message. There is normally only one fax service in the message store.

iSize

Size, in bytes, of the message.

Note that the total size of a fax message will increase substantially when it has been rendered into an image file, which normally occurs the first time an attempt is made to send the message.

iType

Set to KUidMsvMessageEntry

MultipleRecipients()

Set to ETrue if the message is addressed to two or more recipients

New()

When new fax messages have been received, the New() flag on that message is set to ETrue. It is the responsibility of the reading client to reset the flag once it has been read/processed.

OffPeak()

Not supported in Symbian OS v7.0

Operation()

Not used by Fax MTM

PcSyncCount()

Not used by Fax MTM

Priority()

Not used

ReadOnly()

Not used by Fax MTM

Scheduled()

Set to ETrue if the fax message has been added to the task scheduler for automated scheduled sending.

This member is set by the Server MTM, therefore the client should not set this member.

SendingState()

Denotes the sending status of the fax message.

The value of this status will depend upon whether the message has been scheduled to be sent using the task scheduler. The states are defined by TMsvSendState.

Note: when a fax session starts, the Fax MTM checks the outbox folder and automatically appends any fax messages to the list of messages it has been instructed to send if those additional messages have a sending state of KMsvSendStateWaiting. This functionality allows messages which are created using the Send-As API to be sent when the user or the task scheduler initiate a new fax send session.

StandardFolder()

Not used by Fax MTM

Unread()

When new fax messages have been received, the Unread() flag on that message is set to ETrue. It is the responsibility of the reading client to reset the flag once it has been read/processed.

Visible()

See Complete().