#include <CIMPLAINBODYTEXT.H>
Link against: imcm.lib

This item is not part of the S60 5th Edition SDK

Class `CImPlainBodyText`

class CImPlainBodyText : public CMsgActive;

Description

This class is a wrapper over CMsvPlainBodyText class of message server. The pointer to this class can be obtained by calling OpenPlainBodyTextForReadL or OpenPlainBodyTextForWriteL API of the CImEmailMessage class. This can be used to store/restore a email message created by using the CImEmailOperation class.

Derivation

CMsgActive - No description.

CImPlainBodyText - This class is a wrapper over CMsvPlainBodyText class of message server. The poin...

Members

Defined in CImPlainBodyText:

CommitL(TRequestStatus &)Commits the email message after it has been completed.
CommitL(TRequestStatus &,CImMimeHeader &)Commits the email message after it has been completed along with mime header for...
DoCancel()Cancels the relavent CMsvPlainBodyText object
DoRunL()
NextChunkL(TDes16 &)Restores the plain body text into chunks.
NextChunkL(TDes16 &,TRequestStatus &)Restore the plain body text into chunks.
NextChunkL(TDes8 &)Retrieve the next chunk of the plain body text.
NextChunkL(TDes8 &,TRequestStatus &)Retrieve the next chunk of the plain body text.
PreviousChunkL(TDes16 &)Restore the plain body text into chunks.
PreviousChunkL(TDes16 &,TRequestStatus &)Restore the plain body text into chunks.
PreviousChunkL(TDes8 &)Retrieve the next chunk of the plain body text.
PreviousChunkL(TDes8 &,TRequestStatus &)Retrieve the next chunk of the plain body text.
StoreChunkL(const TDesC16 &)Store the body part in chunks(16 bit synchronous version).
StoreChunkL(const TDesC16 &,TRequestStatus &)Store the body part in chunks(16 bit version).
StoreChunkL(const TDesC8 &)Store the plain body text part in chunks,synchronous version.
StoreChunkL(const TDesC8 &,TRequestStatus &)Store the plain body text part in chunks.
StoreRichTextAsPlainTextL(CRichText &)Converts and stores the CRichText contents to a plain text.
~CImPlainBodyText()Destructor

Construction and destruction

`~CImPlainBodyText()`

IMPORT_C ~CImPlainBodyText();

Description

Destructor

Member functions

`StoreChunkL(const TDesC8 &,TRequestStatus &)`

IMPORT_C void StoreChunkL(const TDesC8 &aChunk, TRequestStatus &aStatus);

Description

Store the plain body text part in chunks.

Parameters

`const TDesC8 &aChunk`
`TRequestStatus &aStatus`

Leave codes

`KErrAccessDenied.`	If CMsvStore was opened in Read mode or If CommitL is already called.
`Other`	Standard system-wide error codes.

`StoreChunkL(const TDesC8 &)`

IMPORT_C void StoreChunkL(const TDesC8 &aChunk);

Description

Store the plain body text part in chunks,synchronous version.

Parameters

const TDesC8 &aChunk

Leave codes

`KErrAccessDenied.`	If CMsvStore was opened in Read mode or If CommitL is already called.
`Other`	Standard system-wide error codes.

`StoreChunkL(const TDesC16 &,TRequestStatus &)`

IMPORT_C void StoreChunkL(const TDesC16 &aChunk, TRequestStatus &aStatus);

Description

Store the body part in chunks(16 bit version).

Parameters

`const TDesC16 &aChunk`	The 16 bit chunk that is to be stored.
`TRequestStatus &aStatus`	The `TRequestStatus` parameter for this request.

Leave codes

`KErrNotSupported`	If the 8-bit storage was enabled.
`KErrAccessDenied`	If CMsvStore was opened in Read mode or IfCommitL is already called.
`Other`	Standard system-wide error codes.

`StoreChunkL(const TDesC16 &)`

IMPORT_C void StoreChunkL(const TDesC16 &aChunk);

Description

Store the body part in chunks(16 bit synchronous version).

Parameters

const TDesC16 &aChunk

The 16 bit chunk that is to be stored.

Leave codes

`KErrNotSupported`	If the 8-bit storage was enabled.
`KErrAccessDenied`	If CMsvStore was opened in Read mode or If CommitL is already called.
`Other`	Standard system-wide error codes.

`StoreRichTextAsPlainTextL(CRichText &)`

IMPORT_C void StoreRichTextAsPlainTextL(CRichText &aRichText);

Description

Converts and stores the CRichText contents to a plain text.

Parameters


                                 						CRichText &aRichText

The CRichText object that will be stored as plain body text.

Leave codes

`KErrNotSupported`	If the 8-bit storage was enabled.
`KErrAccessDenied`	If CMsvStore was opened in Read mode or If CommitL is already called.
`Other`	Standard system-wide error codes.

`CommitL(TRequestStatus &)`

IMPORT_C void CommitL(TRequestStatus &aStatus);

Description

Commits the email message after it has been completed.

Parameters


                                 						TRequestStatus &aStatus

The TRequestStatus parameter for this request.

`CommitL(TRequestStatus &,CImMimeHeader &)`

IMPORT_C void CommitL(TRequestStatus &aStatus, CImMimeHeader &aMimeHeader);

Description

Commits the email message after it has been completed along with mime header for this message.

Parameters

`TRequestStatus &aStatus`	The `TRequestStatus` parameter for this request.
`CImMimeHeader &aMimeHeader`	The CMimeHeader for this message.

`NextChunkL(TDes8 &,TRequestStatus &)`

IMPORT_C void NextChunkL(TDes8 &aChunk, TRequestStatus &aStatus);

Description

Retrieve the next chunk of the plain body text.

Parameters

`TDes8 &aChunk`	The output parameter contains the requested chunk.
`TRequestStatus &aStatus`

Leave codes

`KErrAccessDenied`	If CMsvStore was opened in Write mode.
`KErrNotSupported`	If 16-bit storage is enabled.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`NextChunkL(TDes8 &)`

IMPORT_C void NextChunkL(TDes8 &aChunk);

Description

Retrieve the next chunk of the plain body text.

Parameters


                                 						TDes8 &aChunk

The output parameter contains the requested chunk.

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrNotSupported`	If 16-bit storage is enabled.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`NextChunkL(TDes16 &,TRequestStatus &)`

IMPORT_C void NextChunkL(TDes16 &aChunk, TRequestStatus &aStatus);

Description

Restore the plain body text into chunks.

Parameters

`TDes16 &aChunk`	The output parameter contains the requested chunk on completion.
`TRequestStatus &aStatus`	The `TRequestStatus` parameter for this request.

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`NextChunkL(TDes16 &)`

IMPORT_C void NextChunkL(TDes16 &aChunk);

Description

Restores the plain body text into chunks.

Parameters


                                 						TDes16 &aChunk

The output parameter contains the requested chunk on completion.

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`PreviousChunkL(TDes8 &,TRequestStatus &)`

IMPORT_C void PreviousChunkL(TDes8 &aChunk, TRequestStatus &aStatus);

Description

Retrieve the next chunk of the plain body text.

Parameters

`TDes8 &aChunk`	The output parameter contains the requested chunk.
`TRequestStatus &aStatus`

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrNotSupported`	If 16-bit storage is enabled.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`PreviousChunkL(TDes8 &)`

IMPORT_C void PreviousChunkL(TDes8 &aChunk);

Description

Retrieve the next chunk of the plain body text.

Parameters


                                 						TDes8 &aChunk

The output parameter contains the requested chunk.

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrNotSupported`	If 16-bit storage is enabled.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`PreviousChunkL(TDes16 &,TRequestStatus &)`

IMPORT_C void PreviousChunkL(TDes16 &aChunk, TRequestStatus &aStatus);

Description

Restore the plain body text into chunks.

Parameters

`TDes16 &aChunk`	The output parameter contains the requested chunk on completion.
`TRequestStatus &aStatus`	The `TRequestStatus` parameter for this request.

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`PreviousChunkL(TDes16 &)`

IMPORT_C void PreviousChunkL(TDes16 &aChunk);

Description

Restore the plain body text into chunks.

Parameters


                                 						TDes16 &aChunk

The output parameter contains the requested chunk on completion.

Leave codes

`KErrNotSupported`	If CMsvStore was opened in Write mode.
`KErrUnderflow`	If aChunk MaxLength is less than iChunkMaxLength.
`Other`	Standard system-wide error codes.

`DoRunL()`

private: virtual void DoRunL();

Description

`DoCancel()`

private: virtual void DoCancel();

Description

Cancels the relavent CMsvPlainBodyText object

Class CImPlainBodyText

Description

Derivation

Members

See also:

Construction and destruction

~CImPlainBodyText()

Description

Member functions

StoreChunkL(const TDesC8 &,TRequestStatus &)

Description

Parameters

Leave codes

StoreChunkL(const TDesC8 &)

Description

Parameters

Leave codes

StoreChunkL(const TDesC16 &,TRequestStatus &)

Description

Parameters

Leave codes

StoreChunkL(const TDesC16 &)

Description

Parameters

Leave codes

StoreRichTextAsPlainTextL(CRichText &)

Description

Parameters

Leave codes

CommitL(TRequestStatus &)

Description

Parameters

CommitL(TRequestStatus &,CImMimeHeader &)

Description

Parameters

NextChunkL(TDes8 &,TRequestStatus &)

Description

Parameters

Leave codes

NextChunkL(TDes8 &)

Description

Parameters

Leave codes

NextChunkL(TDes16 &,TRequestStatus &)

Description

Parameters

Leave codes

NextChunkL(TDes16 &)

Description

Parameters

Leave codes

PreviousChunkL(TDes8 &,TRequestStatus &)

Description

Parameters

Leave codes

PreviousChunkL(TDes8 &)

Description

Parameters

Leave codes

PreviousChunkL(TDes16 &,TRequestStatus &)

Description

Parameters

Leave codes

PreviousChunkL(TDes16 &)

Description

Parameters

Leave codes

DoRunL()

Description

DoCancel()

Description

Class `CImPlainBodyText`

`~CImPlainBodyText()`

`StoreChunkL(const TDesC8 &,TRequestStatus &)`

`StoreChunkL(const TDesC8 &)`

`StoreChunkL(const TDesC16 &,TRequestStatus &)`

`StoreChunkL(const TDesC16 &)`

`StoreRichTextAsPlainTextL(CRichText &)`

`CommitL(TRequestStatus &)`

`CommitL(TRequestStatus &,CImMimeHeader &)`

`NextChunkL(TDes8 &,TRequestStatus &)`

`NextChunkL(TDes8 &)`

`NextChunkL(TDes16 &,TRequestStatus &)`

`NextChunkL(TDes16 &)`

`PreviousChunkL(TDes8 &,TRequestStatus &)`

`PreviousChunkL(TDes8 &)`

`PreviousChunkL(TDes16 &,TRequestStatus &)`

`PreviousChunkL(TDes16 &)`

`DoRunL()`

`DoCancel()`