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.
Public Member Functions | |
---|---|
~CImIAPPreferences() | |
IMPORT_C void | AddIAPL(TImIAPChoice, TInt) |
IMPORT_C TInt | FindIAPL(TUint32, TInt &) |
IMPORT_C TImIAPChoice | IAPPreference(TInt) |
IMPORT_C CImIAPPreferences * | NewLC() |
IMPORT_C TInt | NumberOfIAPs() |
IMPORT_C void | RemoveIAPL(TInt) |
IMPORT_C void | RemoveSNAP() |
IMPORT_C void | ReplaceIAPL(TInt, TImIAPChoice) |
void | Reset() |
IMPORT_C TBool | SNAPDefined() |
IMPORT_C TUint32 | SNAPPreference() |
IMPORT_C void | SetSNAPL(TUint32) |
IMPORT_C TInt | Version() |
Private Member Functions | |
---|---|
CImIAPPreferences() | |
CImIAPPreferences(CImIAPPreferences &) | |
void | ConstructL() |
void | Panic(int) |
int | operator=(CImIAPPreferences &) |
Public Member Enumerations | |
---|---|
enum | anonymous { KSanityCheckOldWins = 0xEFBEADDE, KSanityCheck = 0xDEADBEEF } |
Public Attributes | |
---|---|
const TUid | KUidMsgFileInternetAccessPreferences |
Private Attributes | |
---|---|
CArrayFixFlat< TImIAPChoice > * | iChoices |
TUint32 | iSnapId |
TInt | iVersion |
CImIAPPreferences | ( | CImIAPPreferences & | aOther | ) | [private] |
CImIAPPreferences & aOther |
IMPORT_C void | AddIAPL | ( | TImIAPChoice | aIap, |
TInt | aIndex = 0 | |||
) |
TImIAPChoice aIap | |
TInt aIndex = 0 |
IMPORT_C TImIAPChoice | IAPPreference | ( | TInt | aPreference | ) | const |
TInt aPreference |
IMPORT_C void | ReplaceIAPL | ( | TInt | aPreferenceNumber, |
TImIAPChoice | aIap | |||
) |
TInt aPreferenceNumber | |
TImIAPChoice aIap |
int | operator= | ( | CImIAPPreferences & | aOther | ) | [private] |
CImIAPPreferences & aOther |
const TUid | KUidMsgFileInternetAccessPreferences | [static] |
ID of the stream used to store IAP preference information in a message store.