Collapse all Symbian^3 Product Developer Library

TImEmailTransformingInfo Class Reference

class TImEmailTransformingInfo

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.

Public Member Functions
IMPORT_C TImEncodingType	AttachmentEncoding()
IMPORT_C TUint	BodyTextCharset()
IMPORT_C TImEncodingType	BodyTextEncoding()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TUint	HTMLCharset()
IMPORT_C TImEncodingType	HTMLEncoding()
IMPORT_C TUint	HeaderCharset()
IMPORT_C TImEncodingType	HeaderEncoding()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C void	RestoreL(CMsvStore &)
IMPORT_C TImSendMethod	SendMethod()
IMPORT_C void	SetAttachmentEncoding(TImEncodingType)
IMPORT_C void	SetBodyTextCharset(TUint)
IMPORT_C void	SetBodyTextEncoding(TImEncodingType)
IMPORT_C void	SetHTMLCharset(TUint)
IMPORT_C void	SetHTMLEncoding(TImEncodingType)
IMPORT_C void	SetHeaderAndBodyCharset(TUint)
IMPORT_C void	SetHeaderCharset(TUint)
IMPORT_C void	SetHeaderEncodingB()
IMPORT_C void	SetHeaderEncodingQ()
IMPORT_C void	SetSendMethod(const TImSendMethod)
IMPORT_C void	SetToDefault(const TImSendMethod)
IMPORT_C void	StoreL(CMsvStore &)
IMPORT_C TImEmailTransformingInfo &	operator=(const TImEmailTransformingInfo &)
IMPORT_C TBool	operator==(const TImEmailTransformingInfo &)

Private Member Functions
void	SetHeaderEncoding(TImEncodingType)

Private Attributes
TImEncodingType	iAttachmentEncoding
TUint	iBodyCharset
TImEncodingType	iBodyEncoding
TUint	iHTMLCharset
TImEncodingType	iHTMLEncoding
TUint	iHeaderCharset
TImEncodingType	iHeaderEncoding
TImSendMethod	iSendMethod
TUint	iTextAttachmentCharset

Member Functions Documentation

AttachmentEncoding()

IMPORT_C TImEncodingType

AttachmentEncoding

(

)

const

Gets the attachment encoding.

BodyTextCharset()

IMPORT_C TUint

BodyTextCharset

(

)

const

Gets the character set for the body text.

BodyTextEncoding()

IMPORT_C TImEncodingType

BodyTextEncoding

(

)

const

Gets the body text encoding.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

aWriteStream

)

const

Parameters

RWriteStream & aWriteStream

HTMLCharset()

IMPORT_C TUint

HTMLCharset

(

)

const

Gets the HTML character set.

HTMLEncoding()

IMPORT_C TImEncodingType

HTMLEncoding

(

)

const

Gets the HTML encoding.

HeaderCharset()

IMPORT_C TUint

HeaderCharset

(

)

const

Gets the character set for the header.

HeaderEncoding()

IMPORT_C TImEncodingType

HeaderEncoding

(

)

const

Gets the header encoding.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

aReadStream

)

Parameters

RReadStream & aReadStream

RestoreL(CMsvStore &)

IMPORT_C void

RestoreL

(

aStore

)

Restores the object to the specified message store.

The function can leave with the standard stream leave codes.

Parameters

CMsvStore & aStore

Store to which to write

SendMethod()

IMPORT_C TImSendMethod

SendMethod

(

)

const

Gets the current send method.

SetAttachmentEncoding(TImEncodingType)

IMPORT_C void

SetAttachmentEncoding

(

TImEncodingType

aType

)

Sets the encoding for email attachments.

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

Parameters

TImEncodingType aType

The email attachment encoding.

SetBodyTextCharset(TUint)

IMPORT_C void

SetBodyTextCharset

(

aCharset

)

Sets the character set for body text.

Parameters

TUint aCharset

The character set.

SetBodyTextEncoding(TImEncodingType)

IMPORT_C void

SetBodyTextEncoding

(

TImEncodingType

aType

)

Sets the body text encoding.

Parameters

TImEncodingType aType

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

SetHTMLCharset(TUint)

IMPORT_C void

SetHTMLCharset

(

aCharset

)

Sets the HTML character set.

Parameters

TUint aCharset

The character set.

SetHTMLEncoding(TImEncodingType)

IMPORT_C void

SetHTMLEncoding

(

TImEncodingType

aType

)

Sets the encoding for HTML email.

Parameters

TImEncodingType aType

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

SetHeaderAndBodyCharset(TUint)

IMPORT_C void

SetHeaderAndBodyCharset

(

aCharset

)

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

Parameters

TUint aCharset

The character set.

SetHeaderCharset(TUint)

IMPORT_C void

SetHeaderCharset

(

aCharset

)

Sets the character set used for the header.

Parameters

TUint aCharset

The character set.

SetHeaderEncoding(TImEncodingType)

void

SetHeaderEncoding

(

TImEncodingType

aType

)

[private]

Parameters

TImEncodingType aType

SetHeaderEncodingB()

IMPORT_C void

SetHeaderEncodingB

(

)

Sets the header encoding to type B.

SetHeaderEncodingQ()

IMPORT_C void

SetHeaderEncodingQ

(

)

Sets the header encoding to type Q.

SetSendMethod(const TImSendMethod)

IMPORT_C void

SetSendMethod

(

const TImSendMethod

aMethod

)

Sets the method by which email is sent.

This is either ESendAsSimpleEmail or ESendAsMimeEmail.

Parameters

const TImSendMethod aMethod

The method by which email is sent.

SetToDefault(const TImSendMethod)

IMPORT_C void

SetToDefault

(

const TImSendMethod

aMethod

)

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

Parameters

const TImSendMethod aMethod

The send method.

StoreL(CMsvStore &)

IMPORT_C void

StoreL

(

aStore

)

const

Writes the object to the specified message store.

The function can leave with the standard stream leave codes.

Parameters

CMsvStore & aStore

Store to which to write

operator=(const TImEmailTransformingInfo &)

IMPORT_C TImEmailTransformingInfo &

operator=

(

const TImEmailTransformingInfo &

aInfo

)

Overloaded assignment operator.

Parameters

const TImEmailTransformingInfo & aInfo

Object from which to copy settings

operator==(const TImEmailTransformingInfo &)

IMPORT_C TBool

operator==

(

const TImEmailTransformingInfo &

aInfo

)

Overloaded equality operator.

Parameters

const TImEmailTransformingInfo & aInfo

Object with which to compare this object

Member Data Documentation

TImEncodingType iAttachmentEncoding

TImEncodingType

iAttachmentEncoding

[private]

TUint iBodyCharset

TUint

iBodyCharset

[private]

TImEncodingType iBodyEncoding

TImEncodingType

iBodyEncoding

[private]

TUint iHTMLCharset

TUint

iHTMLCharset

[private]

TImEncodingType iHTMLEncoding

TImEncodingType

iHTMLEncoding

[private]

TUint iHeaderCharset

TUint

iHeaderCharset

[private]

TImEncodingType iHeaderEncoding

TImEncodingType

iHeaderEncoding

[private]

TImSendMethod iSendMethod

iSendMethod

[private]

TUint iTextAttachmentCharset

TUint

iTextAttachmentCharset

[private]

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.