CMsvEntry functions for fax message entries

The messaging architecture supplies a generic interface, CMsvEntry, for manipulating message entries. This page describes how to use its functions with fax message entries.

CMsvFunction* CreateL(const TMsvEntry& aEntry, TRequestStatus& aStatus)

Not supported for messages under the remote service (returns KErrNotSupported).

CMsvFunction* ChangeL(const TMsvEntry& aEntry, TRequestStatus& aStatus)

Not supported for messages under the remote service (returns KErrNotSupported).

CMsvFunction* DeleteL(TMsvId aMsvId, TRequestStatus& aStatus)

CMsvFunction* DeleteL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus)

void DeleteL(TMsvId aMsvId);

void DeleteL(const CMsvEntrySelection& aSelection, TMsvLocalOperationProgress& aProgress);

Not supported for messages under the remote service (returns KErrNotSupported).

CMsvFunction* CopyL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus)

CMsvFunction* CopyL(TMsvId aMsvId, TMsvId aTargetId, TRequestStatus& aStatus)

Receives a fax message from an incoming telephone call. On completion, the complete message will be placed in the folder identified by aTargetId.

Note: normally receiving faxes will be handled by a separate thread called the fax watcher, which is normally running when Symbian OS is running. The fax watcher listens to the telephony interface to identify incoming fax calls. When a call is detected, the watcher loads the Fax server MTM and automatically receives the message and places it in the inbox. As a result, it is unlikely that clients will need to start this copy-from-remote function directly.

CMsvFunction* MoveL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus)

CMsvFunction* MoveL(TMsvId aMsvId, TMsvId aTargetId, TRequestStatus& aStatus)

This is treated exactly the same as copy-from-remote by the Fax MTM. See above for additional information about this function.

CMsvFunction* CopyL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus)

CMsvFunction* CopyL(TMsvId aMsvId, TMsvId aTargetId, TRequestStatus& aStatus)

Sends the fax messages identified in aSelection or by aMsvId to the fax machines identified by the contents of each message. aTargetId should be the ID of the fax service entry.

When a message has been successfully been sent, the message entry will be moved into the Sent folder, if this folder exists.

In addition to the messages specified in aSelection, the Fax MTM will also attempt to send in the same session any other fax messages that appear in the outbox for which the SendingState() is set to KMsvSendStateUponRequest, KMsvSendStateWaiting, or KMsvSendStateResend. This intelligence allows messages that have been generated by the Send-As API an opportunity to be sent in user-initiated, or scheduled fax sessions.

CMsvFunction* MoveL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus)

CMsvFunction* MoveL(TMsvId aMsvId, TMsvId aTargetId, TRequestStatus& aStatus)

This is treated as for the copy-from-local functions, except that when a message has been successfully been sent, the message entry will be deleted from the Symbian OS message store.

CMsvFunction* CopyL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus)

CMsvFunction* CopyL(TMsvId aMsvId, TMsvId aTargetId, TRequestStatus& aStatus)

Not supported, returns KErrNotSupported.

CMsvFunction* MoveL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus)

CMsvFunction* MoveL(TMsvId aMsvId, TMsvId aTargetId, TRequestStatus& aStatus)

Not supported, returns KErrNotSupported.