nsIMsgDBHdr 编辑

The nsIMsgDBHdr interface describes headers for mail messages.

Inherits from: nsISupports

This interface is usually given to you in return to a query from the message database. There are utility functions that also return it though. For instance, msgHdrForCurrentMessage() will return the currently selected message's header.

Headers are backed by the database: a call to these functions directly modifies the state of the database, although it is not saved until the database is committed. In clear, if you want to do a persistent change to a message header, such as marking it as read, or replied to, or whatever, you MUST do it through its corresponding nsIMsgFolder (msgHdr.folder) or nsIMsgDatabase (msgHdr.folder.msgDatabase). It is also mandatory to set msgHdr.folder.msgDatabase = null after performing this kind of operations to prevent leaking. Don't even think about using OrFlags and/or AndFlags.

Method overview

Attributes

Methods

getProperty()

 AString getProperty(in string propertyName);

Parameters

propertyName

The name of the property to retrieve.

Return Value

The value of the property.

setProperty()

Sets a property on the header. For the currently selected message, Thunderbird provides a utility function: setMsgHdrPropertyAndReload(aProperty, aValue); which duplicates this functionality without requiring you to grab the current header.

 void setProperty(in string propertyName,
                  in AString propertyStr);

Parameters

propertyName

The name of the property to set.

propertyStr

The value of the property.

setStringProperty()

 void setStringProperty(in string propertyName,
                        in string propertyValue);

Parameters

propertyName

The name of the property to set.

propertyValue

The value of the property.

getStringProperty()

 string getStringProperty(in string propertyName);

Parameters

propertyName

The name of the property to retrieve.

Return Value

The value of the property.

getUint32Property()

Get an integer property. Usually you would use this to store your own properties.

 unsigned long getUint32Property(in string propertyName);

Parameters

propertyName

The name of the property to retrieve. Thunderbird stored Uint32 properties (not a complete list):

indexed

Used for Spotlight integration on OSX.

notAPhishMessage

Indicates whether phisihing filters have been run on a message yet.

Return Value

The value of the property.

setUint32Property()

 void setUint32Property(in string propertyName,
                        in unsigned long propertyVal);

Parameters

propertyName

The name of the property to set.

propertyVal

The value of the property.

markRead()

Marks this header as read. Thunderbird provides a utility function which performs this for the currently selected message: MarkCurrentMessageAsRead().

 void markRead(in boolean read);

Parameters

read

If true, mark as read. If false mark as undread.

markFlagged()

 void markFlagged(in boolean flagged);

Parameters

flagged

If true, mark as flagged. If false remove flag.

markHasAttachments()

 void markHasAttachments(in boolean hasAttachments);

Parameters

hasAttachments

If true, mark as having attachments. If false mark as not having attachments.

setPriorityString()

 void setPriorityString(in string priority);

Parameters

priority

String describing the priority.

OrFlags()

 unsigned long OrFlags(in unsigned long flags);

Parameters

flags

Flags to be added to the current message flags.

AndFlags()

 unsigned long AndFlags(in unsigned long flags);

Parameters

flags

Flags to be retained on the current message flags. All other flags are cleared.

setReferences()

 void setReferences(in string references);

Parameters

references

Sets the list of references for a news message.

getStringReference()

Returns one of the references in the list of references.

 ACString getStringReference(in long refNum);

Parameters

refNum

The index of the reference to return. Must be less than the total number of references.

setRecipientsArray()

Uses the header parser to recreate the recipients header from an array of names and addresses.

 void setRecipientsArray(in string names,
                         in string addresses,
                         in unsigned long numAddresses);

Parameters

names

A null-delimited list of recipient names.

addresses

A null-delimited list of recipient addresses.

numAddresses

The number of recipients.

setCCListArray()

Users the header parser to recreate the Cc header from an array of names and addresses.

 void setCCListArray(in string names,
                     in string addresses,
                     in unsigned long numAddresses);

Parameters

names

A null-delimited list of Cc names.

addresses

A null-delimited list of Cc addresses.

numAddresses

The number of Ccs.

getAuthorCollationKey()

Decodes and parses the message author and creates a collation key that can be used to efficiently sort authors case insensitively.

 [noscript] void getAuthorCollationKey(out octetPtr key,
                                       out unsigned long len);

Parameters

key

The returned collation key for the author.

len

The length of the returned collation key.

getSubjectCollationKey()

Decodes and parses the message subject and creates a collation key that can be used to efficiently sort subjects case insensitively.

 [noscript] void getSubjectCollationKey(out octetPtr key,
                                        out unsigned long len);

Parameters

key

The returned collation key for the subject.

len

The length of the returned collation key.

getRecipientsCollationKey()

Decodes and parses the message recipients and creates a collation key that can be used to efficiently sort recipients case insensitively.

 [noscript] void getRecipientsCollationKey(out octetPtr key,
                                           out unsigned long len);

Parameters

key

The returned collation key for the recipients.

len

The length of the returned collation key.