Class CImPop3Settings

class CImPop3Settings : public CImBaseEmailSettings;

Description

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(const TInt32). 5) Save the new settings by calling CImPop3Settings::StoreL(). 6) Pop and destroy the CImPop3Settings instance.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CImBaseEmailSettings - Parent class for CImPop3Settings, CImImap4Settings, CImSmtpSettings.

• CImPop3Settings - Run-time configuration settings for POP3.

Members

Defined in CImPop3Settings:

• AcknowledgeReceipts()constChecks whether the caller has enabled this setting by calling CImPop3Settings::S...
• Apop()constChecks whether the POP3 service is configured to log on using plain text authent...
• AutoSendOnConnect()constChecks whether queued emails associated with the same internet access point as t...
• CImPop3Settings()Allocates and creates a new CImPop3Settings object initialised to default values...
• CopyL(const CImPop3Settings &)Copies the configuration settings from another POP3 settings object into this ob...
• DeleteEmailsWhenDisconnecting()constChecks whether the caller has enabled this setting by calling CImPop3Settings::S...
• DisconnectedUserMode()constChecks if disconnected user mode is configured.
• GetMailOptions()constRetrieves an enumeration that specifies whether only the messages headers or the...
• InboxSynchronisationLimit()constReturns whether or not the POP3 service will synchronise with all emails on the ...
• LoginName()constRetrieves the configured login user name (mailbox) of the POP3 service.
• MaxEmailSize()constReturns the maximum message size in bytes to be downloaded. This value is set by...
• Password()constRetrieves the configured plain text login password that will be sent to the POP3...
• PopulationLimit()constRetrieves the currently stored TOP population limit from settings. If this is se...
• Reset()Resets the settings to their default values.
• SetAcknowledgeReceipts(TBool)Sets or resets a flag.
• SetApop(TBool)Configures the POP3 service to authenticate using either a plain text password o...
• SetAutoSendOnConnect(TBool)Configures the POP3 service to send queued emails associated with the same inter...
• SetDeleteEmailsWhenDisconnecting(TBool)Sets or resets a flag.
• SetDisconnectedUserMode(TBool)Enables the POP3 client MTM (CPop3ClientMtm) to accept message operations while ...
• SetGetMailOptions(TPop3GetMailOptions)Specifies whether to download headers only, or entire messages when synchronisin...
• SetInboxSynchronisationLimit(const TInt32)Specifies whether or not the POP3 service will synchronise with all emails on th...
• SetLoginNameL(const TDesC8 &)Configures the login user name (mailbox) for the POP3 service.
• SetMaxEmailSize(const TInt)Sets the maximum message size in bytes to be downloaded.
• SetPasswordL(const TDesC8 &)Configures the login password for the POP3 service. The plain text password will...
• SetPopulationLimitL(const TInt32)Sets the currently stored TOP population limit to settings. If this is set, it d...
• SetTlsSslDomainL(const TDesC8 &)Sets the domain name to use during TLS/SSL certificate validation.
• TlsSslDomain()constGets the domain name used during TLS/SSL certificate validation.
• operator==(const CImPop3Settings &)constEquality operator.
• ~CImPop3Settings()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CImBaseEmailSettings:

• EBaseEmailSettingsBearerMobFlag
• EBaseEmailSettingsClearFlag
• EBaseEmailSettingsLastUsedFlag
• EBaseEmailSettingsSSLWrappedSockets
• EBaseEmailSettingsSecureSockets
• Port()constRetrieves the port number of an email server when establishing a TCP connection....
• SSLWrapper()constWhether secure sockets will be used.
• SecureSockets()constRetrieves whether a secure TLS connection will be negotiated over an unsecure TC...
• ServerAddress()constRetrieves the configured IP address or host name of the email server. The IP add...
• SetPort(const TUint)Configures the port number of an email server when establishing a TCP connection...
• SetSSLWrapper(TBool)Specifies whether a secure TLS connection will be established directly over a TL...
• SetSecureSockets(TBool)Sets whether a secure TLS connection will be negotiated over an unsecure socket ...
• SetServerAddressL(const TDesC &)If an instance of this class is of type CImPop3Settings or CImImap4Settings, the...
• TImBaseEmailSettings
• iFlags
• iPortNumber

See also:

• CMsvStoreProvides an interface over the message store that is associated with a message e...

IMPORT_C CImPop3Settings();

Description

Allocates and creates a new CImPop3Settings object initialised to default values.

IMPORT_C virtual ~CImPop3Settings();

Description

Destructor.

IMPORT_C void Reset();

Description

Resets the settings to their default values.

IMPORT_C const TPtrC8 LoginName() const;

Description

Retrieves the configured login user name (mailbox) of the POP3 service.

Return value

See also:

• CImPop3Settings::SetLoginNameL(const TDesC8 &)Configures the login user name (mailbox) for the POP3 service.

IMPORT_C void SetLoginNameL(const TDesC8 &);

Description

Configures the login user name (mailbox) for the POP3 service.

Parameters

IMPORT_C const TPtrC8 Password() const;

Description

Retrieves the configured plain text login password that will be sent to the POP3 server if APOP is not configured.

Return value

See also:

• CImPop3Settings::SetPasswordL(const TDesC8 &)Configures the login password for the POP3 service. The plain text password will...

IMPORT_C void SetPasswordL(const TDesC8 &);

Description

Configures the login password for the POP3 service. The plain text password will be sent during authentication with the POP3 server. It can also be used to store the shared secret when authenticating using APOP if CImPop3Settings::SetApop(TBool) is enabled.

Parameters

IMPORT_C TBool AutoSendOnConnect() const;

Description

Checks whether queued emails associated with the same internet access point as the POP3 service will be sent first before logging onto the POP3 server. The internet access point for each email service (POP3, IMAP4, SMTP) is configured using CImIAPPreferences.

Return value

See also:

• CImIAPPreferencesEncapsulates preferences relating to IAPs for an email service.

IMPORT_C void SetAutoSendOnConnect(TBool aFlag);

Description

Configures the POP3 service to send queued emails associated with the same internet access point to be sent first before logging onto the POP3 server.

The internet access point for each email service (POP3, IMAP4, SMTP) is configured using CImIAPPreferences.

Parameters

See also:

• CImIAPPreferencesEncapsulates preferences relating to IAPs for an email service.

IMPORT_C TBool Apop() const;

Description

Checks whether the POP3 service is configured to log on using plain text authentication or APOP encrypted authentication.

The default setting is EFalse.

Return value

See also:

• CImPop3Settings::SetApop(TBool)Configures the POP3 service to authenticate using either a plain text password o...

IMPORT_C void SetApop(TBool aFlag);

Description

Configures the POP3 service to authenticate using either a plain text password or an APOP encrypted digest.

If configured to use APOP authentication, the configured password set by the call to CImPop3Settings::SetPasswordL(const TDesC8 &) is used to store the shared secret between the server and the POP3 service. The timestamp sent in the servers' hello banner and the password are joined and encrypted into a digest before being sent using the MD5 algorithm.

The default setting is EFalse.

Parameters

IMPORT_C TBool DisconnectedUserMode() const;

Description

Checks if disconnected user mode is configured.

If disconnected user mode is enabled by calling CImPop3Settings::SetDisconnectedUserMode(TBool), then the POP3 client MTM (CPop3ClientMtm) will accept message operations, such as deleting messages from a server, while the user is offline. The operations are stored and executed when the user connects again.

Return value

See also:

• CPop3ClientMtmPOP3 client MTM interface.

IMPORT_C void SetDisconnectedUserMode(TBool aFlag);

Description

Enables the POP3 client MTM (CPop3ClientMtm) to accept message operations while disconnected.

If disconnected user mode is enabled the POP3 client MTM will accept message operations such as deleting messages from a server, while the user is offline. The operations are stored and executed when the user connects again.

Parameters

See also:

• CPop3ClientMtmPOP3 client MTM interface.

IMPORT_C TBool DeleteEmailsWhenDisconnecting() const;

Description

Checks whether the caller has enabled this setting by calling CImPop3Settings::SetDeleteEmailsWhenDisconnecting(TBool).

This flag is not used by the Messaging subsystem.

Return value

See also:

• CPop3ClientMtmPOP3 client MTM interface.

IMPORT_C void SetDeleteEmailsWhenDisconnecting(TBool aFlag);

Description

Sets or resets a flag.

This flag is not used by the Messaging subsystem.

Parameters

IMPORT_C TBool AcknowledgeReceipts() const;

Description

Checks whether the caller has enabled this setting by calling CImPop3Settings::SetAcknowledgeReceipts(TBool).

This flag is a convenience setting for Messaging client applications that may wish to store whether or not to send a receipt email message to the sender when the email has been received. The Messaging subsystem does not use this setting, and has to be explicitly commanded by the Messaging client application to send a receipt notification. Messaging applications can use CImHeader to check if a message has a return receipt address. Receipt notification messages can be created using CImEmailOperation, and sent using the SMTP client MTM.

Return value

See also:

• CImHeaderEncapsulates an Internet Mail (RFC822) header.
• CImEmailOperationProvides simple email messages creation functions, including creation of new mes...
• CSmtpClientMtmSMTP client MTM interface.

IMPORT_C void SetAcknowledgeReceipts(TBool aFlag);

Description

Sets or resets a flag.

This flag is a convenience setting for Messaging client applications that may wish to store whether or not to send a receipt email message to the sender when the email has been received. The Messaging subsystem does not use this setting, and has to be explicitly commanded by the Messaging client application to send a receipt notification. Messaging applications can use CImHeader to check if a message has a return receipt address. Receipt notification messages can be created using CImEmailOperation, and sent using the SMTP client MTM.

Parameters

See also:

• CImHeaderEncapsulates an Internet Mail (RFC822) header.
• CImEmailOperationProvides simple email messages creation functions, including creation of new mes...
• CSmtpClientMtmSMTP client MTM interface.

IMPORT_C TInt MaxEmailSize() const;

Description

Returns the maximum message size in bytes to be downloaded. This value is set by a calling CImPop3Settings::SetMaxEmailSize(const TInt).

The Messaging subsystem does not use this setting. The default setting is KMaxInt.

Messaging applications can use CImPOP3GetMail or CPop3ClientMtm to specify a maximum email size to retrieve by passing a TImPop3GetMailInfo parameter in method calls.

Return value

See also:

• TImPop3GetMailInfoUse to specify the maximum message size and the destination folder ID for certai...
• CImPOP3GetMailEncapsulates an operation to copy/move POP3 emails from the remote inbox to any ...
• CPop3ClientMtmPOP3 client MTM interface.

IMPORT_C void SetMaxEmailSize(const TInt aMaxEmailSize);

Description

Sets the maximum message size in bytes to be downloaded.

The Messaging subsystem does not use this setting. The default setting is KMaxInt.

Messaging applications can use CImPOP3GetMail or CPop3ClientMtm to specify a maximum email size to retrieve by passing a TImPop3GetMailInfo parameter in method calls.

Parameters

See also:

• TImPop3GetMailInfoUse to specify the maximum message size and the destination folder ID for certai...
• CImPOP3GetMailEncapsulates an operation to copy/move POP3 emails from the remote inbox to any ...
• CPop3ClientMtmPOP3 client MTM interface.

IMPORT_C TPop3GetMailOptions GetMailOptions() const;

Description

Retrieves an enumeration that specifies whether only the messages headers or the entire message will be downloaded when synchronising with the POP3 server. This is specified by calling CImPop3Settings::SetGetMailOptions(TPop3GetMailOptions).

Return value

See also:

• TPop3GetMailOptionsSpecifies which parts of a POP3 message to download. Used when configuring the P...

IMPORT_C void SetGetMailOptions(TPop3GetMailOptions aGetMailOptions);

Description

Specifies whether to download headers only, or entire messages when synchronising with the POP3 server.

Parameters

See also:

• TPop3GetMailOptionsSpecifies which parts of a POP3 message to download. Used when configuring the P...

IMPORT_C CImPop3Settings& CopyL(const CImPop3Settings &aCImPop3Settings);

Description

Copies the configuration settings from another POP3 settings object into this object.

Parameters

Return value

IMPORT_C TBool operator==(const CImPop3Settings &aCImPop3Settings) const;

Description

Equality operator.

Parameters

Return value

IMPORT_C TInt32 InboxSynchronisationLimit() const;

Description

Returns whether or not the POP3 service will synchronise with all emails on the server after connecting, or the maximum number of new messages that will be synchronised if there are new messages on the server. This setting is configured by calling CImPop3Settings::SetInboxSynchronisationLimit(const TInt32).

The default setting is to synchronise all messages.

Return value

IMPORT_C void SetInboxSynchronisationLimit(const TInt32 aInboxSyncLimit);

Description

Specifies whether or not the POP3 service will synchronise with all emails on the server after connecting, or the maximum number of new messages that will be synchronised if there are new messages on the server.

The default setting is to synchronise all messages.

Parameters

IMPORT_C TInt32 PopulationLimit() const;

Description

Retrieves the currently stored TOP population limit from settings. If this is set, it does not mean that this limit is applied but rather is just a convenient place to store the current limit

Return value

IMPORT_C void SetPopulationLimitL(const TInt32 aPopulationLimit);

Description

Sets the currently stored TOP population limit to settings. If this is set, it does not mean that this limit is applied but rather is just a convenient place to store the current limit, the limit must be passed in the parameters of the command

Parameters

IMPORT_C void SetTlsSslDomainL(const TDesC8 &aDomainName);

Description

Sets the domain name to use during TLS/SSL certificate validation.

Parameters

IMPORT_C TPtrC8 TlsSslDomain() const;

Description

Gets the domain name used during TLS/SSL certificate validation.

Return value