MessageFilter
Object
The
MessageFilter object specifies criteria for restricting a search on a Messages collection.
Quick Info
|
Specified
in header file: |
MDISP.ODL |
|
First available
in version: |
OLE
Messaging Library 1.1 |
|
Parent
objects: |
Messages collection |
|
Child
objects: |
Fields collection |
|
Default
property: |
Subject |
Properties
|
|
Available
in version |
|
|
|
Application |
1.1 |
String |
Read-only |
|
Class |
1.1 |
Long |
Read-only |
|
Conversation |
1.1 |
String |
Read/write |
|
Fields |
1.1 |
Field
object or Fields collection object |
Read-only |
|
Importance |
1.1 |
Long |
Read/write |
|
Not |
1.1 |
Boolean |
Read/write |
|
Or |
1.1 |
Boolean |
Read/write |
|
Parent |
1.1 |
Messages
collection object |
Read-only |
|
|
|
|
|
|
Recipients |
1.1 |
Recipient
object or Recipients collection object |
Read/write |
|
Sender |
1.1 |
AddressEntry
object |
Read/write |
|
Sent |
1.1 |
Boolean |
Read/write |
|
Session |
1.1 |
Session
object |
Read-only |
|
Size |
1.1 |
Long |
Read/write |
|
|
|
|
|
|
Subject |
1.1 |
String |
Read/write |
|
Text |
1.1 |
String |
Read/write |
|
TimeFirst |
1.1 |
Variant (vbDate
format) |
Read/write |
|
TimeLast |
1.1 |
Variant (vbDate
format) |
Read/write |
|
Type |
1.1 |
String |
Read/write |
|
Unread |
1.1 |
Boolean |
Read/write |
Methods
|
|
Available
in version |
|
|
IsSameAs |
1.1 |
object as
Object |
Remarks
A
MessageFilter object with no criteria is created by default for every Messages collection. This means that
initially the filter s properties are unset and its child Fields collection is empty. You
specify the filter by setting values for its properties, and by adding fields
to its Fields collection and setting a value for each added field.
The filter is
invoked when the Messages collection is traversed with the Get methods.
Each field participates in a MAPI search restriction comparing the field s Value property against the value
of the Message property specified by the field s ID property.
For fields of
data type other than String, the MAPI search restriction type is
RES_PROPERTY with relational operator RELOP_EQ. For fields of data type String,
the restriction type is RES_CONTENT with fuzzy level options FL_SUBSTRING,
FL_IGNORECASE, and FL_LOOSE.
The results
of the individual restrictions are normally ANDed together to form the
final filter value. You can change this by setting the Or property, which causes all
the results to be ORed instead of ANDed. You can also set the Not property to specify that
the result of each individual restriction is to be negated before being ANDed
or ORed into the final filter value.
The
MessageFilter object is persistent within its parent Messages collection. It is
not deleted even when it is released, and it remains attached to the Messages
collection until the collection s Filter property is set to Nothing or the
collection is itself released.