Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MIUTSET.H
Link against: imcm.lib

Class CImBaseEmailSettings

class CImBaseEmailSettings : public CBase;

Description

Parent class for CImPop3Settings, CImImap4Settings, CImSmtpSettings.

This class should not be instantiated directly. It implements common email settings such as the hostname or IP address of the server, port number, and whether or not to use SSL.

Derivation

Members

Defined in CImBaseEmailSettings:
EBaseEmailSettingsClearFlag, EBaseEmailSettingsLastUsedFlag, EBaseEmailSettingsSSLWrappedSockets, EBaseEmailSettingsSecureSockets, Port(), SSLWrapper(), SecureSockets(), ServerAddress(), SetPort(), SetSSLWrapper(), SetSecureSockets(), SetServerAddressL(), TImBaseEmailSettings, iFlags, iPortNumber

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:


Member functions


ServerAddress()

IMPORT_C const TPtrC ServerAddress() const;

Description

Retrieves the configured IP address or host name of the email server. The IP address or hostname is configured by calling SetServerAddressL().

If an instance of this class is of type CImPop3Settings or CImImap4Settings, the address should be the incoming POP3 or IMAP4 email server. If an instance of this class is of type CImSmtpSettings, the address should be the outbound SMTP email server.

The default setting is empty.

Return value

const TPtrC

Email server IP address if it is configured, or empty if not configured.

See also:


SetServerAddressL()

IMPORT_C void SetServerAddressL(const TDesC &aServerAddress);

Description

If an instance of this class is of type CImPop3Settings or CImImap4Settings, the address should be the incoming POP3 or IMAP4 email server. If an instance of this class is of type CImSmtpSettings, the address should be the outbound SMTP email server.

The default setting is empty.

Parameters

const TDesC &aServerAddress

Email server IP address.

See also:


Port()

IMPORT_C TUint Port() const;

Description

Retrieves the port number of an email server when establishing a TCP connection. The port number is configured by calling SetPort().

If an instance of this class is of type CImPop3Settings, the default port number is 110. If an instance of this class is of type CImImap4Settings, the default port number is 143. If an instance of this class is of type CImSmtpSettings, the default port number is 25.

Return value

TUint

Email server TCP port number.

See also:


SetPort()

IMPORT_C void SetPort(const TUint aPortNumber);

Description

Configures the port number of an email server when establishing a TCP connection.

If an instance of this class is of type CImPop3Settings, the default port number is 110. If an instance of this class is of type CImImap4Settings, the default port number is 143. If an instance of this class is of type CImSmtpSettings, the default port number is 25.

Parameters

const TUint aPortNumber

Email server TCP port number.

See also:


SecureSockets()

IMPORT_C TBool SecureSockets() const;

Description

Retrieves whether a secure TLS connection will be negotiated over an unsecure TCP socket connection when a connection is being established. This setting is configured by calling SetSecureSockets().

Refer to RFC 2595 - "Using TLS with IMAP, POP3 and ACAP" for information on how a secure socket is established when retrieving email from a POP3 or IMAP4 server.

Refer to RFC 3207 - "SMTP Service Extension for Secure SMTP over Transport Layer Security" for information on how a secure socket is established when sending an email.

Return value

TBool

ETrue if a secure sockets is enabled.


SetSecureSockets()

IMPORT_C void SetSecureSockets(TBool aFlag);

Description

Sets whether a secure TLS connection will be negotiated over an unsecure socket when a connection is being established. This setting is configured by calling SetSecureSockets().

Refer to RFC 2595 - "Using TLS with IMAP, POP3 and ACAP" for information on how a secure socket is established when retrieving email from a POP3 or IMAP4 server.

Refer to RFC 3207 - "SMTP Service Extension for Secure SMTP over Transport Layer Security" for information on how a secure socket is established when sending an email.

Not all POP3, IMAP4, or SMTP servers support this protocol.

Post-Condition

If aFlag is ETrue, secure TLS connection will be disabled if it had been previously been enabled by calling SetSSLWrapper().

Parameters

TBool aFlag

ETrue if a secure socket session will be negotiated after establishing a non-secure TCP connection with the POP3, IMAP4, or SMTP server.


SSLWrapper()

IMPORT_C TBool SSLWrapper() const;

Description

Whether secure sockets will be used.

Retrieves whether a secure TLS connection will be established directly over a TLS/SSL socket when connecting to the email server.

The well known port number for a secure TLS POP3 connection is 995. The well known port number for a secure TLS IMAP4 connection is 993. There is no well known port number for a secure SMTP TLS connection. The TLS/SSL port number that the email server is listening on may not necessarily be configured to the well known port number. The port number upon which the connection is attempted is configured by calling SetPort().

Return value

TBool

ETrue if a secure TLS connection will be attempted when establishing a connection.


SetSSLWrapper()

IMPORT_C void SetSSLWrapper(TBool aFlag);

Description

Specifies whether a secure TLS connection will be established directly over a TLS socket when connecting to the email server.

The well known port number for a secure TLS POP3 connection is 995. The well known port number for a secure TLS IMAP4 connection is 993. There is no well known port number for a secure SMTP TLS connection. The TLS/SSL port number that the email server is listening on may not necessarily be configured to the well known port number. The port number upon which the connection is attempted is configured by calling SetPort().

Post-Condition

If aFlag is ETrue, secure socket negotiation over an unsecure connection will be disabled if it had been previously enabled by calling SetSecureSockets().

Parameters

TBool aFlag

If ETrue, a secure TLS connection will be established when connecting to the email server.

[Top]


Member enumerations


Enum TImBaseEmailSettings

protected: TImBaseEmailSettings

Description

EBaseEmailSettingsClearFlag

EBaseEmailSettingsSecureSockets

EBaseEmailSettingsSSLWrappedSockets

EBaseEmailSettingsLastUsedFlag

[Top]


Member data


iPortNumber

protected: TUint32 iPortNumber;

Description


iFlags

protected: TUint32 iFlags;

Description