#include <mw/miuthdr.h>
Link against: imcm.lib
class CImHeader : public CBase |
Public Member Enumerations | |
---|---|
enum | TReplyTo { EOriginator, ESender, EAll, ERecipients } |
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.
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. |
IMPORT_C void | AddEncodingInfoL | ( | TImHeaderEncodingInfo & | aInfo | ) |
Adds header field encoding information.
Parameters | |
---|---|
aInfo | Header field encoding information |
const CDesCArray & | BccRecipients | ( | ) | const [inline] |
CDesCArray & | BccRecipients | ( | ) | [inline] |
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.
See also: TMsgOutboxBodyEncoding
const CDesCArray & | CcRecipients | ( | ) | const [inline] |
CDesCArray & | CcRecipients | ( | ) | [inline] |
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().
See also: SetCharset() EncodingInfo()
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 |
IMPORT_C TInt | DataSize | ( | ) |
Gets the combined length of all the field values stored.
CArrayFix< TImHeaderEncodingInfo > & | EncodingInfo | ( | ) | [inline] |
const CArrayFix< TImHeaderEncodingInfo > & | EncodingInfo | ( | ) | const [inline] |
IMPORT_C void | ExternalizeL | ( | RMsvWriteStream & | aWriteStream | ) | const |
Externalises the settings to a specified stream.
Parameters | |
---|---|
aWriteStream | Stream to write to |
IMPORT_C const TPtrC | From | ( | ) | const |
Gets the "From" header field.
This consists of an address and (possibly) an alias.
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().
IMPORT_C void | InternalizeL | ( | RMsvReadStream & | aReadStream | ) |
Internalises the settings from a specified stream.
Parameters | |
---|---|
aReadStream | Stream to read from |
IMPORT_C TUint | OverrideCharset | ( | ) | const |
Returns the character set to be used when calling ReDecodeL.
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. |
const TUint | RemoteSize | ( | ) | const [inline] |
const CDesCArray & | ResentBccRecipients | ( | ) | const [inline] |
CDesCArray & | ResentBccRecipients | ( | ) | [inline] |
const CDesCArray & | ResentCcRecipients | ( | ) | const [inline] |
CDesCArray & | ResentCcRecipients | ( | ) | [inline] |
const CDesCArray & | ResentToRecipients | ( | ) | const [inline] |
CDesCArray & | ResentToRecipients | ( | ) | [inline] |
IMPORT_C void | RestoreL | ( | CMsvStore & | aMessageStore | ) |
Restores settings from a specified message store.
Parameters | |
---|---|
aMessageStore | Message store to read from |
IMPORT_C void | SaveEncodedHeadersL | ( | ) |
Saves the 8 bit data in supported fields into a CImEncodedHeader. This allows later redecoding with different character sets.
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.
See also: TMsgOutboxBodyEncoding
Parameters | |
---|---|
aMessageBodyEncoding | Method of encoding |
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().
See also: Charset() AddEncodingInfoL()
Parameters | |
---|---|
aCharset | Identifier for the character set. Character sets idenitifiers are defined by the character conversion API in charconv.h. |
IMPORT_C void | SetFromL | ( | const TDesC16 & | aFrom | ) |
Sets the "From" header field.
Parameters | |
---|---|
aFrom | Field value |
IMPORT_C void | SetImMsgIdL | ( | const TDesC8 & | aImMsgIdL | ) |
Sets the "MessageId" header field.
Sets the "MessageId" header field.
Parameters | |
---|---|
aImMsgIdL | Field value |
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 |
IMPORT_C void | SetOverrideCharset | ( | TUint | aCharset | ) |
Sets the character set to be used when calling ReDecodeL.
Parameters | |
---|---|
aCharset | The new character set. |
IMPORT_C void | SetReceiptAddressL | ( | const TDesC8 & | aReceiptAddress | ) |
Sets the "Receipt" header field.
Sets the "Receipt" header field.
Parameters | |
---|---|
aReceiptAddress | Field value |
IMPORT_C void | SetReceiptAddressL | ( | const TDesC16 & | aReceiptAddress | ) |
Sets the "Receipt" header field.
Sets the "Receipt" header field.
Parameters | |
---|---|
aReceiptAddress | Field value |
void | SetRemoteSize | ( | TUint | aSize | ) | [inline] |
IMPORT_C void | SetReplyToL | ( | const TDesC8 & | aReplyTo | ) |
Sets the "ReplyTo" header field.
Parameters | |
---|---|
aReplyTo | Field value |
IMPORT_C void | SetReplyToL | ( | const TDesC16 & | aReplyTo | ) |
Sets the "ReplyTo" header field.
Parameters | |
---|---|
aReplyTo | Field value |
IMPORT_C void | SetSubjectL | ( | const TDesC8 & | aSubject | ) |
Sets the "Subject" header field.
Parameters | |
---|---|
aSubject | Field value |
IMPORT_C void | SetSubjectL | ( | const TDesC16 & | aSubject | ) |
Sets the "Subject" header field.
Parameters | |
---|---|
aSubject | Field value |
void | SetVersion | ( | TUint16 | aVersion | ) | [inline] |
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 |
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 |
const CDesCArray & | ToRecipients | ( | ) | const [inline] |