RDOSearch object

 

RDOSearch represents a search folder visible in Outlook.

 

Returned by:

RDOSearches.AddCategorized, AddConversations, AddCustom, AddFromSpecificPerson, AddImportantMail, AddLargeMessages, AddMarkedForFollowup, AddSentDirectlyToMe, AddSentToSpecificDistributionList, AddOldMail, AddUnreadMessages, AddUnreadOrMarkedForFollowup, AddWithAttachments, AddWithSpecificWords, Item

 

The example below enumerates all search folder i na store.

set Session = CreateObject("Redemption.RDOSession")
Session.Logon
set Searches = Session.Stores.DefaultStore.Searches
for each Search in Searches
    Debug.Print "-------------"
    Debug.Print Search.Name
    Debug.Print Search.SearchCriteria.AsSQL
next

 

Properties

Methods

 


Derived from: IDispatch


Properties


Active

Boolean, read/write.

If true, the search folder exists. If false, the search folder does not exist (but a special message with the folder search criteria definition does) and needs to be re-created.

Inactive search folders are displayed italicized by Outlook.

 

 

ExpirationDate

DateTime, read/write. Returns or set the folder expiration date. If a folder is expired, it needs to be recreated (resetting the Active  property to false and then to true would do that).

 

 

FolderID

String, read-only. Returns a string uniqquely identifying the search folder. This property is used for correlating the MAPI search folder with a special message that contains the folder definition.

Corresponds to the PR_WB_SF_ID MAPI property.

 

 

IsRecursiveSearch

Boolean, read-only. If true, the search is performed on the specified folders as well as all the child subfolders.

 

 

LastUsed

DateTime, read/write. Returns or sets the time when the folder was last used by the user.

 

 

Name

String, read/write. The name of the search folder.

 

see example above

SearchContainers

RDOSearchContainersList, read-only. Returns the list representing the folders where the search is performed.

 

set Session = CreateObject("Redemption.RDOSession")
Session.MAPIOBJECT = Application.Session.MAPIOBJECT
set Searches = Session.Stores.DefaultStore.Searches
for each Search in Searches
    Debug.Print "-------------"
    Debug.Print Search.Name
    for each Folder in Search.SearchContainers
        Debug.Print " Folder: " & Folder.Name
    next
next

 

SearchCriteria

RDOFolderSearchCriteria, read-only. Returns the folder's search criteria.

 

see example above

Tag

Integer, read/write. Returns a tag used to keep the search folder and the message with its definition i nsync.

Corresponds to the PR_WB_SF_TAG MAPI property.

 

 

TemplateId

rdoSearchTemplateId, read-only. Template used to create the search folder.

One of the rdoSearchTemplateId enum values:

 

stCustom = 1
stUnreadMessages = 2
stMarkedForFollowup = 3
stUnreadOrMarkedForFollowup = 4
stImportantMail = 5
stConversations = 6
stFromSpecificPerson = 7
stSentDirectlyToMe = 8
stSentToSpecificDistributionList = 9
stLargeMessages = 10
stOldMail = 11
stWithAttachments = 12
stWithSpecificWords = 14
stCategorized = 15

 

 


Methods


Delete

Deletes the search folder.

 

 

GetFolder(CanCreate)

Returns IRDOSearchFolder object containing the messages satisfying the search criteria.

 

CanCreate - boolean. If false and the search folder  is inactive, NULL will be returns. If true, the search folder will be re-created if necessary and Active property will be true.

 

 

Save

Save the changes made to the folder definition.