Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: IMAPSET.H
Link against: imcm.lib

Class CImImap4Settings

class CImImap4Settings : public CImBaseEmailSettings;

Description

Settings for connection to and use of an IMAP4 mail server and its mailboxes.

Messaging clients should use an instance of this class to specify and retrieve configuration settings that are used by an IMAP4 service when executing email operations.

Service settings include:

CImImap4Settings objects are created and accessed through CEmailAccounts. CEmailAccounts can also be used to get the connection settings, such as the ISP to use, used to access an IMAP server.

Settings for a service are associated with a service-type entry in the Message Server'smessage store. However the settings are not actually stored in the message store, but in the device's Central Repository data store.

Derivation

Members

Defined in CImImap4Settings:
AcknowledgeReceipts(), AttachmentSizeLimit(), AutoSendOnConnect(), BodyTextSizeLimit(), CImImap4Settings(), CopyL(), DeleteEmailsWhenDisconnecting(), DisconnectedUserMode(), FetchSize(), FolderPath(), GetMailOptions(), ImapIdle(), ImapIdleTimeout(), InboxSynchronisationLimit(), LoginName(), MailboxSynchronisationLimit(), MaxEmailSize(), PartialMailOptions(), Password(), PathSeparator(), Reset(), SearchString(), SetAcknowledgeReceipts(), SetAttachmentSizeLimitL(), SetAutoSendOnConnect(), SetBodyTextSizeLimitL(), SetDeleteEmailsWhenDisconnecting(), SetDisconnectedUserMode(), SetFetchSizeL(), SetFolderPathL(), SetGetMailOptions(), SetImapIdle(), SetImapIdleTimeoutL(), SetInboxSynchronisationLimit(), SetLoginNameL(), SetMailboxSynchronisationLimit(), SetMaxEmailSize(), SetPartialMailOptionsL(), SetPasswordL(), SetPathSeparator(), SetSearchStringL(), SetSubscribe(), SetSyncRateL(), SetSynchronise(), SetUpdatingSeenFlags(), SetUseExpunge(), Subscribe(), SyncRate(), Synchronise(), UpdatingSeenFlags(), UseExpunge(), operator==(), ~CImImap4Settings()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CImBaseEmailSettings:
EBaseEmailSettingsClearFlag, EBaseEmailSettingsLastUsedFlag, EBaseEmailSettingsSSLWrappedSockets, EBaseEmailSettingsSecureSockets, Port(), SSLWrapper(), SecureSockets(), ServerAddress(), SetPort(), SetSSLWrapper(), SetSecureSockets(), SetServerAddressL(), TImBaseEmailSettings, iFlags, iPortNumber

See also:


Construction and destruction


CImImap4Settings()

IMPORT_C CImImap4Settings();

Description

Allocates and creates a new CImImap4Settings object initialised to default values.


~CImImap4Settings()

virtual IMPORT_C ~CImImap4Settings();

Description

Destructor.

[Top]


Member functions


Reset()

IMPORT_C void Reset();

Description

Resets the settings to their default values.


LoginName()

IMPORT_C const TPtrC8 LoginName() const;

Description

Retrieves the configured login user name (mailbox) of the IMAP4 service.

Return value

const TPtrC8

The user name.

See also:


SetLoginNameL()

IMPORT_C void SetLoginNameL(const TDesC8 &aLoginName);

Description

Configures the login user name (mailbox) for the IMAP4 service.

Parameters

const TDesC8 &aLoginName

The login user name. A copy of aLoginName is made so if you want to change the user name you must call this method again for the changes to take effect.


Password()

IMPORT_C const TPtrC8 Password() const;

Description

Retrieves the configured login password that will be sent during authentication with the IMAP4 server.

Return value

const TPtrC8

The password.

See also:


SetPasswordL()

IMPORT_C void SetPasswordL(const TDesC8 &aPassword);

Description

Configures the login password for the IMAP4 service.

Parameters

const TDesC8 &aPassword

The login password. A copy of aPassword is made so if you want to change the user name you must call this method again for the changes to take effect.


FolderPath()

IMPORT_C const TPtrC8 FolderPath() const;

Description

Retrieves the configured path of the IMAP4 mailbox on the server if the user's primary mailbox is not in the Inbox folder.

Most of the time this setting will not have to be configured, however this may need to be altered by the user for use with some IMAP4 servers. Refer to RFC 3501 Section 5.1 Mailbox Naming for more information.

The default setting is empty.

Return value

const TPtrC8

The folder path.


SetFolderPathL()

IMPORT_C void SetFolderPathL(const TDesC8 &aFolderPath);

Description

Specifies the path to the IMAP4 mailbox on the server if the user's primary mailbox is not in the Inbox folder.

Most of the time this setting will not have to be configured, however this may need to be altered by the user for use with some IMAP4 servers. Refer to RFC 3501 Section 5.1 Mailbox Naming for more information.

The default setting is empty.

Parameters

const TDesC8 &aFolderPath

The folder path.


SearchString()

IMPORT_C const TPtrC8 SearchString() const;

Description

Gets the search string used to filter which messages are synchronised.

For details, see SetSearchStringL().

Return value

const TPtrC8

Synchronisation filter string


SetSearchStringL()

IMPORT_C void SetSearchStringL(const TDesC8 &aSearchString);

Description

Sets a search string for the service.

This setting allows a filter to be specified that prevents certain e-mail messages from being synchronised onto the device when a client requests a synchronisation. An IMAP Search command is issued to the server to provide a list of messages to be synchronised.

Note that when a synchronisation command is given with a search string set:

To remove a filter, set the search string to KNullDesC.

A complete overview of the syntax of search strings is given in section 6.4.4 (SEARCH Command) of RFC 3501. Some valid example search strings are:

FLAGGED SINCE 1-Feb-1994 NOT FROM "Smith"

BODY "some text in the body"

Parameters

const TDesC8 &aSearchString

Synchronisation filter string


PathSeparator()

IMPORT_C TText8 PathSeparator() const;

Description

Retrieves the character configured to separate hierarchical mailbox names on the IMAP4 server. Refer to RFC 3501 section 5.1.1 for more information.

The default setting an empty null-terminated string.

Return value

TText8

The path separator character.


SetPathSeparator()

IMPORT_C void SetPathSeparator(const TText8 aPathSeparator);

Description

Specifies the character used to separate hierarchical mailbox names on the IMAP4 server. Refer to RFC 3501 section 5.1.1 for more information.

The default setting an empty null-terminated string.

Parameters

const TText8 aPathSeparator

The path separator character.


DisconnectedUserMode()

IMPORT_C TBool DisconnectedUserMode() const;

Description

Checks if disconnected user mode is configured.

If disconnected user mode is enabled by calling SetDisconnectedUserMode(), then the IMAP4 client MTM (CImap4ClientMtm) will accept message operations, such as deleting messages from a server, while the user is offline. The operations are stored and executed when the user connects again.

Return value

TBool

ETrue if disconnected user mode is enabled.

See also:


SetDisconnectedUserMode()

IMPORT_C void SetDisconnectedUserMode(TBool aFlag);

Description

Enables the IMAP4 client MTM (CImap4ClientMtm) to accept message operations while disconnected.

If disconnected user mode is enabled the IMAP4 client MTM will accept message operations such as deleting messages from a server, while the user is offline. The operations are stored and executed when the user connects again.

Parameters

TBool aFlag

Specify ETrue to enable disconnected user mode. Specify EFalse to disable disconnected user mode.

See also:


SetSynchronise()

IMPORT_C void SetSynchronise(const TFolderSyncType aType);

Description

Sets the method for synchronising folder information with the server.

The default setting is EUseRemote.

Parameters

const TFolderSyncType aType

The folder synchronisation method.

See also:


Synchronise()

IMPORT_C TFolderSyncType Synchronise() const;

Description

Retrieves the method for synchronising folder information with the server.

The default setting is EUseRemote.

Return value

TFolderSyncType

The folder synchronisation method.

See also:


SetSubscribe()

IMPORT_C void SetSubscribe(const TFolderSubscribeType aType);

Description

Sets the method for synchronising IMAP4 subscription information with a server.

The default setting is EUpdateNeither.

Parameters

const TFolderSubscribeType aType

The subscription method.

See also:


Subscribe()

IMPORT_C TFolderSubscribeType Subscribe() const;

Description

Retrieves the configured method for synchronising IMAP4 subscription information with a server.

The default setting is EUpdateNeither.

Return value

TFolderSubscribeType

The subscription method.

See also:


AutoSendOnConnect()

IMPORT_C TBool AutoSendOnConnect() const;

Description

Return value

TBool

ETrue if configured to send emails after the connection is established, but before authentication with the IMAP4 server.


SetAutoSendOnConnect()

IMPORT_C void SetAutoSendOnConnect(TBool aFlag);

Description

Configures the IMAP4 service to send queued emails associated with the same internet access point to be sent first before logging onto the IMAP4 server.

The internet access point for each email service (POP3, IMAP4, SMTP) is configured using CImIAPPreferences.

Parameters

TBool aFlag

Specify ETrue to send emails after the connection is established, but before authentication with the IMAP4 service. Specify EFalse to disable this functionality.

See also:


MaxEmailSize()

IMPORT_C TUint MaxEmailSize() const;

Description

Returns the maximum message size in bytes to be downloaded.

This value is set by a calling SetMaxEmailSize(). The default setting is KMaxInt.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing get commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetMailInfo parameter, which has a iMaxEmailSize setting.

Return value

TUint

The maximum message size in bytes.

See also:


SetMaxEmailSize()

IMPORT_C void SetMaxEmailSize(const TUint aMaxEmailSize);

Description

Sets the maximum message size in bytes to be downloaded.

The default setting is KMaxInt.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing get commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetMailInfo parameter, which has a iMaxEmailSize setting.

Parameters

const TUint aMaxEmailSize

See also:


DeleteEmailsWhenDisconnecting()

IMPORT_C TBool DeleteEmailsWhenDisconnecting() const;

Description

Checks whether the caller has enabled messages marked to be deleted while offline to be expunged from the server when disconnecting from the next online session.

Otherwise they are marked for delete and expunged during the initial synchronisation.

To enable this functionality, call SetDeleteEmailsWhenDisconnecting().

Return value

TBool

ETrue if emails are to be deleted during the disconnection phase.

See also:


SetDeleteEmailsWhenDisconnecting()

IMPORT_C void SetDeleteEmailsWhenDisconnecting(TBool aFlag);

Description

If enabled, messages marked as deleted while offline will be deleted when logging off from the next IMAP4 session. If disabled, messages are deleted when the client synchronises with the server after a connection.

Enabling this functionality has the advantage of speeding up synchronisation at the expense of disconnection speed.

Parameters

TBool aFlag

Specify ETrue to enable.

See also:


AcknowledgeReceipts()

IMPORT_C TBool AcknowledgeReceipts() const;

Description

Checks whether the caller has enabled this setting by calling SetAcknowledgeReceipts().

This flag is a convenience setting for Messaging client applications that may wish to store whether or not to send a receipt email message to the sender when the email has been received. The Messaging subsystem does not use this setting, and has to be explicitly commanded by the Messaging client application to send a receipt notification. Messaging applications can use CImHeader to check if a message has a return receipt address. Receipt notification messages can be created using CImEmailOperation, and sent using the SMTP client MTM.

Return value

TBool

ETrue if this flag is set.

See also:


SetAcknowledgeReceipts()

IMPORT_C void SetAcknowledgeReceipts(TBool aFlag);

Description

Sets or resets a flag.

This flag is a convenience setting for Messaging client applications that may wish to store whether or not to send a receipt email message to the sender when the email has been received. The Messaging subsystem does not use this setting, and has to be explicitly commanded by the Messaging client application to send a receipt notification. Messaging applications can use CImHeader to check if a message has a return receipt address. Receipt notification messages can be created using CImEmailOperation, and sent using the SMTP client MTM.

Parameters

TBool aFlag

Specify ETrue to set this flag.

See also:


GetMailOptions()

IMPORT_C TImap4GetMailOptions GetMailOptions() const;

Description

Gets a preference setting for which components of a message (headers, body, attachments) to fetch when getting messages from a remote server.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing get commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetMailInfo parameter, which has a TImap4GetMailOptions setting.

The setting is specified using SetGetMailOptions().

Return value

TImap4GetMailOptions

Get mail message component preferences

See also:


SetGetMailOptions()

IMPORT_C void SetGetMailOptions(TImap4GetMailOptions aGetMailOptions);

Description

Sets a preference setting for which components of a message (headers, body, attachments) to fetch when getting messages from a remote server.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing get commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetMailInfo parameter, which has a TImap4GetMailOptions setting.

Parameters

TImap4GetMailOptions aGetMailOptions

Get mail message component preferences


CopyL()

IMPORT_C CImImap4Settings &CopyL(const CImImap4Settings &aCImImap4Settings);

Description

Copies the configuration settings from another IMAP4 settings object into this object.

Parameters

const CImImap4Settings &aCImImap4Settings

Specifies the object to copy.

Return value

CImImap4Settings &

This object after copying.


operator==()

IMPORT_C TBool operator==(const CImImap4Settings &aCImImap4Settings) const;

Description

Equality operator.

Parameters

const CImImap4Settings &aCImImap4Settings

Specifies the IMAP4 settings object to compare with.

Return value

TBool

ETrue if the settings are the same.


InboxSynchronisationLimit()

IMPORT_C TInt32 InboxSynchronisationLimit() const;

Description

Gets the maximum number of new messages in the Inbox that are synchronised when a synchronisation takes place.

This setting is configured by calling SetInboxSynchronisationLimit(). To configure limits for other folders, call SetMailboxSynchronisationLimit().

The default setting is to synchronise all messages in the Inbox folder.

Return value

TInt32

If -1, all emails will be synchronised; if zero, no emails will be synchronised; if positive, the return value is the maximum number of emails that will be synchronised.


SetInboxSynchronisationLimit()

IMPORT_C void SetInboxSynchronisationLimit(const TInt32 aInboxSyncLimit);

Description

Sets the maximum number of new messages in the Inbox that are synchronised when a synchronisation takes place.

The default setting is to synchronise all messages in the Inbox folder.

Parameters

const TInt32 aInboxSyncLimit


MailboxSynchronisationLimit()

IMPORT_C TInt32 MailboxSynchronisationLimit() const;

Description

Gets the maximum number of new messages, for folders other than the Inbox, that are synchronised when a synchronisation takes place.

This setting is configured by calling SetMailboxSynchronisationLimit(). To specify synchronisation limits for just the Inbox folder, call SetInboxSynchronisationLimit().

The default setting is to synchronise all messages.

Return value

TInt32

If -1, all emails will be synchronised; if zero, no emails will be synchronised; if positive, the return value is the maximum number of emails that will be synchronised.


SetMailboxSynchronisationLimit()

IMPORT_C void SetMailboxSynchronisationLimit(const TInt32 aMailboxSyncLimit);

Description

Sets the maximum number of new messages, for folders other than the Inbox, that are synchronised when a synchronisation takes place.

The default setting is to synchronise all messages.

Parameters

const TInt32 aMailboxSyncLimit


UpdatingSeenFlags()

IMPORT_C TBool UpdatingSeenFlags() const;

Description

Retrieves whether the IMAP4 seen flag of new messages will be set on the server only when the message has been marked as read, or when the message has been synchronised.

The default setting is EFalse which means that the seen flag will be set on the server when the new message has been synchronised with the client. The messaging application can mark the message as being read (seen) by calling TMsvEntry::SetUnread().

Return value

TBool

Returns ETrue if the seen flag is set on the IMAP4 server only when the message has been marked as read. Returns EFalse if the seen flag is set on the IMAP4 server when the new message is retrieved from the server.

See also:


SetUpdatingSeenFlags()

IMPORT_C void SetUpdatingSeenFlags(TBool aFlag);

Description

Specifies whether the IMAP4 seen flag of messages will be set on the server only when the message has been marked as read, or when the message has been synchronised.

The default setting is EFalse which means that the seen flag will be set on the server when the new message has been synchronised with the client. The messaging application can mark the message as being read (seen) by calling TMsvEntry::SetUnread().

Parameters

TBool aFlag

Specify ETrue if the seen flag is to be set on the IMAP4 server during synchronisation only when the message has been marked as read. Specify EFalse if the seen flag is to be set on the IMAP4 server when new messages are retrieved from the server.

See also:


SyncRate()

IMPORT_C TInt SyncRate() const;

Description

Retrieves the rate in seconds at which the Inbox is refreshed.

The default setting is 300 seconds (5 minutes).

This setting applies only when the KIMAP4MTMConnectAndSyncCompleteAfterDisconnect command is used to periodically resynchronise the Inbox.

Return value

TInt

The Inbox refresh rate in seconds. A value of zero indicates that the Inbox is not periodically refreshed (synchronised) when connected.


SetSyncRateL()

IMPORT_C void SetSyncRateL(TInt aSyncRate);

Description

Specifies the rate in seconds at which the Inbox will be refreshed when connected.

The default setting is 300 seconds (5 minutes).

This setting applies only when the KIMAP4MTMConnectAndSyncCompleteAfterDisconnect command is used to periodically resynchronise the Inbox.

Parameters

TInt aSyncRate

The Inbox refresh rate in seconds. A value of zero specifies that the Inbox will not periodically refresh (synchronise) when connected.


FetchSize()

IMPORT_C TUint FetchSize() const;

Description

Retrieves the IMAP fetch size.

When downloading large attachments, data is requested (fetched) in increments. The larger the fetch size, fewer fetch commands are sent to the IMAP4 server. This speeds up the attachment download rate, but only to a limit. The limit is network specific. A fetch size that is too large will degrade performance shortly after downloading an attachment is cancelled, because the fetched data will still be incomming on the socket after cancellation.

The default fetch size is 20480 bytes (20 KB). The default value is optimum for actual connection rates up to 2 Mbps.

Return value

TUint

The IMAP fetch size in bytes.


SetFetchSizeL()

IMPORT_C void SetFetchSizeL(TUint aFetchSizeBytes);

Description

Specifies the IMAP fetch size in bytes.

When downloading large attachments, data is requested (fetched) in increments. The larger the fetch size, fewer fetch commands are sent to the IMAP4 server. This speeds up the attachment download rate, but only to a limit. The limit is network specific. A fetch size that is too large will degrade performance shortly after downloading an attachment is cancelled, because the fetched data will still be incomming on the socket after cancellation.

The default fetch size is 20480 bytes (20 KB). The default value is optimum for actual connection rates up to 2 Mbps.

Parameters

TUint aFetchSizeBytes

The IMAP fetch size in bytes.


ImapIdle()

IMPORT_C TBool ImapIdle() const;

Description

Retrieves whether the IMAP IDLE command should be used as defined in RFC2177.

The default setting is ETrue which means that the IMAP IDLE command will be used if the server supports it.

Return value

TBool

Returns ETrue if the IMAP IDLE command should be used provided the server supports it. Returns EFalse if the IMAP IDLE command should not be used.


SetImapIdle()

IMPORT_C void SetImapIdle(TBool aFlag);

Description

Specifies whether the IMAP IDLE command should be used as defined in RFC2177.

The default setting is ETrue which means that the IMAP IDLE command will be used if the server supports it.

Parameters

TBool aFlag

Specify ETrue if the IMAP IDLE command should be used provided the server supports it. Specify EFalse if the IMAP IDLE command should not be used.


ImapIdleTimeout()

IMPORT_C TInt ImapIdleTimeout() const;

Description

Retrieves the IMAP IDLE timeout seconds.

The default setting is 1740 seconds (29 minutes).

Return value

TInt

The IMAP IDLE timeout in seconds. A value of zero specifies that the IDLE command will not timeout.


SetImapIdleTimeoutL()

IMPORT_C void SetImapIdleTimeoutL(TInt aIdleTimeout);

Description

Specifies the IMAP IDLE timeout in seconds.

The default setting is 1740 seconds (29 minutes).

Parameters

TInt aIdleTimeout

The IMAP IDLE timeout in seconds. A value of zero specifies that the IDLE command will not timeout.


PartialMailOptions()

IMPORT_C TImImap4PartialMailOptions PartialMailOptions() const;

Description

Gets the option for how

The specification can be as follows:

No limits on the body part, only body text, only attachments, the entire message (both body text and attachment) with size limits on body text and attachment the entire message with total size limit (ECumulative - body text + attachment <= total size limit) when synchronising with the IMAP4 server.

The specification for the body parts to be downloaded is set by SetPartialMailOptionsL().

Return value

TImImap4PartialMailOptions

An enumeration specifying how messages will be synchronised.

See also:


SetPartialMailOptionsL()

IMPORT_C void SetPartialMailOptionsL(TImImap4PartialMailOptions aPartialMailOptions);

Description

Specifies whether no limits on the body parts, only body text, only attachments, the entire message (both body text and attachment) with size limits on body text and attachment or the entire message with total size limit (ECumulative - body text + attachment <= Total size limit) will be downloaded when synchronising with the IMAP4 server.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing populate commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetPartialMailInfo parameter, which has a iPartialMailOptions setting.

Parameters

TImImap4PartialMailOptions aPartialMailOptions

Specifies whether to download whole message without limits, only body text, only attachments, entire message with body text limit and attachment size limit or the entire message with total size limit when synchronising with the IMAP4 server.

See also:


BodyTextSizeLimit()

IMPORT_C TInt32 BodyTextSizeLimit() const;

Description

Retrieves the maximum body text size limit for the partial fetch of message body. If text/plain part + text/html part (alternative part) < body text size limit then fetch text/html part else fetch only text/plain part.

The default body text size limit is KMaxTInt. The body text size limit is set by SetBodyTextSizeLimitL().

Return value

TInt32

The body text size limit for partial fetch of a message body text.


SetBodyTextSizeLimitL()

IMPORT_C void SetBodyTextSizeLimitL(TInt32 aBodyTextSizeLimit);

Description

Specifies the maximum body text size limit for the partial fetch of message body.

The default body text size limit is KMaxTInt.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing populate commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetPartialMailInfo parameter, which has a iBodyTextSizeLimit setting.

Parameters

TInt32 aBodyTextSizeLimit

The body text size limit for partial fetch of a message body text.


AttachmentSizeLimit()

IMPORT_C TInt32 AttachmentSizeLimit() const;

Description

Retrieves the maximum attachment size limit for the partial fetch of attachments in a message.

The default attachment size limit is KMaxTInt. The attachment size limit is set by SetAttachmentSizeLimitL().

Return value

TInt32

The maximum attachment size limit for the partial fetch of attachments in a message.


SetAttachmentSizeLimitL()

IMPORT_C void SetAttachmentSizeLimitL(TInt32 aAttachmentSizeLimit);

Description

Specifies the maximum attachment size limit for the partial fetch of attachments in a message.

The default attachment size limit is KMaxTInt.

Note that the value of this setting is not used by the IMAP MTM. It can be used by client applications to store a user preference, and used when issuing populate commands with CImap4ClientMtm::InvokeAsyncFunctionL(). Such commands take a TImImap4GetPartialMailInfo parameter, which has a iAttachmentSizeLimit setting.

Parameters

TInt32 aAttachmentSizeLimit

The maximum attachment size limit for the partial fetch of attachments in a message.


UseExpunge()

IMPORT_C TBool UseExpunge() const;

Description

Check whether the KImap4EmailExpungeFlag is set in CImImap4Settings

Return value

TBool

Returns ETrue if the KImap4EmailExpungeFlag was set in CImImap4Settings::SetUseExpunge.


SetUseExpunge()

IMPORT_C void SetUseExpunge(TBool aFlag);

Description

Allows KImap4EmailExpungeFlag to be set. It is used by the state machine in CImapCompoundCopyToLocal,CImapCompoundCopyWithinService, CImapCompoundDelete and CImapFolder. The state machines use the flag to decide whether to use EXPUNGE command to perform the deletion.

The settings are written to the central repository.

Parameters

TBool aFlag

Specify ETrue to enable EXPUNGE mode. Specify EFalse to disable EXPUNGE mode.