Symbian^3 Application Developer Library >

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 TBool AcknowledgeReceipts ()
IMPORT_C TBool Apop ()
IMPORT_C TBool AutoSendOnConnect ()
IMPORT_C CImPop3Settings & CopyL (const CImPop3Settings &)
IMPORT_C TBool DeleteEmailsWhenDisconnecting ()
IMPORT_C TBool DisconnectedUserMode ()
IMPORT_C TPop3GetMailOptions GetMailOptions ()
IMPORT_C TInt32 InboxSynchronisationLimit ()
IMPORT_C const TPtrC8 LoginName ()
IMPORT_C TInt MaxEmailSize ()
IMPORT_C const TPtrC8 Password ()
IMPORT_C TInt32 PopulationLimit ()
IMPORT_C void Reset ()
IMPORT_C void SetAcknowledgeReceipts ( TBool )
IMPORT_C void SetApop ( TBool )
IMPORT_C void SetAutoSendOnConnect ( TBool )
IMPORT_C void SetDeleteEmailsWhenDisconnecting ( TBool )
IMPORT_C void SetDisconnectedUserMode ( TBool )
IMPORT_C void SetGetMailOptions ( TPop3GetMailOptions )
IMPORT_C void SetInboxSynchronisationLimit (const TInt32 )
IMPORT_C void SetLoginNameL (const TDesC8 &)
IMPORT_C void SetMaxEmailSize (const TInt )
IMPORT_C void SetPasswordL (const TDesC8 &)
IMPORT_C void SetPopulationLimitL (const TInt32 )
IMPORT_C void SetTlsSslDomainL (const TDesC8 &)
IMPORT_C TPtrC8 TlsSslDomain ()
IMPORT_C TBool operator== (const CImPop3Settings &)
Private Member Functions
void CheckExtensionExistsL ()
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
enum TImPop3EmailSettings {
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_C CImPop3Settings ( )

~CImPop3Settings()

IMPORT_C ~CImPop3Settings ( ) [virtual]

Member Functions Documentation

AcknowledgeReceipts()

IMPORT_C TBool AcknowledgeReceipts ( ) const

Apop()

IMPORT_C TBool Apop ( ) const

AutoSendOnConnect()

IMPORT_C TBool AutoSendOnConnect ( ) const

CheckExtensionExistsL()

void CheckExtensionExistsL ( ) [private, inline]

CopyL(const CImPop3Settings &)

IMPORT_C CImPop3Settings & CopyL ( const CImPop3Settings & aCImPop3Settings )

Parameters

const CImPop3Settings & aCImPop3Settings

DeleteEmailsWhenDisconnecting()

IMPORT_C TBool DeleteEmailsWhenDisconnecting ( ) const

DisconnectedUserMode()

IMPORT_C TBool DisconnectedUserMode ( ) const

Extension()

TImPop3SettingsExtension * Extension ( ) const [private, inline]

GetMailOptions()

IMPORT_C TPop3GetMailOptions GetMailOptions ( ) const

InboxSynchronisationLimit()

IMPORT_C TInt32 InboxSynchronisationLimit ( ) const

LoginName()

IMPORT_C const TPtrC8 LoginName ( ) const

MaxEmailSize()

IMPORT_C TInt MaxEmailSize ( ) const

Password()

IMPORT_C const TPtrC8 Password ( ) const

PopulationLimit()

IMPORT_C TInt32 PopulationLimit ( ) const

Reset()

IMPORT_C void Reset ( )

SetAcknowledgeReceipts(TBool)

IMPORT_C void SetAcknowledgeReceipts ( TBool aFlag )

Parameters

TBool aFlag

SetApop(TBool)

IMPORT_C void SetApop ( TBool aFlag )

Parameters

TBool aFlag

SetAutoSendOnConnect(TBool)

IMPORT_C void SetAutoSendOnConnect ( TBool aFlag )

Parameters

TBool aFlag

SetDeleteEmailsWhenDisconnecting(TBool)

IMPORT_C void SetDeleteEmailsWhenDisconnecting ( TBool aFlag )

Parameters

TBool aFlag

SetDisconnectedUserMode(TBool)

IMPORT_C void SetDisconnectedUserMode ( TBool aFlag )

Parameters

TBool aFlag

SetGetMailOptions(TPop3GetMailOptions)

IMPORT_C void SetGetMailOptions ( TPop3GetMailOptions aGetMailOptions )

Parameters

TPop3GetMailOptions aGetMailOptions

SetInboxSynchronisationLimit(const TInt32)

IMPORT_C void SetInboxSynchronisationLimit ( const TInt32 aInboxSyncLimit )

Parameters

const TInt32 aInboxSyncLimit

SetLoginNameL(const TDesC8 &)

IMPORT_C void SetLoginNameL ( const TDesC8 & )

Parameters

const TDesC8 &

SetMaxEmailSize(const TInt)

IMPORT_C void SetMaxEmailSize ( const TInt aMaxEmailSize )

Parameters

const TInt aMaxEmailSize

SetPasswordL(const TDesC8 &)

IMPORT_C void SetPasswordL ( const TDesC8 & )

Parameters

const TDesC8 &

SetPopulationLimitL(const TInt32)

IMPORT_C void SetPopulationLimitL ( const TInt32 aPopulationLimit )

Parameters

const TInt32 aPopulationLimit

SetTlsSslDomainL(const TDesC8 &)

IMPORT_C void SetTlsSslDomainL ( const TDesC8 & aDomainName )

Parameters

const TDesC8 & aDomainName

TlsSslDomain()

IMPORT_C TPtrC8 TlsSslDomain ( ) const

operator==(const CImPop3Settings &)

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

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.