| 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.
| Public Member Functions | |
|---|---|
| CImBaseEmailSettings () | |
| ~CImBaseEmailSettings () | |
| IMPORT_C TBool | BearerMobility () |
| IMPORT_C TBool | SSLWrapper () |
| IMPORT_C const TPtrC | ServerAddress () |
| IMPORT_C void | SetBearerMobility ( TBool ) |
| IMPORT_C void | SetPort (const TUint ) |
| IMPORT_C void | SetSSLWrapper ( TBool ) |
| IMPORT_C void | SetSecureSockets ( TBool ) |
| IMPORT_C void | SetServerAddressL (const TDesC &) |
| void | SetSettingsFlags ( TUint32 ) |
| TUint32 | SettingsFlags () |
| IMPORT_C TBool | operator== (const CImBaseEmailSettings &) |
| Protected Member Enumerations | |
|---|---|
| enum | TImBaseEmailSettings { EBaseEmailSettingsClearFlag = 0x00000000, EBaseEmailSettingsSecureSockets = 0x00000001, EBaseEmailSettingsSSLWrappedSockets = EBaseEmailSettingsSecureSockets << 1, EBaseEmailSettingsLastUsedFlag = EBaseEmailSettingsSSLWrappedSockets, EBaseEmailSettingsBearerMobFlag = 0x80000000 } |
| Protected Attributes | |
|---|---|
| TUint32 | iFlags |
| TUint32 | iPortNumber |
| Private Attributes | |
|---|---|
| HBufC * | iServerAddress |
| IMPORT_C | CImBaseEmailSettings | ( | ) |
Allocates and creates a new CImBaseEmailSettings object initialised to default values.
| 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 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 | SetBearerMobility | ( | TBool | aFlag | ) |
Sets flag to indicate bearer mobility will be supported by the service. default 0 shall indicate that bearer mobility is not supported.
| TBool aFlag | Specifies the new value of the Flag to be set. |
| 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.
| const TUint aPortNumber | Email server TCP port number. |
| 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.
| 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. |
| 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.
| const TDesC & aServerAddress | Email server IP address. |
| IMPORT_C TBool | operator== | ( | const CImBaseEmailSettings & | aCImBaseEmailSettings | ) | const |
Equality operator.
| const CImBaseEmailSettings & aCImBaseEmailSettings | Specifies the settings object to compare with. |
| EBaseEmailSettingsClearFlag = 0x00000000 | |
| EBaseEmailSettingsSecureSockets = 0x00000001 | |
| EBaseEmailSettingsSSLWrappedSockets = EBaseEmailSettingsSecureSockets << 1 | |
| EBaseEmailSettingsLastUsedFlag = EBaseEmailSettingsSSLWrappedSockets | |
| EBaseEmailSettingsBearerMobFlag = 0x80000000 |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.