net.bluemind.backend.mail.api

Class SearchQuery

java.lang.Object

net.bluemind.backend.mail.api.SearchQuery

public class SearchQuery
extends java.lang.Object

Defines message search parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchQuery.FolderScope Definition of a MailboxFolder search restriction
static class	SearchQuery.Header Header key/value pair
static class	SearchQuery.HeaderQuery Header search
static class	SearchQuery.LogicalOperator Defines the search operator of the requested header search values
static class	SearchQuery.SearchScope The scope of a search

Field Summary

Fields

Modifier and Type	Field and Description
SearchQuery.HeaderQuery	headerQuery Enables the search by the specific header values
long	maxResults Maximum results
java.lang.String	messageId Enables the search by the MessageId header
long	offset Result Set offset
java.lang.String	query An Elasticsearch compliant query string body document only
java.lang.String	recordQuery An Elasticsearch compliant query string record document only
java.lang.String	references Enables the search by the References header
SearchQuery.SearchScope	scope The scope of this search
java.lang.String	searchSessionId An optional id associated to this query

Constructor Summary

Constructors

Constructor and Description
SearchQuery()

Method Summary

Modifier and Type	Method and Description
static SearchQuery	allHeaders(java.util.Map<java.lang.String,java.lang.String> headerValues, SearchQuery.LogicalOperator operator)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

searchSessionId

public java.lang.String searchSessionId

An optional id associated to this query

query

public java.lang.String query

An Elasticsearch compliant query string body document only

recordQuery

public java.lang.String recordQuery

An Elasticsearch compliant query string record document only

messageId

public java.lang.String messageId

Enables the search by the MessageId header

references

public java.lang.String references

Enables the search by the References header

headerQuery

public SearchQuery.HeaderQuery headerQuery

Enables the search by the specific header values

maxResults

public long maxResults

Maximum results

offset

public long offset

Result Set offset

scope

public SearchQuery.SearchScope scope

The scope of this search

Constructor Detail

SearchQuery

public SearchQuery()

Method Detail

allHeaders

public static SearchQuery allHeaders(java.util.Map<java.lang.String,java.lang.String> headerValues,
                                     SearchQuery.LogicalOperator operator)