CImPop3Settings Class Reference

class CImPop3Settings : public CImBaseEmailSettings

Run-time configuration settings for POP3.

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

Service settings such as the user name and password, whether to authenticate using APOP or plain text, the maximum size of an email to download, and the maximum number of messages to synchronise can be specified using this class. Storing and restoring from the message store is also supported.

To use this class to change a setting: 1) Set the current context to the POP3 service entry using CMsvStore. 2) Create an instance of CImPop3Settings and put it on the cleanup stack. 3) Retrieve the existing settings by calling CImPop3Settings::RestoreL(). 4) Change the inbox synchronisation limit setting by calling CImPop3Settings::SetInboxSynchronisationLimit(). 5) Save the new settings by calling CImPop3Settings::StoreL(). 6) Pop and destroy the CImPop3Settings instance.

CMsvStore

Inherits from

Nested Classes and Structures

Public Member Functions
CImPop3Settings()
~CImPop3Settings()
IMPORT_C TBoolAcknowledgeReceipts()
IMPORT_C TBoolApop()
IMPORT_C TBoolAutoSendOnConnect()
IMPORT_C CImPop3Settings &CopyL(const CImPop3Settings &)
IMPORT_C TBoolDeleteEmailsWhenDisconnecting()
IMPORT_C TBoolDisconnectedUserMode()
IMPORT_C TPop3GetMailOptionsGetMailOptions()
IMPORT_C TInt32InboxSynchronisationLimit()
IMPORT_C const TPtrC8LoginName()
IMPORT_C TIntMaxEmailSize()
IMPORT_C const TPtrC8Password()
IMPORT_C TInt32PopulationLimit()
IMPORT_C voidReset()
IMPORT_C voidSetAcknowledgeReceipts(TBool)
IMPORT_C voidSetApop(TBool)
IMPORT_C voidSetAutoSendOnConnect(TBool)
IMPORT_C voidSetDeleteEmailsWhenDisconnecting(TBool)
IMPORT_C voidSetDisconnectedUserMode(TBool)
IMPORT_C voidSetGetMailOptions(TPop3GetMailOptions)
IMPORT_C voidSetInboxSynchronisationLimit(const TInt32)
IMPORT_C voidSetLoginNameL(const TDesC8 &)
IMPORT_C voidSetMaxEmailSize(const TInt)
IMPORT_C voidSetPasswordL(const TDesC8 &)
IMPORT_C voidSetPopulationLimitL(const TInt32)
IMPORT_C voidSetTlsSslDomainL(const TDesC8 &)
IMPORT_C TPtrC8TlsSslDomain()
IMPORT_C TBooloperator==(const CImPop3Settings &)
Private Member Functions
voidCheckExtensionExistsL()
TImPop3SettingsExtension *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
enumTImPop3EmailSettings {
KPop3SettingsClearFlag = 0x00000000, KPop3BaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag, KPop3ApopFlag = KPop3BaseEmailSettingsLastUsedFlag << 1, KPop3AutoSendFlag = KPop3ApopFlag << 1, KPop3DisconnectedModeFlag = KPop3AutoSendFlag << 1, KPop3DeleteEmailsWhenDisconnectingFlag = KPop3DisconnectedModeFlag << 1, KPop3AcknowledgeReceipts = KPop3DeleteEmailsWhenDisconnectingFlag << 1, KPop3EmailSettingsLastUsedFlag = KPop3AcknowledgeReceipts
}
Inherited Enumerations
CImBaseEmailSettings:TImBaseEmailSettings
Private Attributes
TImPop3SettingsExtension *iExtension
TPop3GetMailOptions iGetMailOptions
TInt32 iInboxSyncLimit
TInt32 iMaxEmailSize
Inherited Attributes
CImBaseEmailSettings::iFlags
CImBaseEmailSettings::iPortNumber

Constructor & Destructor Documentation

CImPop3Settings()

IMPORT_CCImPop3Settings()

~CImPop3Settings()

IMPORT_C~CImPop3Settings()[virtual]

Member Functions Documentation

AcknowledgeReceipts()

IMPORT_C TBoolAcknowledgeReceipts()const

Apop()

IMPORT_C TBoolApop()const

AutoSendOnConnect()

IMPORT_C TBoolAutoSendOnConnect()const

CheckExtensionExistsL()

voidCheckExtensionExistsL()[private, inline]

CopyL(const CImPop3Settings &)

IMPORT_C CImPop3Settings &CopyL(const CImPop3Settings &aCImPop3Settings)

Parameters

const CImPop3Settings & aCImPop3Settings

DeleteEmailsWhenDisconnecting()

IMPORT_C TBoolDeleteEmailsWhenDisconnecting()const

DisconnectedUserMode()

IMPORT_C TBoolDisconnectedUserMode()const

Extension()

TImPop3SettingsExtension *Extension()const [private, inline]

GetMailOptions()

IMPORT_C TPop3GetMailOptionsGetMailOptions()const

InboxSynchronisationLimit()

IMPORT_C TInt32InboxSynchronisationLimit()const

LoginName()

IMPORT_C const TPtrC8LoginName()const

MaxEmailSize()

IMPORT_C TIntMaxEmailSize()const

Password()

IMPORT_C const TPtrC8Password()const

PopulationLimit()

IMPORT_C TInt32PopulationLimit()const

Reset()

IMPORT_C voidReset()

SetAcknowledgeReceipts(TBool)

IMPORT_C voidSetAcknowledgeReceipts(TBoolaFlag)

Parameters

TBool aFlag

SetApop(TBool)

IMPORT_C voidSetApop(TBoolaFlag)

Parameters

TBool aFlag

SetAutoSendOnConnect(TBool)

IMPORT_C voidSetAutoSendOnConnect(TBoolaFlag)

Parameters

TBool aFlag

SetDeleteEmailsWhenDisconnecting(TBool)

IMPORT_C voidSetDeleteEmailsWhenDisconnecting(TBoolaFlag)

Parameters

TBool aFlag

SetDisconnectedUserMode(TBool)

IMPORT_C voidSetDisconnectedUserMode(TBoolaFlag)

Parameters

TBool aFlag

SetGetMailOptions(TPop3GetMailOptions)

IMPORT_C voidSetGetMailOptions(TPop3GetMailOptionsaGetMailOptions)

Parameters

TPop3GetMailOptions aGetMailOptions

SetInboxSynchronisationLimit(const TInt32)

IMPORT_C voidSetInboxSynchronisationLimit(const TInt32aInboxSyncLimit)

Parameters

const TInt32 aInboxSyncLimit

SetLoginNameL(const TDesC8 &)

IMPORT_C voidSetLoginNameL(const TDesC8 &)

Parameters

const TDesC8 &

SetMaxEmailSize(const TInt)

IMPORT_C voidSetMaxEmailSize(const TIntaMaxEmailSize)

Parameters

const TInt aMaxEmailSize

SetPasswordL(const TDesC8 &)

IMPORT_C voidSetPasswordL(const TDesC8 &)

Parameters

const TDesC8 &

SetPopulationLimitL(const TInt32)

IMPORT_C voidSetPopulationLimitL(const TInt32aPopulationLimit)

Parameters

const TInt32 aPopulationLimit

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C voidSetTlsSslDomainL(const TDesC8 &aDomainName)

Parameters

const TDesC8 & aDomainName

TlsSslDomain()

IMPORT_C TPtrC8TlsSslDomain()const

operator==(const CImPop3Settings &)

IMPORT_C TBooloperator==(const CImPop3Settings &aCImPop3Settings)const

Parameters

const CImPop3Settings & aCImPop3Settings

Member Enumerations Documentation

Enum TImPop3EmailSettings

Enumerators

KPop3SettingsClearFlag = 0x00000000
KPop3BaseEmailSettingsLastUsedFlag = CImBaseEmailSettings::EBaseEmailSettingsLastUsedFlag
KPop3ApopFlag = KPop3BaseEmailSettingsLastUsedFlag << 1
KPop3AutoSendFlag = KPop3ApopFlag << 1
KPop3DisconnectedModeFlag = KPop3AutoSendFlag << 1
KPop3DeleteEmailsWhenDisconnectingFlag = KPop3DisconnectedModeFlag << 1
KPop3AcknowledgeReceipts = KPop3DeleteEmailsWhenDisconnectingFlag << 1
KPop3EmailSettingsLastUsedFlag = KPop3AcknowledgeReceipts

Member Data Documentation

TImPop3SettingsExtension * iExtension

TImPop3SettingsExtension *iExtension[private]

TPop3GetMailOptions iGetMailOptions

TPop3GetMailOptions iGetMailOptions[private]

TInt32 iInboxSyncLimit

TInt32 iInboxSyncLimit[private]

TInt32 iMaxEmailSize

TInt32 iMaxEmailSize[private]
© Nokia 2010.