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