epoc32/include/app/miutset.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #if !defined (__MIUTSET_H__)
    17 #define __MIUTSET_H__
    18 
    19  
    20 
    21 #include <msvuids.h>
    22 #include <miuthdr.h>
    23 
    24 const TInt KMaxSettingStringLength = 1024;
    25 
    26 /** UID of an SMTP message type. */
    27 const TUid KUidMsgTypeSMTP			= {0x10001028};	// 268439592
    28 /** UID of a POP3 message type. */
    29 const TUid KUidMsgTypePOP3			= {0x10001029};	// 268439593
    30 /** UID of an IMAP4 message type. */
    31 const TUid KUidMsgTypeIMAP4			= {0x1000102A};	// 268439594
    32 
    33 /**
    34 @deprecated
    35 */
    36 const TUid KUidMsgTypeSMTPServer	= {0x10003923};	// 268450083
    37 
    38 
    39 class CImBaseEmailSettings : public CBase
    40 /**
    41 Parent class for CImPop3Settings, CImImap4Settings, CImSmtpSettings.
    42 
    43 This class should not be instantiated directly. It implements common email
    44 settings such as the hostname or IP address of the server, port number,
    45 and whether or not to use SSL.
    46 
    47 @see CImPop3Settings
    48 @see CImImap4Settings
    49 @see CImSmtpSettings
    50 
    51 @publishedAll
    52 @released
    53 */
    54 	{
    55 public:
    56 	IMPORT_C CImBaseEmailSettings();
    57 	IMPORT_C virtual ~CImBaseEmailSettings();
    58 	IMPORT_C void Reset();
    59 	IMPORT_C const TPtrC ServerAddress() const;
    60 	IMPORT_C void SetServerAddressL(const TDesC& aServerAddress);
    61 	IMPORT_C TUint Port() const;
    62 	IMPORT_C void SetPort(const TUint aPortNumber);
    63 	IMPORT_C TBool SecureSockets() const;
    64 	IMPORT_C void SetSecureSockets(TBool aFlag);
    65 	IMPORT_C TBool SSLWrapper() const;
    66 	IMPORT_C void SetSSLWrapper(TBool aFlag);
    67 	IMPORT_C CImBaseEmailSettings& CopyL(const CImBaseEmailSettings& aCImBaseEmailSettings);
    68 	IMPORT_C TBool operator==(const CImBaseEmailSettings& aCImBaseEmailSettings) const;
    69 	IMPORT_C void SetBearerMobility(TBool aFlag);
    70 	IMPORT_C TBool BearerMobility() const;
    71 
    72 	TUint32 SettingsFlags() const;
    73 	void SetSettingsFlags(TUint32 aSetFlags);
    74 
    75 protected:
    76 	enum TImBaseEmailSettings
    77 		{
    78 		EBaseEmailSettingsClearFlag			= 0x00000000,
    79 		EBaseEmailSettingsSecureSockets		= 0x00000001,
    80 		EBaseEmailSettingsSSLWrappedSockets	= EBaseEmailSettingsSecureSockets << 1,  //0x00000002,
    81 		EBaseEmailSettingsLastUsedFlag		= EBaseEmailSettingsSSLWrappedSockets,  //0x00000002
    82 		EBaseEmailSettingsBearerMobFlag		= 0x80000000
    83 		};
    84 	TUint32 iPortNumber;	// the port the TCP/IP connection be made on
    85 
    86 	TUint32 iFlags;			// space for flags info (now and for future)
    87 
    88 private:
    89 	HBufC* iServerAddress;	// remote server's IP address
    90 	};
    91 
    92 #endif