Location:
MIUTSET.H
Link against: imcm.lib
class CImBaseEmailSettings : public CBase;
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.
CBase
- Base class for all classes to be instantiated on the heap
CImBaseEmailSettings
- Parent class for
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()
IMPORT_C const TPtrC ServerAddress() const;
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.
|
IMPORT_C void SetServerAddressL(const TDesC &aServerAddress);
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.
|
IMPORT_C TUint Port() const;
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.
|
IMPORT_C void SetPort(const TUint aPortNumber);
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.
|
IMPORT_C TBool SecureSockets() const;
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.
|
IMPORT_C void SetSecureSockets(TBool aFlag);
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.
If aFlag is ETrue, secure TLS connection will be disabled if it had been previously been enabled by calling SetSSLWrapper()
.
|
IMPORT_C TBool SSLWrapper() const;
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()
.
|
IMPORT_C void SetSSLWrapper(TBool aFlag);
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()
.
If aFlag is ETrue, secure socket negotiation over an unsecure connection will be disabled if it had been previously enabled
by calling SetSecureSockets()
.
|
protected: TImBaseEmailSettings
|
protected: TUint32 iFlags;