Symbian^3 Product Developer Library >

CImImap4Settings Class Reference

class CImImap4Settings : public CImBaseEmailSettings

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:

  • server log on settings (user name and password)

  • message header synchronisation strategy and synchronisation limits

  • message getting options, such as maximum size. Note that these options are not used by the IMAP MTM. They can be used by client applications to store user preferences, and be used by the client when issuing get commands.

  • miscelleanous settings, including whether IMAP IDLE should be used

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.

CEmailAccounts

Inherits from

Nested Classes and Structures

Public Member Functions
CImImap4Settings()
~CImImap4Settings()
IMPORT_C TBoolAcknowledgeReceipts()
IMPORT_C TInt32AttachmentSizeLimit()
IMPORT_C TBoolAutoSendOnConnect()
IMPORT_C TInt32BodyTextSizeLimit()
IMPORT_C CImImap4Settings &CopyL(const CImImap4Settings &)
IMPORT_C TBoolDeleteEmailsWhenDisconnecting()
IMPORT_C TBoolDisconnectedUserMode()
IMPORT_C TUintFetchSize()
IMPORT_C const TPtrC8FolderPath()
IMPORT_C TBoolFolderSyncDisabled()
IMPORT_C TImap4GetMailOptionsGetMailOptions()
IMPORT_C TBoolImapIdle()
IMPORT_C TIntImapIdleTimeout()
IMPORT_C TInt32InboxSynchronisationLimit()
IMPORT_C const TPtrC8LoginName()
IMPORT_C TInt32MailboxSynchronisationLimit()
IMPORT_C TUintMaxEmailSize()
IMPORT_C TImImap4PartialMailOptionsPartialMailOptions()
IMPORT_C const TPtrC8Password()
IMPORT_C TText8PathSeparator()
IMPORT_C voidReset()
IMPORT_C const TPtrC8SearchString()
IMPORT_C voidSetAcknowledgeReceipts(TBool)
IMPORT_C voidSetAttachmentSizeLimitL(TInt32)
IMPORT_C voidSetAutoSendOnConnect(TBool)
IMPORT_C voidSetBodyTextSizeLimitL(TInt32)
IMPORT_C voidSetDeleteEmailsWhenDisconnecting(TBool)
IMPORT_C voidSetDisconnectedUserMode(TBool)
IMPORT_C voidSetFetchSizeL(TUint)
IMPORT_C voidSetFolderPathL(const TDesC8 &)
IMPORT_C voidSetFolderSyncDisabled(TBool)
IMPORT_C voidSetGetMailOptions(TImap4GetMailOptions)
IMPORT_C voidSetImapIdle(TBool)
IMPORT_C voidSetImapIdleTimeoutL(TInt)
IMPORT_C voidSetInboxSynchronisationLimit(const TInt32)
IMPORT_C voidSetLoginNameL(const TDesC8 &)
IMPORT_C voidSetMailboxSynchronisationLimit(const TInt32)
IMPORT_C voidSetMaxEmailSize(const TUint)
IMPORT_C voidSetPartialMailOptionsL(TImImap4PartialMailOptions)
IMPORT_C voidSetPasswordL(const TDesC8 &)
IMPORT_C voidSetPathSeparator(const TText8)
IMPORT_C voidSetSearchStringL(const TDesC8 &)
IMPORT_C voidSetSubscribe(const TFolderSubscribeType)
IMPORT_C voidSetSyncRateL(TInt)
IMPORT_C voidSetSynchronise(const TFolderSyncType)
IMPORT_C voidSetTlsSslDomainL(const TDesC8 &)
IMPORT_C voidSetUpdatingSeenFlags(TBool)
IMPORT_C voidSetUseExpunge(TBool)
IMPORT_C voidSetUseSyncDownloadRules(TBool)
IMPORT_C TFolderSubscribeTypeSubscribe()
IMPORT_C TIntSyncRate()
IMPORT_C TFolderSyncTypeSynchronise()
IMPORT_C TPtrC8TlsSslDomain()
IMPORT_C TBoolUpdatingSeenFlags()
IMPORT_C TBoolUseExpunge()
IMPORT_C TBoolUseSyncDownloadRules()
IMPORT_C TBooloperator==(const CImImap4Settings &)
Private Member Functions
voidCheckExtensionExistsL()
TImImap4SettingsExtension *Extension()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CImBaseEmailSettings::BearerMobility()const
CImBaseEmailSettings::CImBaseEmailSettings()
CImBaseEmailSettings::CopyL(const CImBaseEmailSettings &)
CImBaseEmailSettings::Port()const
CImBaseEmailSettings::SSLWrapper()const
CImBaseEmailSettings::SecureSockets()const
CImBaseEmailSettings::ServerAddress()const
CImBaseEmailSettings::SetBearerMobility(TBool)
CImBaseEmailSettings::SetPort(const TUint)
CImBaseEmailSettings::SetSSLWrapper(TBool)
CImBaseEmailSettings::SetSecureSockets(TBool)
CImBaseEmailSettings::SetServerAddressL(const TDesC &)
CImBaseEmailSettings::SetSettingsFlags(TUint32)
CImBaseEmailSettings::SettingsFlags()const
CImBaseEmailSettings::operator==(const CImBaseEmailSettings &)const
CImBaseEmailSettings::~CImBaseEmailSettings()
Private Member Enumerations
enumTImImap4EmailSettings {
KImap4EmailSettingsClearFlag = 0x00000000, KImap4BaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag, KImap4EmailDisconnectedModeFlag = KImap4BaseEmailSettingsLastUsedFlag << 1, KImap4EmailAutoSendFlag = KImap4EmailDisconnectedModeFlag << 1, KImap4EmailDeleteEmailsWhenDisconnecting = KImap4EmailAutoSendFlag << 1, KImap4EmailAcknowledgeReceipts = KImap4EmailDeleteEmailsWhenDisconnecting << 1, KImap4EmailUpdatingSeenFlags = KImap4EmailAcknowledgeReceipts << 1, KImap4EmailIdleFlag = KImap4EmailUpdatingSeenFlags << 1, KImap4EmailExpungeFlag = KImap4EmailIdleFlag << 1, KImap4EmailUseSyncDownloadRules = KImap4EmailExpungeFlag << 1, KImap4EmailSettingsFolderSyncDisabled = KImap4EmailUseSyncDownloadRules << 1, KImap4EmailSettingsLastUsedFlag = KImap4EmailSettingsFolderSyncDisabled
}
Inherited Enumerations
CImBaseEmailSettings:TImBaseEmailSettings
Private Attributes
TImImap4SettingsExtension *iExtension
TImap4GetMailOptions iGetMailOptions
TInt32 iInboxSyncLimit
TInt32 iMailboxSyncLimit
TUint32 iMaxEmailSize
TText8 iPathSeparator
TFolderSubscribeType iSubscriptionStrategy
TFolderSyncType iSynchroniseStrategy
Inherited Attributes
CImBaseEmailSettings::iFlags
CImBaseEmailSettings::iPortNumber

Constructor & Destructor Documentation

CImImap4Settings()

IMPORT_CCImImap4Settings()

~CImImap4Settings()

IMPORT_C~CImImap4Settings()[virtual]

Member Functions Documentation

AcknowledgeReceipts()

IMPORT_C TBoolAcknowledgeReceipts()const

AttachmentSizeLimit()

IMPORT_C TInt32AttachmentSizeLimit()const

AutoSendOnConnect()

IMPORT_C TBoolAutoSendOnConnect()const

BodyTextSizeLimit()

IMPORT_C TInt32BodyTextSizeLimit()const

CheckExtensionExistsL()

voidCheckExtensionExistsL()[private, inline]

CopyL(const CImImap4Settings &)

IMPORT_C CImImap4Settings &CopyL(const CImImap4Settings &aCImImap4Settings)

Parameters

const CImImap4Settings & aCImImap4Settings

DeleteEmailsWhenDisconnecting()

IMPORT_C TBoolDeleteEmailsWhenDisconnecting()const

DisconnectedUserMode()

IMPORT_C TBoolDisconnectedUserMode()const

Extension()

TImImap4SettingsExtension *Extension()const [private, inline]

FetchSize()

IMPORT_C TUintFetchSize()const

FolderPath()

IMPORT_C const TPtrC8FolderPath()const

FolderSyncDisabled()

IMPORT_C TBoolFolderSyncDisabled()

GetMailOptions()

IMPORT_C TImap4GetMailOptionsGetMailOptions()const

ImapIdle()

IMPORT_C TBoolImapIdle()const

ImapIdleTimeout()

IMPORT_C TIntImapIdleTimeout()const

InboxSynchronisationLimit()

IMPORT_C TInt32InboxSynchronisationLimit()const

LoginName()

IMPORT_C const TPtrC8LoginName()const

MailboxSynchronisationLimit()

IMPORT_C TInt32MailboxSynchronisationLimit()const

MaxEmailSize()

IMPORT_C TUintMaxEmailSize()const

PartialMailOptions()

IMPORT_C TImImap4PartialMailOptionsPartialMailOptions()const

Password()

IMPORT_C const TPtrC8Password()const

PathSeparator()

IMPORT_C TText8PathSeparator()const

Reset()

IMPORT_C voidReset()

SearchString()

IMPORT_C const TPtrC8SearchString()const

SetAcknowledgeReceipts(TBool)

IMPORT_C voidSetAcknowledgeReceipts(TBoolaFlag)

Parameters

TBool aFlag

SetAttachmentSizeLimitL(TInt32)

IMPORT_C voidSetAttachmentSizeLimitL(TInt32aAttachmentSizeLimit)

Parameters

TInt32 aAttachmentSizeLimit

SetAutoSendOnConnect(TBool)

IMPORT_C voidSetAutoSendOnConnect(TBoolaFlag)

Parameters

TBool aFlag

SetBodyTextSizeLimitL(TInt32)

IMPORT_C voidSetBodyTextSizeLimitL(TInt32aBodyTextSizeLimit)

Parameters

TInt32 aBodyTextSizeLimit

SetDeleteEmailsWhenDisconnecting(TBool)

IMPORT_C voidSetDeleteEmailsWhenDisconnecting(TBoolaFlag)

Parameters

TBool aFlag

SetDisconnectedUserMode(TBool)

IMPORT_C voidSetDisconnectedUserMode(TBoolaFlag)

Parameters

TBool aFlag

SetFetchSizeL(TUint)

IMPORT_C voidSetFetchSizeL(TUintaFetchSizeBytes)

Parameters

TUint aFetchSizeBytes

SetFolderPathL(const TDesC8 &)

IMPORT_C voidSetFolderPathL(const TDesC8 &aFolderPath)

Parameters

const TDesC8 & aFolderPath

SetFolderSyncDisabled(TBool)

IMPORT_C voidSetFolderSyncDisabled(TBoolaFlag)

Parameters

TBool aFlag

SetGetMailOptions(TImap4GetMailOptions)

IMPORT_C voidSetGetMailOptions(TImap4GetMailOptionsaGetMailOptions)

Parameters

TImap4GetMailOptions aGetMailOptions

SetImapIdle(TBool)

IMPORT_C voidSetImapIdle(TBoolaFlag)

Parameters

TBool aFlag

SetImapIdleTimeoutL(TInt)

IMPORT_C voidSetImapIdleTimeoutL(TIntaIdleTimeout)

Parameters

TInt aIdleTimeout

SetInboxSynchronisationLimit(const TInt32)

IMPORT_C voidSetInboxSynchronisationLimit(const TInt32aInboxSyncLimit)

Parameters

const TInt32 aInboxSyncLimit

SetLoginNameL(const TDesC8 &)

IMPORT_C voidSetLoginNameL(const TDesC8 &aLoginName)

Parameters

const TDesC8 & aLoginName

SetMailboxSynchronisationLimit(const TInt32)

IMPORT_C voidSetMailboxSynchronisationLimit(const TInt32aMailboxSyncLimit)

Parameters

const TInt32 aMailboxSyncLimit

SetMaxEmailSize(const TUint)

IMPORT_C voidSetMaxEmailSize(const TUintaMaxEmailSize)

Parameters

const TUint aMaxEmailSize

SetPartialMailOptionsL(TImImap4PartialMailOptions)

IMPORT_C voidSetPartialMailOptionsL(TImImap4PartialMailOptionsaPartialMailOptions)

Parameters

TImImap4PartialMailOptions aPartialMailOptions

SetPasswordL(const TDesC8 &)

IMPORT_C voidSetPasswordL(const TDesC8 &aPassword)

Parameters

const TDesC8 & aPassword

SetPathSeparator(const TText8)

IMPORT_C voidSetPathSeparator(const TText8aPathSeparator)

Parameters

const TText8 aPathSeparator

SetSearchStringL(const TDesC8 &)

IMPORT_C voidSetSearchStringL(const TDesC8 &aSearchString)

Parameters

const TDesC8 & aSearchString

SetSubscribe(const TFolderSubscribeType)

IMPORT_C voidSetSubscribe(const TFolderSubscribeTypeaType)

Parameters

const TFolderSubscribeType aType

SetSyncRateL(TInt)

IMPORT_C voidSetSyncRateL(TIntaSyncRate)

Parameters

TInt aSyncRate

SetSynchronise(const TFolderSyncType)

IMPORT_C voidSetSynchronise(const TFolderSyncTypeaType)

Parameters

const TFolderSyncType aType

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C voidSetTlsSslDomainL(const TDesC8 &aDomainName)

Parameters

const TDesC8 & aDomainName

SetUpdatingSeenFlags(TBool)

IMPORT_C voidSetUpdatingSeenFlags(TBoolaFlag)

Parameters

TBool aFlag

SetUseExpunge(TBool)

IMPORT_C voidSetUseExpunge(TBoolaFlag)

Parameters

TBool aFlag

SetUseSyncDownloadRules(TBool)

IMPORT_C voidSetUseSyncDownloadRules(TBoolaFlag)

Parameters

TBool aFlag

Subscribe()

IMPORT_C TFolderSubscribeTypeSubscribe()const

SyncRate()

IMPORT_C TIntSyncRate()const

Synchronise()

IMPORT_C TFolderSyncTypeSynchronise()const

TlsSslDomain()

IMPORT_C TPtrC8TlsSslDomain()const

UpdatingSeenFlags()

IMPORT_C TBoolUpdatingSeenFlags()const

UseExpunge()

IMPORT_C TBoolUseExpunge()const

UseSyncDownloadRules()

IMPORT_C TBoolUseSyncDownloadRules()

operator==(const CImImap4Settings &)

IMPORT_C TBooloperator==(const CImImap4Settings &aCImImap4Settings)const

Parameters

const CImImap4Settings & aCImImap4Settings

Member Enumerations Documentation

Enum TImImap4EmailSettings

Enumerators

KImap4EmailSettingsClearFlag = 0x00000000
KImap4BaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag
KImap4EmailDisconnectedModeFlag = KImap4BaseEmailSettingsLastUsedFlag << 1
KImap4EmailAutoSendFlag = KImap4EmailDisconnectedModeFlag << 1
KImap4EmailDeleteEmailsWhenDisconnecting = KImap4EmailAutoSendFlag << 1
KImap4EmailAcknowledgeReceipts = KImap4EmailDeleteEmailsWhenDisconnecting << 1
KImap4EmailUpdatingSeenFlags = KImap4EmailAcknowledgeReceipts << 1
KImap4EmailIdleFlag = KImap4EmailUpdatingSeenFlags << 1
KImap4EmailExpungeFlag = KImap4EmailIdleFlag << 1
KImap4EmailUseSyncDownloadRules = KImap4EmailExpungeFlag << 1
KImap4EmailSettingsFolderSyncDisabled = KImap4EmailUseSyncDownloadRules << 1
KImap4EmailSettingsLastUsedFlag = KImap4EmailSettingsFolderSyncDisabled

Member Data Documentation

TImImap4SettingsExtension * iExtension

TImImap4SettingsExtension *iExtension[private]

TImap4GetMailOptions iGetMailOptions

TImap4GetMailOptions iGetMailOptions[private]

TInt32 iInboxSyncLimit

TInt32 iInboxSyncLimit[private]

TInt32 iMailboxSyncLimit

TInt32 iMailboxSyncLimit[private]

TUint32 iMaxEmailSize

TUint32 iMaxEmailSize[private]

TText8 iPathSeparator

TText8 iPathSeparator[private]

TFolderSubscribeType iSubscriptionStrategy

TFolderSubscribeType iSubscriptionStrategy[private]

TFolderSyncType iSynchroniseStrategy

TFolderSyncType iSynchroniseStrategy[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.