CImHeader Class Reference

#include <mw/miuthdr.h>

Link against: imcm.lib

class CImHeader : public CBase

Inherits from

CImHeader
- CBase

Public Member Enumerations
enum	TReplyTo { EOriginator, ESender, EAll, ERecipients }

Public Member Functions
	~CImHeader()
IMPORT_C void	AddEncodingInfoL(TImHeaderEncodingInfo &)
const CDesCArray &	BccRecipients()
CDesCArray &	BccRecipients()
IMPORT_C TMsgOutboxBodyEncoding	BodyEncoding()
const CDesCArray &	CcRecipients()
CDesCArray &	CcRecipients()
IMPORT_C TUint	Charset()
IMPORT_C TInt	CreateForwardL(CImHeader &, TDesC &)
IMPORT_C void	CreateReceiptL(CImHeader &, TDesC &)
IMPORT_C TInt	CreateReplyL(CImHeader &, TReplyTo, TDesC &)
IMPORT_C TInt	DataSize()
CArrayFix< TImHeaderEncodingInfo > &	EncodingInfo()
const CArrayFix< TImHeaderEncodingInfo > &	EncodingInfo()
IMPORT_C void	ExternalizeL(RMsvWriteStream &)
IMPORT_C const TPtrC	From()
IMPORT_C const TPtrC8	ImMsgId()
IMPORT_C const TPtrC8	InReplyTo()
IMPORT_C void	InternalizeL(RMsvReadStream &)
IMPORT_C CImHeader *	NewLC()
IMPORT_C TUint	OverrideCharset()
IMPORT_C void	ReDecodeL(RFs &)
IMPORT_C const TPtrC	ReceiptAddress()
const TUint	RemoteSize()
IMPORT_C const TPtrC	ReplyTo()
const CDesCArray &	ResentBccRecipients()
CDesCArray &	ResentBccRecipients()
const CDesCArray &	ResentCcRecipients()
CDesCArray &	ResentCcRecipients()
IMPORT_C const TPtrC	ResentFrom()
IMPORT_C const TPtrC8	ResentMsgId()
const CDesCArray &	ResentToRecipients()
CDesCArray &	ResentToRecipients()
IMPORT_C void	Reset()
IMPORT_C void	RestoreL(CMsvStore &)
IMPORT_C void	SaveEncodedHeadersL()
IMPORT_C void	SetBodyEncoding(TMsgOutboxBodyEncoding)
IMPORT_C void	SetCharset(const TUint)
IMPORT_C void	SetFromL(const TDesC8 &)
IMPORT_C void	SetFromL(const TDesC16 &)
IMPORT_C void	SetImMsgIdL(const TDesC8 &)
IMPORT_C void	SetInReplyToL(const TDesC8 &)
IMPORT_C void	SetOverrideCharset(TUint)
IMPORT_C void	SetReceiptAddressL(const TDesC8 &)
IMPORT_C void	SetReceiptAddressL(const TDesC16 &)
void	SetRemoteSize(TUint)
IMPORT_C void	SetReplyToL(const TDesC8 &)
IMPORT_C void	SetReplyToL(const TDesC16 &)
IMPORT_C void	SetResentFromL(const TDesC &)
IMPORT_C void	SetResentMsgIdL(const TDesC8 &)
IMPORT_C void	SetSubjectL(const TDesC8 &)
IMPORT_C void	SetSubjectL(const TDesC16 &)
void	SetVersion(TUint16)
IMPORT_C void	StoreL(CMsvStore &)
IMPORT_C void	StoreWithoutCommitL(CMsvStore &)
IMPORT_C const TPtrC	Subject()
const CDesCArray &	ToRecipients()
CDesCArray &	ToRecipients()
const TUint16	Version()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Detailed Description

Encapsulates an Internet Mail (RFC822) header.

Note that the class contains some obsolete functions that take a narrow descriptor: always use the equivalent wide descriptor function instead.

Member Enumeration Documentation

Enum TReplyTo

Flags used to determine where to obtain the ReplyTo address for the header field of that name.

Enumerator	Value	Description
EOriginator		Get address from originator.
ESender		Get address from sender.
EAll		Get address from all sources.
ERecipients		Get address from recipients.

Constructor & Destructor Documentation

~CImHeader ( )

IMPORT_C

~CImHeader

(

)

Destructor.

Member Function Documentation

AddEncodingInfoL ( TImHeaderEncodingInfo & )

IMPORT_C void

AddEncodingInfoL

(

TImHeaderEncodingInfo &

aInfo

)

Adds header field encoding information.

Parameters
aInfo	Header field encoding information

BccRecipients ( )

const CDesCArray &

BccRecipients

(

)

const [inline]

BccRecipients ( )

CDesCArray &

BccRecipients

(

)

[inline]

BodyEncoding ( )

IMPORT_C TMsgOutboxBodyEncoding

BodyEncoding

(

)

const

Gets the method of encoding the body of the email message.

The default value (EMsgOutboxMIME) is set so that text parts of the message are sent as MIME multipart/alternative text/html parts, and are encoded using UTF-8.

CcRecipients ( )

const CDesCArray &

CcRecipients

(

)

const [inline]

CcRecipients ( )

CDesCArray &

CcRecipients

(

)

[inline]

Charset ( )

IMPORT_C TUint

Charset

(

)

const

Gets the character set to use when sending the message header.

If set, this overrides the default system character set for sending the header.

Character set and encoding options can also be set on a per header field basis using TImHeaderEncodingInfo objects. See EncodingInfo().

CreateForwardL ( CImHeader &, TDesC & )

IMPORT_C TInt	CreateForwardL	(	CImHeader &	,
			TDesC &
		)

Populates a new forward header.

The subject line passed in is used to construct the forward subject field value. This is then stored in the new header.

Parameters
	Header to populate
	Subject line

Return Value: System wide error code

CreateReceiptL ( CImHeader &, TDesC & )

IMPORT_C void	CreateReceiptL	(	CImHeader &	,
			TDesC &
		)

Populates a Receipt email header.

Parameters
	Header to populate
	Subject line

CreateReplyL ( CImHeader &, TReplyTo, TDesC & )

IMPORT_C TInt	CreateReplyL	(	CImHeader &	,
			TReplyTo	,
			TDesC &
		)

Populates a new Reply header.

The subject line passed in is used to construct the Reply subject field value. This is then stored in the new header.

Parameters
	Header to populate
	Reply-to address flag
	Subject line

Return Value: System wide error code

DataSize ( )

IMPORT_C TInt

DataSize

(

)

Gets the combined length of all the field values stored.

Return Value: Combined length

EncodingInfo ( )

CArrayFix< TImHeaderEncodingInfo > &

EncodingInfo

(

)

[inline]

EncodingInfo ( )

const CArrayFix< TImHeaderEncodingInfo > &

EncodingInfo

(

)

const [inline]

ExternalizeL ( RMsvWriteStream & )

IMPORT_C void

ExternalizeL

(

RMsvWriteStream &

aWriteStream

)

const

Externalises the settings to a specified stream.

Parameters
aWriteStream	Stream to write to

From ( )

IMPORT_C const TPtrC

From

(

)

const

Gets the "From" header field.

This consists of an address and (possibly) an alias.

Return Value: Field value

ImMsgId ( )

IMPORT_C const TPtrC8

ImMsgId

(

)

const

Gets the "MessageId" header field.

Return Value: Field value

InReplyTo ( )

IMPORT_C const TPtrC8

InReplyTo

(

)

const

Gets the "In Reply To" header field.

For reply messages, this field stores the ID of the message to which this is a reply. It is set by CImHeader::CreateReplyL().

Return Value: "In Reply To" header field

InternalizeL ( RMsvReadStream & )

IMPORT_C void

InternalizeL

(

RMsvReadStream &

aReadStream

)

Internalises the settings from a specified stream.

Parameters
aReadStream	Stream to read from

NewLC ( )

IMPORT_C CImHeader *

NewLC

(

)

[static]

Allocates and creates a new CImHeader object, leaving the object on the cleanup stack.

Return Value: New CImHeader object

OverrideCharset ( )

IMPORT_C TUint

OverrideCharset

(

)

const

Returns the character set to be used when calling ReDecodeL.

ReDecodeL ( RFs & )

IMPORT_C void

ReDecodeL

(

RFs &

aFS

)

Decodes the original message data into the CImHeader fields using the override character set.

8 bit data MUST be decoded using the normal method initially before this method is called.

Parameters
aFS	A file server session handle.

Leave Codes
KErrNotSupported	Encoded header information has not been saved.

ReceiptAddress ( )

IMPORT_C const TPtrC

ReceiptAddress

(

)

const

Gets the "Receipt" header field.

Return Value: Field value

RemoteSize ( )

const TUint

RemoteSize

(

)

const [inline]

ReplyTo ( )

IMPORT_C const TPtrC

ReplyTo

(

)

const

Gets the "ReplyTo" header field.

Return Value: Field value

ResentBccRecipients ( )

const CDesCArray &

ResentBccRecipients

(

)

const [inline]

ResentBccRecipients ( )

CDesCArray &

ResentBccRecipients

(

)

[inline]

ResentCcRecipients ( )

const CDesCArray &

ResentCcRecipients

(

)

const [inline]

ResentCcRecipients ( )

CDesCArray &

ResentCcRecipients

(

)

[inline]

ResentFrom ( )

IMPORT_C const TPtrC

ResentFrom

(

)

const

Deprecated

ResentMsgId ( )

IMPORT_C const TPtrC8

ResentMsgId

(

)

const

Deprecated

ResentToRecipients ( )

const CDesCArray &

ResentToRecipients

(

)

const [inline]

ResentToRecipients ( )

CDesCArray &

ResentToRecipients

(

)

[inline]

Reset ( )

IMPORT_C void

Reset

(

)

Resets all header field values.

RestoreL ( CMsvStore & )

IMPORT_C void

RestoreL

(

CMsvStore &

aMessageStore

)

Restores settings from a specified message store.

Parameters
aMessageStore	Message store to read from

SaveEncodedHeadersL ( )

IMPORT_C void

SaveEncodedHeadersL

(

)

Saves the 8 bit data in supported fields into a CImEncodedHeader. This allows later redecoding with different character sets.

SetBodyEncoding ( TMsgOutboxBodyEncoding )

IMPORT_C void

SetBodyEncoding

(

TMsgOutboxBodyEncoding

aMessageBodyEncoding

)

Sets the method of encoding the body of the email message.

The default value (EMsgOutboxMIME) is set so that text parts of the message are sent as MIME multipart/alternative text/html parts, and are encoded using UTF-8.

SetCharset ( const TUint )

IMPORT_C void

SetCharset

(

const TUint

aCharset

)

Sets the character set to use when sending the message header.

This setting overrides the default system character set for sending the header.

Character set and encoding options can also be set on a per header field basis using TImHeaderEncodingInfo objects. See AddEncodingInfoL().

SetFromL ( const TDesC8 & )

IMPORT_C void

SetFromL

(

const TDesC8 &

aFrom

)

Sets the "From" header field.

Parameters
aFrom	Field value

SetFromL ( const TDesC16 & )

IMPORT_C void

SetFromL

(

const TDesC16 &

aFrom

)

Sets the "From" header field.

Parameters
aFrom	Field value

SetImMsgIdL ( const TDesC8 & )

IMPORT_C void

SetImMsgIdL

(

const TDesC8 &

aImMsgIdL

)

Sets the "MessageId" header field.

Parameters
aImMsgIdL	Field value

SetInReplyToL ( const TDesC8 & )

IMPORT_C void

SetInReplyToL

(

const TDesC8 &

)

Sets the "In Reply To" header field.

For reply messages, this field stores the ID of the message to which this is a reply.

Parameters
	"In Reply To" header field

SetOverrideCharset ( TUint )

IMPORT_C void

SetOverrideCharset

(

TUint

aCharset

)

Sets the character set to be used when calling ReDecodeL.

Parameters
aCharset	The new character set.

SetReceiptAddressL ( const TDesC8 & )

IMPORT_C void

SetReceiptAddressL

(

const TDesC8 &

aReceiptAddress

)

Sets the "Receipt" header field.

Parameters
aReceiptAddress	Field value

SetReceiptAddressL ( const TDesC16 & )

IMPORT_C void

SetReceiptAddressL

(

const TDesC16 &

aReceiptAddress

)

Sets the "Receipt" header field.

Parameters
aReceiptAddress	Field value

SetRemoteSize ( TUint )

void

SetRemoteSize

(

TUint

aSize

)

[inline]

SetReplyToL ( const TDesC8 & )

IMPORT_C void

SetReplyToL

(

const TDesC8 &

aReplyTo

)

Sets the "ReplyTo" header field.

Parameters
aReplyTo	Field value

SetReplyToL ( const TDesC16 & )

IMPORT_C void

SetReplyToL

(

const TDesC16 &

aReplyTo

)

Sets the "ReplyTo" header field.

Parameters
aReplyTo	Field value

SetResentFromL ( const TDesC & )

IMPORT_C void

SetResentFromL

(

const TDesC &

)

Deprecated

SetResentMsgIdL ( const TDesC8 & )

IMPORT_C void

SetResentMsgIdL

(

const TDesC8 &

)

Deprecated

SetSubjectL ( const TDesC8 & )

IMPORT_C void

SetSubjectL

(

const TDesC8 &

aSubject

)

Sets the "Subject" header field.

Parameters
aSubject	Field value

SetSubjectL ( const TDesC16 & )

IMPORT_C void

SetSubjectL

(

const TDesC16 &

aSubject

)

Sets the "Subject" header field.

Parameters
aSubject	Field value

SetVersion ( TUint16 )

void

SetVersion

(

TUint16

aVersion

)

[inline]

StoreL ( CMsvStore & )

IMPORT_C void

StoreL

(

CMsvStore &

aMessageStore

)

const

Stores, but does not commit, settings to a specified message store.

Parameters
aMessageStore	Message store to write to

StoreWithoutCommitL ( CMsvStore & )

IMPORT_C void

StoreWithoutCommitL

(

CMsvStore &

aMessageStore

)

const

Stores, but does not commit, settings to a specified message store.

Parameters
aMessageStore	Message store to write to

Subject ( )

IMPORT_C const TPtrC

Subject

(

)

const

Gets the "Subject" header field.

Return Value: Field value

ToRecipients ( )

const CDesCArray &

ToRecipients

(

)

const [inline]

ToRecipients ( )

CDesCArray &

ToRecipients

(

)

[inline]

Version ( )

const TUint16

Version

(

)

const [inline]