Class CImPop3Settings

CImPop3Settings

Support

Supported from 5.0

Description

Encapsulates Email settings for a POP3 email account. Most of the settings are stored within the store associated with the POP3 service entry. This data specifies all of the session parameters used by the POP3 MTM when it connects to the service represented by this service entry, with the exception of the IAP which is stored in the TMsvEntry service entry itself.

Derivation

CImBaseEmailSettings Base class used in the derivation of CImPop3Settings CImPop3Settings Encapsulates Email settings for a POP3 email account

Defined in CImPop3Settings:
Apop(), AutoSendOnConnect(), LoginName(), Password(), Port(), Restore(), ServerAddress(), Store(), UserAddress(), Version()

ServerAddress()

Description

Returns the IP address of the POP3 server

Return value

TPtrC The IP address of the POP3 server; for example: pop3.demon.co.uk or 192.223.10.255

UserAddress()

Description

Not used by the POP3 MTM

Port()

Description

Returns the internet socket port number used to connect to the POP3 server.

Return value

TUint The internet socket port number used to connect to the POP3 server. By default, this is set to the standard port number for POP3 connections, i.e. 110.

Version()

Description

Returns the version number of the POP3 settings stream.

Return value

TUint16 Version number of this POP3 settings stream.

const TPtrC8 LoginName() const;

Description

Returns the POP3 user name.

Return value

TPtrC8 The POP3 user name

const TPtrC8 Password() const;

Description

Returns the POP3 password.

Return value

TPtrC8 The POP3 password

const TBool AutoSendOnConnect() const;

Description

Determines whether email associated with this service, (and hence all other POP3, SMTP and IMAP4 services which use the same IAP) should be automatically sent whenever a POP3 mail session starts.

Return value

TBool True, if email should be sent; false otherwise.

const TBool Apop() const;

Description

Determines whether the POP3 MTM connects to the POP3 server using plain text authentication or using the APOP encrypted authentication.

Return value

TBool True, if using APOP encrypted authentication. False, if using plain text authentication.

void RestoreL(CMsvStore& aMessageStore);

Description

Restores settings from the service entry store

Parameters

CMsvStore& aMessageStore The store holding the stream containing the settings.

void StoreL (CMsvStore& aMessageStore) const;

Description

Stores settings into the service entry store, overwriting any previous contents.

Parameters

CMsvStore& aMessageStore The store to hold the stream containing the settings.