Class TImEmailTransformingInfo

class TImEmailTransformingInfo;

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.

Members

Defined in TImEmailTransformingInfo:
AttachmentEncoding(), BodyTextCharset(), BodyTextEncoding(), ExternalizeL(), HTMLCharset(), HTMLEncoding(), HeaderCharset(), HeaderEncoding(), InternalizeL(), RestoreL(), SendMethod(), SetAttachmentEncoding(), SetBodyTextCharset(), SetBodyTextEncoding(), SetHTMLCharset(), SetHTMLEncoding(), SetHeaderAndBodyCharset(), SetHeaderCharset(), SetHeaderEncodingB(), SetHeaderEncodingQ(), SetSendMethod(), SetToDefault(), StoreL(), operator=(), operator==()

IMPORT_C TImEmailTransformingInfo &operator=(const TImEmailTransformingInfo &aInfo);

Description

Overloaded assignment operator.

Parameters

const TImEmailTransformingInfo &aInfo Object from which to copy settings

Return value

TImEmailTransformingInfo & Reference to 'this' object with the copied settings

IMPORT_C TBool operator==(const TImEmailTransformingInfo &aInfo);

Description

Overloaded equality operator.

Parameters

const TImEmailTransformingInfo &aInfo Object with which to compare this object

Return value

TBool ETrue if the objects have the same settings, otherwise EFalse

IMPORT_C void ExternalizeL(RWriteStream &aWriteStream) const;

Description

Parameters

RWriteStream &aWriteStream

IMPORT_C void InternalizeL(RReadStream &aReadStream);

Description

Parameters

RReadStream &aReadStream

IMPORT_C void StoreL(CMsvStore &aStore) const;

Description

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

IMPORT_C void RestoreL(CMsvStore &aStore);

Description

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

IMPORT_C void SetToDefault(const TImSendMethod aMethod);

Description

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

Parameters

const TImSendMethod aMethod The send method.

IMPORT_C void SetSendMethod(const TImSendMethod aMethod);

Description

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.

IMPORT_C TImSendMethod SendMethod() const;

Description

Gets the current send method.

Return value

TImSendMethod The current send method.

IMPORT_C void SetHeaderEncodingQ();

Description

Sets the header encoding to type Q.

IMPORT_C void SetHeaderEncodingB();

Description

Sets the header encoding to type B.

IMPORT_C void SetBodyTextEncoding(TImEncodingType aType);

Description

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.

IMPORT_C void SetHTMLEncoding(TImEncodingType aType);

Description

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.

IMPORT_C void SetAttachmentEncoding(TImEncodingType aType);

Description

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.

IMPORT_C void SetHeaderAndBodyCharset(TUint aCharset);

Description

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

Parameters

TUint aCharset The character set.

IMPORT_C void SetHeaderCharset(TUint aCharset);

Description

Sets the character set used for the header.

Parameters

TUint aCharset The character set.

IMPORT_C void SetBodyTextCharset(TUint aCharset);

Description

Sets the character set for body text.

Parameters

TUint aCharset The character set.

IMPORT_C void SetHTMLCharset(TUint aCharset);

Description

Sets the HTML character set.

Parameters

TUint aCharset The character set.

IMPORT_C TImEncodingType HeaderEncoding() const;

Description

Gets the header encoding.

Return value

TImEncodingType The header encoding.

IMPORT_C TImEncodingType BodyTextEncoding() const;

Description

Gets the body text encoding.

Return value

TImEncodingType The body text encoding.

IMPORT_C TImEncodingType HTMLEncoding() const;

Description

Gets the HTML encoding.

Return value

TImEncodingType The HTML encoding.

IMPORT_C TImEncodingType AttachmentEncoding() const;

Description

Gets the attachment encoding.

Return value

TImEncodingType The attachment encoding.

IMPORT_C TUint HeaderCharset() const;

Description

Gets the character set for the header.

Return value

TUint The character set for the header.

IMPORT_C TUint BodyTextCharset() const;

Description

Gets the character set for the body text.

Return value

TUint The character set for the body text.

IMPORT_C TUint HTMLCharset() const;

Description

Gets the HTML character set.

Return value

TUint The HTML character set.