TMTMFaxSettings in Fax Client MTM

TMTMFaxSettings

Support

Supported from 6.0

Description

Settings to be used by the Fax MTM when it connects to a fax machine.

Objects of this type are stored in a stream within the CMsvStore store that is associated with the Fax service entry, and stored and restored using its StoreL() and RestoreL() functions.

Derivation

`TFaxSettings`	Fax configuration information
`TMTMFaxSettings`	Settings to be used by the Fax MTM when it connects to a fax machine

Defined in TMTMFaxSettings:
EFaxNoPartialResend, EFaxNoProgressInEntry, EFaxNoUnRenderOnSend, EFaxSentFaxesNotReadOnly, EFaxWatcherDisabled, ExternalizeL(), InternalizeL(), KFaxSettingsClearFlag, KFaxSettingsUnusedFlag, MessageLogFolder(), PartialResend(), ProgressInEntry(), Reset(), RestoreL(), SentFaxesReadOnly(), SetMessageLogFolder(), SetPartialResend(), SetProgressInEntry(), SetSentFaxesReadOnly(), SetUnRenderOnSend(), SetVersion(), SetWatcherEnabled(), StoreL(), TFaxSettingsFlags, TMTMFaxSettings(), UnRenderOnSend(), Version(), WatcherEnabled(), iFlags, iMessageLogFolder, iReserved1, iReserved2, iUserName, iVersion, operator=()

Inherited from TFaxSettings:
iFaxClass, iFaxId, iFaxOnDemandDelay, iMaxSpeed, iMinSpeed, iPreferredCompression, iPreferredECM, iPreferredResolution, iVerbose

TMTMFaxSettings();

Description

Default constructor.

Initialises all member data to their default values. These are:

user name: NULL
flags: 0
version: KFaxSettingsVersion
message log folder: KMsvSentEntryId
fax number (ID): NULL
verbose logging: true
preferred resolution: EFaxFine
preferred compression: EModifiedHuffman
maximum speed: 14400
minimum speed: 2400
fax-on-demand delay: 2
fax class: EClassAuto

void ExternalizeL(RWriteStream& aWriteStream) const;

Description

Externalises the Fax MTM settings to a write stream.

Parameters

RWriteStream& aWriteStream

Stream to which the Fax MTM settings should be externalised.

void InternalizeL(RReadStream& aReadStream);

Description

Internalises the Fax MTM settings from a read stream.

Parameters

RReadStream& aReadStream

Stream from which the Fax MTM settings should be internalised.

void StoreL(CMsvStore& aMsvStore) const;

Description

Stores the Fax MTM settings to an service entry store.

The CMsvStore has to be opened for edit before the settings are saved.

Parameters

CMsvStore& aMsvStore

The entry store.

void RestoreL(const CMsvStore& aMessageStore);

Description

Restores the Fax MTM settings from a service entry store.

Parameters

const 
CMsvStore& aMessageStore

The entry store.

void Reset();

Description

Resets the Fax MTM settings to their default values.

For the default values, see the description for the constructor.

const TMsvId MessageLogFolder() const;

Description

Gets the folder to which messages are moved after they have been sent.

By default this is set to the Sent folder (KMsvSentEntryId).

Return value

TMsvId

The entry ID of the message log folder.

void SetMessageLogFolder(TMsvId aMessageLogFolder);

Description

Sets the folder to which messages are moved after they have been sent.

Parameters

TMsvId aMessageLogFolder

The entry ID of the message log folder.

const TUint16 Version() const;

Description

Gets the version number of the fax settings stream.

This enables code to identify message stores created by previous releases of the Message engine. By default, this number is KFaxSettingsVersion.

Return value

TUint16

The version number of the fax settings stream.

void SetVersion(const TUint16 aVersion);

Description

Sets the version number of this fax settings stream.

This enables code to identify message stores created by previous releases of the Message engine.

Parameters

const 
TUint16 aVersion

The version number of the fax settings stream.

TBool ProgressInEntry() const;

Description

Tests if the entry for a fax message being sent is regularly updated to identify how many pages of the fax have been transmitted.

If this flag is set, the RenderingComplete() and SendingPage() settings in the TMsvFaxEntry are updated while the fax is sent.

Fax transmissions will be slower when this settings is switched on.

This is true by default.

Return value

TBool

True if updates occur

void SetProgressInEntry(TBool aProgress);

Description

Sets if the entry for a fax message being sent should be regularly updated to identify how many pages of the fax have been transmitted.

If this flag is set, the RenderingComplete() and SendingPage() settings in the TMsvFaxEntry are updated while the fax is sent.

Parameters

TBool aProgress

True if updates should occur, false if not

TBool PartialResend() const;

Description

Tests if partial resending is enabled.

Partial resending means that if an error occurs when sending a fax, the last successfully sent page is recorded with the recipient details. If the fax is then resent, only those pages that were not sent previously will be retransmitted.

This is true by default.

Return value

TBool

ETrue if partial resending is used, EFalse if not.

void SetPartialResend(TBool aResend);

Description

Sets a flag that indicates whether partial resending should be used.

If the Partial Resend flag is not set, partial resending is disabled and all the pages of a failed fax are resent, whether they were previously sent successfully or not.

Parameters

TBool aResend

ETrue if partial resending should be used, otherwise EFalse.

TBool UnRenderOnSend() const;

Description

Tests if faxes are unrendered when they have been successfully sent to all recipients.

Rendered fax images can consume a lot of space in the file system, so better use can be made of limited space if faxes are unrendered when the image is no longer needed.

This returns true by default.

Return value

TBool

ETrue if faxes should be unrendered when they have been successfully sent to all recipients, EFalse if not.

void SetUnRenderOnSend(TBool aUnRender);

Description

Sets a flag that indicates whether faxes should be unrendered when they have been successfully sent to all recipients.

Rendered fax images can consume a lot of space in the file system, so better use can be made of limited space if faxes are unrendered when the image is no longer needed.

Parameters

TBool aUnRender

ETrue if faxes should be unrendered when they have been successfully sent to all recipients. otherwise EFalse.

inline TBool WatcherEnabled() const;

Description

Tests if the fax watcher is enabled.

The fax watcher is a separate background thread. It listens to the telephony interfaces to identify incoming fax calls, and, when a call is detected, loads the fax server MTM and receives the fax, placing it in the inbox.

Return value

TBool

ETrue if the fax watcher should answer incoming fax calls, EFalse if not.

void SetWatcherEnabled(TBool aEnabled);

Description

Enables or disables the fax watcher.

Parameters

TBool aEnabled

ETrue if the fax watcher should answer incoming fax calls, EFalse if not.

TBool SentFaxesReadOnly() const;

Description

Tests if fax entries are marked as read-only after they have been successfully sent.

Return value

TBool

ETrue if fax entries should be marked as read-only after they have been successfully sent, EFalse if not.

void SetSentFaxesReadOnly(TBool aReadOnly);

Description

Sets if fax entries should be marked as read-only after they have been successfully sent.

By default this flag is set to true.

Parameters

TBool aReadOnly

ETrue if fax entries should be marked as read-only after they have been successfully sent, EFalse if not.

TMTMFaxSettings& operator=(const TMTMFaxSettings& aFaxSettings);

Description

Overloaded assignment operator.

Parameters

const TMTMFaxSettings& aFaxSettings

Object from which to copy settings

Return value


TMTMFaxSettings
&

this object after copying settings from aFaxSettings

TBuf<20> iUserName;