Symbian^3 Application 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 TBool AcknowledgeReceipts ()
IMPORT_C TInt32 AttachmentSizeLimit ()
IMPORT_C TBool AutoSendOnConnect ()
IMPORT_C TInt32 BodyTextSizeLimit ()
IMPORT_C CImImap4Settings & CopyL (const CImImap4Settings &)
IMPORT_C TBool DeleteEmailsWhenDisconnecting ()
IMPORT_C TBool DisconnectedUserMode ()
IMPORT_C TUint FetchSize ()
IMPORT_C const TPtrC8 FolderPath ()
IMPORT_C TBool FolderSyncDisabled ()
IMPORT_C TImap4GetMailOptions GetMailOptions ()
IMPORT_C TBool ImapIdle ()
IMPORT_C TInt ImapIdleTimeout ()
IMPORT_C TInt32 InboxSynchronisationLimit ()
IMPORT_C const TPtrC8 LoginName ()
IMPORT_C TInt32 MailboxSynchronisationLimit ()
IMPORT_C TUint MaxEmailSize ()
IMPORT_C TImImap4PartialMailOptions PartialMailOptions ()
IMPORT_C const TPtrC8 Password ()
IMPORT_C TText8 PathSeparator ()
IMPORT_C void Reset ()
IMPORT_C const TPtrC8 SearchString ()
IMPORT_C void SetAcknowledgeReceipts ( TBool )
IMPORT_C void SetAttachmentSizeLimitL ( TInt32 )
IMPORT_C void SetAutoSendOnConnect ( TBool )
IMPORT_C void SetBodyTextSizeLimitL ( TInt32 )
IMPORT_C void SetDeleteEmailsWhenDisconnecting ( TBool )
IMPORT_C void SetDisconnectedUserMode ( TBool )
IMPORT_C void SetFetchSizeL ( TUint )
IMPORT_C void SetFolderPathL (const TDesC8 &)
IMPORT_C void SetFolderSyncDisabled ( TBool )
IMPORT_C void SetGetMailOptions ( TImap4GetMailOptions )
IMPORT_C void SetImapIdle ( TBool )
IMPORT_C void SetImapIdleTimeoutL ( TInt )
IMPORT_C void SetInboxSynchronisationLimit (const TInt32 )
IMPORT_C void SetLoginNameL (const TDesC8 &)
IMPORT_C void SetMailboxSynchronisationLimit (const TInt32 )
IMPORT_C void SetMaxEmailSize (const TUint )
IMPORT_C void SetPartialMailOptionsL ( TImImap4PartialMailOptions )
IMPORT_C void SetPasswordL (const TDesC8 &)
IMPORT_C void SetPathSeparator (const TText8 )
IMPORT_C void SetSearchStringL (const TDesC8 &)
IMPORT_C void SetSubscribe (const TFolderSubscribeType )
IMPORT_C void SetSyncRateL ( TInt )
IMPORT_C void SetSynchronise (const TFolderSyncType )
IMPORT_C void SetTlsSslDomainL (const TDesC8 &)
IMPORT_C void SetUpdatingSeenFlags ( TBool )
IMPORT_C void SetUseExpunge ( TBool )
IMPORT_C void SetUseSyncDownloadRules ( TBool )
IMPORT_C TFolderSubscribeType Subscribe ()
IMPORT_C TInt SyncRate ()
IMPORT_C TFolderSyncType Synchronise ()
IMPORT_C TPtrC8 TlsSslDomain ()
IMPORT_C TBool UpdatingSeenFlags ()
IMPORT_C TBool UseExpunge ()
IMPORT_C TBool UseSyncDownloadRules ()
IMPORT_C TBool operator== (const CImImap4Settings &)
Private Member Functions
void CheckExtensionExistsL ()
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
enum TImImap4EmailSettings {
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_C CImImap4Settings ( )

~CImImap4Settings()

IMPORT_C ~CImImap4Settings ( ) [virtual]

Member Functions Documentation

AcknowledgeReceipts()

IMPORT_C TBool AcknowledgeReceipts ( ) const

AttachmentSizeLimit()

IMPORT_C TInt32 AttachmentSizeLimit ( ) const

AutoSendOnConnect()

IMPORT_C TBool AutoSendOnConnect ( ) const

BodyTextSizeLimit()

IMPORT_C TInt32 BodyTextSizeLimit ( ) const

CheckExtensionExistsL()

void CheckExtensionExistsL ( ) [private, inline]

CopyL(const CImImap4Settings &)

IMPORT_C CImImap4Settings & CopyL ( const CImImap4Settings & aCImImap4Settings )

Parameters

const CImImap4Settings & aCImImap4Settings

DeleteEmailsWhenDisconnecting()

IMPORT_C TBool DeleteEmailsWhenDisconnecting ( ) const

DisconnectedUserMode()

IMPORT_C TBool DisconnectedUserMode ( ) const

Extension()

TImImap4SettingsExtension * Extension ( ) const [private, inline]

FetchSize()

IMPORT_C TUint FetchSize ( ) const

FolderPath()

IMPORT_C const TPtrC8 FolderPath ( ) const

FolderSyncDisabled()

IMPORT_C TBool FolderSyncDisabled ( )

GetMailOptions()

IMPORT_C TImap4GetMailOptions GetMailOptions ( ) const

ImapIdle()

IMPORT_C TBool ImapIdle ( ) const

ImapIdleTimeout()

IMPORT_C TInt ImapIdleTimeout ( ) const

InboxSynchronisationLimit()

IMPORT_C TInt32 InboxSynchronisationLimit ( ) const

LoginName()

IMPORT_C const TPtrC8 LoginName ( ) const

MailboxSynchronisationLimit()

IMPORT_C TInt32 MailboxSynchronisationLimit ( ) const

MaxEmailSize()

IMPORT_C TUint MaxEmailSize ( ) const

PartialMailOptions()

IMPORT_C TImImap4PartialMailOptions PartialMailOptions ( ) const

Password()

IMPORT_C const TPtrC8 Password ( ) const

PathSeparator()

IMPORT_C TText8 PathSeparator ( ) const

Reset()

IMPORT_C void Reset ( )

SearchString()

IMPORT_C const TPtrC8 SearchString ( ) const

SetAcknowledgeReceipts(TBool)

IMPORT_C void SetAcknowledgeReceipts ( TBool aFlag )

Parameters

TBool aFlag

SetAttachmentSizeLimitL(TInt32)

IMPORT_C void SetAttachmentSizeLimitL ( TInt32 aAttachmentSizeLimit )

Parameters

TInt32 aAttachmentSizeLimit

SetAutoSendOnConnect(TBool)

IMPORT_C void SetAutoSendOnConnect ( TBool aFlag )

Parameters

TBool aFlag

SetBodyTextSizeLimitL(TInt32)

IMPORT_C void SetBodyTextSizeLimitL ( TInt32 aBodyTextSizeLimit )

Parameters

TInt32 aBodyTextSizeLimit

SetDeleteEmailsWhenDisconnecting(TBool)

IMPORT_C void SetDeleteEmailsWhenDisconnecting ( TBool aFlag )

Parameters

TBool aFlag

SetDisconnectedUserMode(TBool)

IMPORT_C void SetDisconnectedUserMode ( TBool aFlag )

Parameters

TBool aFlag

SetFetchSizeL(TUint)

IMPORT_C void SetFetchSizeL ( TUint aFetchSizeBytes )

Parameters

TUint aFetchSizeBytes

SetFolderPathL(const TDesC8 &)

IMPORT_C void SetFolderPathL ( const TDesC8 & aFolderPath )

Parameters

const TDesC8 & aFolderPath

SetFolderSyncDisabled(TBool)

IMPORT_C void SetFolderSyncDisabled ( TBool aFlag )

Parameters

TBool aFlag

SetGetMailOptions(TImap4GetMailOptions)

IMPORT_C void SetGetMailOptions ( TImap4GetMailOptions aGetMailOptions )

Parameters

TImap4GetMailOptions aGetMailOptions

SetImapIdle(TBool)

IMPORT_C void SetImapIdle ( TBool aFlag )

Parameters

TBool aFlag

SetImapIdleTimeoutL(TInt)

IMPORT_C void SetImapIdleTimeoutL ( TInt aIdleTimeout )

Parameters

TInt aIdleTimeout

SetInboxSynchronisationLimit(const TInt32)

IMPORT_C void SetInboxSynchronisationLimit ( const TInt32 aInboxSyncLimit )

Parameters

const TInt32 aInboxSyncLimit

SetLoginNameL(const TDesC8 &)

IMPORT_C void SetLoginNameL ( const TDesC8 & aLoginName )

Parameters

const TDesC8 & aLoginName

SetMailboxSynchronisationLimit(const TInt32)

IMPORT_C void SetMailboxSynchronisationLimit ( const TInt32 aMailboxSyncLimit )

Parameters

const TInt32 aMailboxSyncLimit

SetMaxEmailSize(const TUint)

IMPORT_C void SetMaxEmailSize ( const TUint aMaxEmailSize )

Parameters

const TUint aMaxEmailSize

SetPartialMailOptionsL(TImImap4PartialMailOptions)

IMPORT_C void SetPartialMailOptionsL ( TImImap4PartialMailOptions aPartialMailOptions )

Parameters

TImImap4PartialMailOptions aPartialMailOptions

SetPasswordL(const TDesC8 &)

IMPORT_C void SetPasswordL ( const TDesC8 & aPassword )

Parameters

const TDesC8 & aPassword

SetPathSeparator(const TText8)

IMPORT_C void SetPathSeparator ( const TText8 aPathSeparator )

Parameters

const TText8 aPathSeparator

SetSearchStringL(const TDesC8 &)

IMPORT_C void SetSearchStringL ( const TDesC8 & aSearchString )

Parameters

const TDesC8 & aSearchString

SetSubscribe(const TFolderSubscribeType)

IMPORT_C void SetSubscribe ( const TFolderSubscribeType aType )

Parameters

const TFolderSubscribeType aType

SetSyncRateL(TInt)

IMPORT_C void SetSyncRateL ( TInt aSyncRate )

Parameters

TInt aSyncRate

SetSynchronise(const TFolderSyncType)

IMPORT_C void SetSynchronise ( const TFolderSyncType aType )

Parameters

const TFolderSyncType aType

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C void SetTlsSslDomainL ( const TDesC8 & aDomainName )

Parameters

const TDesC8 & aDomainName

SetUpdatingSeenFlags(TBool)

IMPORT_C void SetUpdatingSeenFlags ( TBool aFlag )

Parameters

TBool aFlag

SetUseExpunge(TBool)

IMPORT_C void SetUseExpunge ( TBool aFlag )

Parameters

TBool aFlag

SetUseSyncDownloadRules(TBool)

IMPORT_C void SetUseSyncDownloadRules ( TBool aFlag )

Parameters

TBool aFlag

Subscribe()

IMPORT_C TFolderSubscribeType Subscribe ( ) const

SyncRate()

IMPORT_C TInt SyncRate ( ) const

Synchronise()

IMPORT_C TFolderSyncType Synchronise ( ) const

TlsSslDomain()

IMPORT_C TPtrC8 TlsSslDomain ( ) const

UpdatingSeenFlags()

IMPORT_C TBool UpdatingSeenFlags ( ) const

UseExpunge()

IMPORT_C TBool UseExpunge ( ) const

UseSyncDownloadRules()

IMPORT_C TBool UseSyncDownloadRules ( )

operator==(const CImImap4Settings &)

IMPORT_C TBool operator== ( 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.