CImIAPPreferences Class Reference

class CImIAPPreferences : public CBase

Encapsulates preferences relating to IAPs for an email service.

An IAP defines all of the variable factors that determine how an Internet connection is made. These variable factors can include the bearer (CDMA, GSM or GPRS), dial-in number. network login names and passwords.

The Comms Database is capable of storing details of several IAPs, which can then be used to initiate different types of connection. The database also stores the preference order of the IAPs: this defines which IAP should be used as the first choice, and also an optional second choice to be used if the first choice is not available.

The CImIAPPreferences class associates a first choice, and optionally a second choice IAP to use with a particular email service. The preference object is stored in the service entry's message store.

For SMTP, if no object has been stored in the service, then the SMTP client will attempt to use any default Internet settings in the Comms Database, or will use the existing Internet connection if one does already exist. Note that SMTP sessions will normally fail to send any email messages if the SMTP session is not created using an IAP which the SMTP server does not accept.

Note that in Symbian OS v6.0 a single IAP was associated with an email service entry through the iMtmData1 field.

Inherits from

Constructor & Destructor Documentation

CImIAPPreferences()

CImIAPPreferences()[private]

CImIAPPreferences(CImIAPPreferences &)

CImIAPPreferences(CImIAPPreferences &aOther)[private]

Parameters

CImIAPPreferences & aOther

~CImIAPPreferences()

IMPORT_C~CImIAPPreferences()

Member Functions Documentation

AddIAPL(TImIAPChoice, TInt)

IMPORT_C voidAddIAPL(TImIAPChoiceaIap,
TIntaIndex = 0
)

Parameters

TImIAPChoice aIap
TInt aIndex = 0

ConstructL()

voidConstructL()[private]

FindIAPL(TUint32, TInt &)

IMPORT_C TIntFindIAPL(TUint32aIAP,
TInt &aLocation
)const

Parameters

TUint32 aIAP
TInt & aLocation

IAPPreference(TInt)

IMPORT_C TImIAPChoiceIAPPreference(TIntaPreference)const

Parameters

TInt aPreference

NewLC()

IMPORT_C CImIAPPreferences *NewLC()[static]

NumberOfIAPs()

IMPORT_C TIntNumberOfIAPs()const

Panic(int)

voidPanic(interr)const [private]

Parameters

int err

RemoveIAPL(TInt)

IMPORT_C voidRemoveIAPL(TIntaPreferenceNumber)

Parameters

TInt aPreferenceNumber

RemoveSNAP()

IMPORT_C voidRemoveSNAP()

ReplaceIAPL(TInt, TImIAPChoice)

IMPORT_C voidReplaceIAPL(TIntaPreferenceNumber,
TImIAPChoiceaIap
)

Parameters

TInt aPreferenceNumber
TImIAPChoice aIap

Reset()

voidReset()

SNAPDefined()

IMPORT_C TBoolSNAPDefined()const

SNAPPreference()

IMPORT_C TUint32SNAPPreference()const

SetSNAPL(TUint32)

IMPORT_C voidSetSNAPL(TUint32aSnap)

Parameters

TUint32 aSnap

Version()

IMPORT_C TIntVersion()const

operator=(CImIAPPreferences &)

intoperator=(CImIAPPreferences &aOther)[private]

Parameters

CImIAPPreferences & aOther

Member Enumerations Documentation

Enum anonymous

Enumerators

KSanityCheckOldWins = 0xEFBEADDE
KSanityCheck = 0xDEADBEEF

Member Data Documentation

const TUid KUidMsgFileInternetAccessPreferences

const TUidKUidMsgFileInternetAccessPreferences[static]

ID of the stream used to store IAP preference information in a message store.

CArrayFixFlat< TImIAPChoice > * iChoices

CArrayFixFlat< TImIAPChoice > *iChoices[private]

TUint32 iSnapId

TUint32 iSnapId[private]

TInt iVersion

TInt iVersion[private]