TImEmailTransformingInfo Class Reference

#include <mw/miutconv.h>

class TImEmailTransformingInfo
Public Member Functions
IMPORT_C TImEncodingTypeAttachmentEncoding()
IMPORT_C TUintBodyTextCharset()
IMPORT_C TImEncodingTypeBodyTextEncoding()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C TUintHTMLCharset()
IMPORT_C TImEncodingTypeHTMLEncoding()
IMPORT_C TUintHeaderCharset()
IMPORT_C TImEncodingTypeHeaderEncoding()
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C voidRestoreL(CMsvStore &)
IMPORT_C TImSendMethodSendMethod()
IMPORT_C voidSetAttachmentEncoding(TImEncodingType)
IMPORT_C voidSetBodyTextCharset(TUint)
IMPORT_C voidSetBodyTextEncoding(TImEncodingType)
IMPORT_C voidSetHTMLCharset(TUint)
IMPORT_C voidSetHTMLEncoding(TImEncodingType)
IMPORT_C voidSetHeaderAndBodyCharset(TUint)
IMPORT_C voidSetHeaderCharset(TUint)
IMPORT_C voidSetHeaderEncodingB()
IMPORT_C voidSetHeaderEncodingQ()
IMPORT_C voidSetSendMethod(const TImSendMethod)
IMPORT_C voidSetToDefault(const TImSendMethod)
IMPORT_C voidStoreL(CMsvStore &)
IMPORT_C TImEmailTransformingInfo &operator=(const TImEmailTransformingInfo &)
IMPORT_C TBooloperator==(const TImEmailTransformingInfo &)

Detailed Description

Encapsulates character conversion and encoding settings for sending SMTP email.

The default outcomes for header, body, HTML, and attachment parts respectively for each of the listed categories are given below:

Plain Charset: ISO-8859-1,ISO-8859-1,N/A,N/A

Plain Encoding:None,None,N/A,UU

MIME Charset:UTF8,UTF8,UTF8*,N/A

MIME Encoding:B,QP,Base64,Base64

: the UTF8 value set in the header field, but no conversion is done. The HTML converter converts to UTF8.

Member Function Documentation

AttachmentEncoding ( )

IMPORT_C TImEncodingTypeAttachmentEncoding()const

Gets the attachment encoding.

Return Value
The attachment encoding.

BodyTextCharset ( )

IMPORT_C TUintBodyTextCharset()const

Gets the character set for the body text.

Return Value
The character set for the body text.

BodyTextEncoding ( )

IMPORT_C TImEncodingTypeBodyTextEncoding()const

Gets the body text encoding.

Return Value
The body text encoding.

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aWriteStream)const

HTMLCharset ( )

IMPORT_C TUintHTMLCharset()const

Gets the HTML character set.

Return Value
The HTML character set.

HTMLEncoding ( )

IMPORT_C TImEncodingTypeHTMLEncoding()const

Gets the HTML encoding.

Return Value
The HTML encoding.

HeaderCharset ( )

IMPORT_C TUintHeaderCharset()const

Gets the character set for the header.

Return Value
The character set for the header.

HeaderEncoding ( )

IMPORT_C TImEncodingTypeHeaderEncoding()const

Gets the header encoding.

Return Value
The header encoding.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aReadStream)

RestoreL ( CMsvStore & )

IMPORT_C voidRestoreL(CMsvStore &aStore)

Restores the object to the specified message store.

The function can leave with the standard stream leave codes.

Parameters
aStoreStore to which to write

SendMethod ( )

IMPORT_C TImSendMethodSendMethod()const

Gets the current send method.

Return Value
The current send method.

SetAttachmentEncoding ( TImEncodingType )

IMPORT_C voidSetAttachmentEncoding(TImEncodingTypeaType)

Sets the encoding for email attachments.

This can be one of four possible values : EEncodingTypeNone, EEncodingTypeQP, EEncodingTypeBASE64, or EEncodingTypeUU.

Parameters
aTypeThe email attachment encoding.

SetBodyTextCharset ( TUint )

IMPORT_C voidSetBodyTextCharset(TUintaCharset)

Sets the character set for body text.

Parameters
aCharsetThe character set.

SetBodyTextEncoding ( TImEncodingType )

IMPORT_C voidSetBodyTextEncoding(TImEncodingTypeaType)

Sets the body text encoding.

Parameters
aTypeThe body text encoding. This can be one of four possible values: EEncodingTypeNone, EEncodingTypeQP, EEncodingTypeBASE64, or EEncodingTypeUU.

SetHTMLCharset ( TUint )

IMPORT_C voidSetHTMLCharset(TUintaCharset)

Sets the HTML character set.

Parameters
aCharsetThe character set.

SetHTMLEncoding ( TImEncodingType )

IMPORT_C voidSetHTMLEncoding(TImEncodingTypeaType)

Sets the encoding for HTML email.

Parameters
aTypeThe HTML email encoding. This can be one of four possible values: EEncodingTypeNone, EEncodingTypeQP, EEncodingTypeBASE64, or EEncodingTypeUU.

SetHeaderAndBodyCharset ( TUint )

IMPORT_C voidSetHeaderAndBodyCharset(TUintaCharset)

Sets the character set used for both the header and body text.

Parameters
aCharsetThe character set.

SetHeaderCharset ( TUint )

IMPORT_C voidSetHeaderCharset(TUintaCharset)

Sets the character set used for the header.

Parameters
aCharsetThe character set.

SetHeaderEncodingB ( )

IMPORT_C voidSetHeaderEncodingB()

Sets the header encoding to type B.

SetHeaderEncodingQ ( )

IMPORT_C voidSetHeaderEncodingQ()

Sets the header encoding to type Q.

SetSendMethod ( const TImSendMethod )

IMPORT_C voidSetSendMethod(const TImSendMethodaMethod)

Sets the method by which email is sent.

This is either ESendAsSimpleEmail or ESendAsMimeEmail.

Parameters
aMethodThe method by which email is sent.

SetToDefault ( const TImSendMethod )

IMPORT_C voidSetToDefault(const TImSendMethodaMethod)

Sets the member data to their default values, for the send method specified.

Parameters
aMethodThe send method.

StoreL ( CMsvStore & )

IMPORT_C voidStoreL(CMsvStore &aStore)const

Writes the object to the specified message store.

The function can leave with the standard stream leave codes.

Parameters
aStoreStore to which to write

operator= ( const TImEmailTransformingInfo & )

IMPORT_C TImEmailTransformingInfo &operator=(const TImEmailTransformingInfo &aInfo)

Overloaded assignment operator.

Parameters
aInfoObject from which to copy settings
Return Value
Reference to 'this' object with the copied settings

operator== ( const TImEmailTransformingInfo & )

IMPORT_C TBooloperator==(const TImEmailTransformingInfo &aInfo)

Overloaded equality operator.

Parameters
aInfoObject with which to compare this object
Return Value
ETrue if the objects have the same settings, otherwise EFalse
© Nokia 2005.