CImPlainBodyText Class Reference

#include <mw/cimplainbodytext.h>

class CImPlainBodyText : public CMsgActive

Inherits from

Public Member Functions
~CImPlainBodyText()
IMPORT_C voidCommitL(TRequestStatus &)
IMPORT_C voidCommitL(TRequestStatus &, CImMimeHeader &)
CImPlainBodyText *NewL(CImEmailMessage &, CMsvEntry &, CImEmailMessage::TImEmailEntryType, TInt, TBool)
IMPORT_C voidNextChunkL(TDes8 &, TRequestStatus &)
IMPORT_C voidNextChunkL(TDes8 &)
IMPORT_C voidNextChunkL(TDes16 &, TRequestStatus &)
IMPORT_C voidNextChunkL(TDes16 &)
IMPORT_C voidPreviousChunkL(TDes8 &, TRequestStatus &)
IMPORT_C voidPreviousChunkL(TDes8 &)
IMPORT_C voidPreviousChunkL(TDes16 &, TRequestStatus &)
IMPORT_C voidPreviousChunkL(TDes16 &)
IMPORT_C voidStoreChunkL(const TDesC8 &, TRequestStatus &)
IMPORT_C voidStoreChunkL(const TDesC8 &)
IMPORT_C voidStoreChunkL(const TDesC16 &, TRequestStatus &)
IMPORT_C voidStoreChunkL(const TDesC16 &)
IMPORT_C voidStoreRichTextAsPlainTextL(CRichText &)
Inherited Attributes
CActive::iStatus
Inherited Enumerations
CActive:TPriority
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMsgActive::CMsgActive(TInt)
CMsgActive::Complete(TInt)
CMsgActive::Queue(TRequestStatus &)
CMsgActive::~CMsgActive()

Detailed 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.

See also: CImEmailMessage, CImEmailOperation

Constructor & Destructor Documentation

~CImPlainBodyText ( )

IMPORT_C~CImPlainBodyText()

Destructor

Member Function Documentation

CommitL ( TRequestStatus & )

IMPORT_C voidCommitL(TRequestStatus &aStatus)

Commits the email message after it has been completed.

Parameters
aStatusThe TRequestStatus parameter for this request.
Return Value
void

CommitL ( TRequestStatus &, CImMimeHeader & )

IMPORT_C voidCommitL(TRequestStatus &aStatus,
CImMimeHeader &aMimeHeader
)

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

Parameters
aStatusThe TRequestStatus parameter for this request.
aMimeHeaderThe CMimeHeader for this message.
Return Value
void

NewL ( CImEmailMessage &, CMsvEntry &, CImEmailMessage::TImEmailEntryType, TInt, TBool )

CImPlainBodyText *NewL(CImEmailMessage &aEmailMessage,
CMsvEntry &aMsvEntry,
CImEmailMessage::TImEmailEntryTypeaEntryType,
TIntaChunkLength,
TBoolaEditMode
)[static]

NewL Factory method.

Return Value
CImPlainBodyText.Pointer to CImPlainBodyText.

NextChunkL ( TDes8 &, TRequestStatus & )

IMPORT_C voidNextChunkL(TDes8 &aChunk,
TRequestStatus &aStatus
)
Retrieve the next chunk of the plain body text.
Parameters
aChunkThe output parameter contains the requested chunk.
Return Value
void
Leave Codes
KErrAccessDeniedIf
KErrNotSupportedIf 16-bit storage is enabled.
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

NextChunkL ( TDes8 & )

IMPORT_C voidNextChunkL(TDes8 &aChunk)
Retrieve the next chunk of the plain body text.
Parameters
aChunkThe output parameter contains the requested chunk.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrNotSupportedIf 16-bit storage is enabled.
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

NextChunkL ( TDes16 &, TRequestStatus & )

IMPORT_C voidNextChunkL(TDes16 &aChunk,
TRequestStatus &aStatus
)
Restore the plain body text into chunks.
Parameters
aChunkThe output parameter contains the requested chunk on completion.
aStatusThe TRequestStatus parameter for this request.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

NextChunkL ( TDes16 & )

IMPORT_C voidNextChunkL(TDes16 &aChunk)
Restores the plain body text into chunks.
Parameters
aChunkThe output parameter contains the requested chunk on completion.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

PreviousChunkL ( TDes8 &, TRequestStatus & )

IMPORT_C voidPreviousChunkL(TDes8 &aChunk,
TRequestStatus &aStatus
)
Retrieve the next chunk of the plain body text.
Parameters
aChunkThe output parameter contains the requested chunk.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrNotSupportedIf 16-bit storage is enabled.
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

PreviousChunkL ( TDes8 & )

IMPORT_C voidPreviousChunkL(TDes8 &aChunk)
Retrieve the next chunk of the plain body text.
Parameters
aChunkThe output parameter contains the requested chunk.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrNotSupportedIf 16-bit storage is enabled.
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

PreviousChunkL ( TDes16 &, TRequestStatus & )

IMPORT_C voidPreviousChunkL(TDes16 &aChunk,
TRequestStatus &aStatus
)
Restore the plain body text into chunks.
Parameters
aChunkThe output parameter contains the requested chunk on completion.
aStatusThe TRequestStatus parameter for this request.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

PreviousChunkL ( TDes16 & )

IMPORT_C voidPreviousChunkL(TDes16 &aChunk)
Restore the plain body text into chunks.
Parameters
aChunkThe output parameter contains the requested chunk on completion.
Return Value
void
Leave Codes
KErrNotSupportedIf
KErrUnderflowIf aChunk MaxLength is less than iChunkMaxLength.
OtherStandard system-wide error codes.

StoreChunkL ( const TDesC8 &, TRequestStatus & )

IMPORT_C voidStoreChunkL(const TDesC8 &aChunk,
TRequestStatus &aStatus
)
Store the plain body text part in chunks.
Return Value
void.
Leave Codes
KErrAccessDenied.If
OtherStandard system-wide error codes.

StoreChunkL ( const TDesC8 & )

IMPORT_C voidStoreChunkL(const TDesC8 &aChunk)
Store the plain body text part in chunks,synchronous version.
Return Value
void.
Leave Codes
KErrAccessDenied.If
OtherStandard system-wide error codes.

StoreChunkL ( const TDesC16 &, TRequestStatus & )

IMPORT_C voidStoreChunkL(const TDesC16 &aChunk,
TRequestStatus &aStatus
)
Store the body part in chunks(16 bit version).
Parameters
aChunkThe 16 bit chunk that is to be stored.
aStatusThe TRequestStatus parameter for this request.
Return Value
void
Leave Codes
KErrNotSupportedIf the 8-bit storage was enabled.
KErrAccessDeniedIf
OtherStandard system-wide error codes.

StoreChunkL ( const TDesC16 & )

IMPORT_C voidStoreChunkL(const TDesC16 &aChunk)
Store the body part in chunks(16 bit synchronous version).
Parameters
aChunkThe 16 bit chunk that is to be stored.
Return Value
void
Leave Codes
KErrNotSupportedIf the 8-bit storage was enabled.
KErrAccessDeniedIf
OtherStandard system-wide error codes.

StoreRichTextAsPlainTextL ( CRichText & )

IMPORT_C voidStoreRichTextAsPlainTextL(CRichText &aRichText)
Converts and stores the CRichText contents to a plain text.
Parameters
aRichTextThe CRichText object that will be stored as plain body text.
Return Value
void.
Leave Codes
KErrNotSupportedIf the 8-bit storage was enabled.
KErrAccessDeniedIf
OtherStandard system-wide error codes.
© Nokia 2005.