CImImap4Settings Class Reference

Retrieves the IMAP IDLE timeout seconds.

The default setting is 1740 seconds (29 minutes).

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.

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

See also: SetLoginNameL()

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.

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.

See also: TImImap4GetMailInfo CImImap4GetMail CImap4ClientMtm

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().

See also: TImImap4PartialMailOptions

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

See also: SetPasswordL()

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.

Resets the settings to their default values.

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

For details, see SetSearchStringL().

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.

See also: CImHeader CImEmailOperation CSmtpClientMtm

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.

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.

See also: CImIAPPreferences

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.

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.

See also: CImap4ClientMtm

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.

See also: CImap4ClientMtm

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.

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.

Sets a flag to indicate whether folder tree synchronisation shall be disabled, during account synchronisation operations.