epoc32/include/app/miutconv.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) 1999-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@4
    14
// MIUTCONV.H
williamr@2
    15
//
williamr@2
    16
williamr@4
    17
/**
williamr@4
    18
 * @file 
williamr@4
    19
 * @publishedAll
williamr@4
    20
 * @released
williamr@4
    21
 */
williamr@4
    22
williamr@2
    23
#ifndef __MIUTCONV_H__
williamr@2
    24
#define __MIUTCONV_H__
williamr@2
    25
williamr@2
    26
#include <e32base.h>
williamr@2
    27
williamr@2
    28
williamr@2
    29
#if !defined (__CHARCONV_H_)
williamr@2
    30
#include <charconv.h>
williamr@2
    31
#endif
williamr@2
    32
williamr@2
    33
#if !defined (__MIUTHDR_H__)
williamr@2
    34
#include <miuthdr.h>		
williamr@2
    35
#endif
williamr@2
    36
williamr@2
    37
#if !defined (__UTF_H_)
williamr@2
    38
#include <utf.h>
williamr@2
    39
#endif
williamr@2
    40
williamr@4
    41
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    42
#include "cimconvertcharconv.h"
williamr@4
    43
#endif
williamr@2
    44
williamr@2
    45
/** SMTP send methods. 
williamr@2
    46
@publishedAll
williamr@2
    47
@released
williamr@2
    48
*/
williamr@2
    49
enum TImSendMethod
williamr@2
    50
	{ 
williamr@2
    51
	/** Simple email. */
williamr@2
    52
	ESendAsSimpleEmail,
williamr@2
    53
	/** MIME email. */
williamr@2
    54
	ESendAsMimeEmail
williamr@2
    55
	};	
williamr@2
    56
williamr@2
    57
williamr@2
    58
// Information to be used when sending an email message.
williamr@2
    59
// Relating to how parts are encoded and converted.
williamr@2
    60
//
williamr@2
    61
class TImEmailTransformingInfo
williamr@2
    62
/** Encapsulates character conversion and encoding settings for sending SMTP email.
williamr@2
    63
williamr@2
    64
The default outcomes for header, body, HTML, and attachment parts respectively 
williamr@2
    65
for each of the listed categories are given below:
williamr@2
    66
williamr@2
    67
Plain Charset: ISO-8859-1,ISO-8859-1,N/A,N/A
williamr@2
    68
williamr@2
    69
Plain Encoding:None,None,N/A,UU
williamr@2
    70
williamr@2
    71
MIME Charset:UTF8,UTF8,UTF8*,N/A
williamr@2
    72
williamr@2
    73
MIME Encoding:B,QP,Base64,Base64
williamr@2
    74
williamr@2
    75
*: the UTF8 value set in the header field, but no conversion is done. The 
williamr@2
    76
HTML converter converts to UTF8. 
williamr@2
    77
@publishedAll
williamr@2
    78
@released
williamr@2
    79
*/
williamr@2
    80
	{
williamr@2
    81
public:
williamr@2
    82
    IMPORT_C TImEmailTransformingInfo& operator=(const TImEmailTransformingInfo& aInfo);
williamr@2
    83
    IMPORT_C TBool operator==(const TImEmailTransformingInfo& aInfo);
williamr@2
    84
	
williamr@2
    85
	// streaming operations
williamr@2
    86
	IMPORT_C void ExternalizeL( RWriteStream& aWriteStream ) const;
williamr@2
    87
	IMPORT_C void InternalizeL( RReadStream& aReadStream );
williamr@2
    88
	IMPORT_C void StoreL( CMsvStore& aStore ) const;
williamr@2
    89
	IMPORT_C void RestoreL( CMsvStore& aStore );
williamr@2
    90
williamr@2
    91
	// Setting functions
williamr@2
    92
	IMPORT_C void SetToDefault(const TImSendMethod aMethod);
williamr@2
    93
	IMPORT_C void SetSendMethod(const TImSendMethod aMethod);
williamr@2
    94
	IMPORT_C TImSendMethod SendMethod() const;
williamr@2
    95
williamr@2
    96
	IMPORT_C void SetHeaderEncodingQ();
williamr@2
    97
	IMPORT_C void SetHeaderEncodingB();
williamr@2
    98
	IMPORT_C void SetBodyTextEncoding(TImEncodingType aType);
williamr@2
    99
	IMPORT_C void SetHTMLEncoding(TImEncodingType aType);
williamr@2
   100
	IMPORT_C void SetAttachmentEncoding(TImEncodingType aType);
williamr@2
   101
	
williamr@2
   102
	IMPORT_C void SetHeaderAndBodyCharset(TUint aCharset);
williamr@2
   103
	IMPORT_C void SetHeaderCharset(TUint aCharset);
williamr@2
   104
	IMPORT_C void SetBodyTextCharset(TUint aCharset);
williamr@2
   105
	IMPORT_C void SetHTMLCharset(TUint aCharset);
williamr@2
   106
williamr@2
   107
	// Accessor functions
williamr@2
   108
	IMPORT_C TImEncodingType HeaderEncoding() const;
williamr@2
   109
	IMPORT_C TImEncodingType BodyTextEncoding() const;
williamr@2
   110
	IMPORT_C TImEncodingType HTMLEncoding() const;
williamr@2
   111
	IMPORT_C TImEncodingType AttachmentEncoding() const;
williamr@2
   112
	
williamr@2
   113
	IMPORT_C TUint HeaderCharset() const;
williamr@2
   114
	IMPORT_C TUint BodyTextCharset() const;
williamr@2
   115
	IMPORT_C TUint HTMLCharset() const;
williamr@2
   116
williamr@2
   117
private:
williamr@2
   118
	void SetHeaderEncoding(TImEncodingType aType);
williamr@2
   119
williamr@2
   120
private:
williamr@2
   121
	TImEncodingType	iHeaderEncoding;	
williamr@2
   122
	TImEncodingType	iBodyEncoding;	
williamr@2
   123
	TImEncodingType	iHTMLEncoding;	
williamr@2
   124
	TImEncodingType	iAttachmentEncoding;	
williamr@2
   125
williamr@2
   126
	TUint	iHeaderCharset;	
williamr@2
   127
	TUint	iBodyCharset;	
williamr@2
   128
	TUint	iHTMLCharset;	
williamr@2
   129
	TUint	iTextAttachmentCharset;	
williamr@2
   130
williamr@2
   131
	TImSendMethod iSendMethod;
williamr@2
   132
	};
williamr@2
   133
williamr@4
   134
#endif //__MIUTCONV_H__