Discuss this help topic in SecureBlackbox Forum

TElIMAPClient.Search

TElIMAPClient     See also     


Filter: C#  VB.NET  Pascal  C++  PHP  Java  


Performs search in the mailbox.

Declaration

[C#]
    TElIMAPFetchResponse Search(bool UID, string Criteria);
    TElIMAPFetchResponse Search(bool UID, string Criteria, string Charset);

[VB.NET]
    Function Search(ByVal UID As Boolean, ByVal Criteria As String) As TElIMAPFetchResponse
    Function Search(ByVal UID As Boolean, ByVal Criteria As String, ByVal Charset As String) As TElIMAPFetchResponse

[Pascal]
    function Search(UID : Boolean; Criteria : TWideString) : TElIMAPFetchResponse;
    function Search(UID : Boolean; Criteria, Charset : string) : TElIMAPFetchResponse;

[C++]
    TElIMAPFetchResponseHandle Search(bool UID, const sb_u16string &Criteria);
    TElIMAPFetchResponseHandle Search(bool UID, const std::wstring &Criteria);
    TElIMAPFetchResponseHandle Search(bool UID, const std::string &Criteria, const std::string &Charset);

[PHP]
    TElIMAPFetchResponse Search(bool $UID, string $Criteria)
    TElIMAPFetchResponse Search(bool $UID, string $Criteria, string $Charset)

[Java]
    TElIMAPFetchResponse search(boolean UID, String Criteria, String Charset);
    TElIMAPFetchResponse search(boolean UID, String Criteria);

Parameters

  • UID - defines whether messages are referenced by their UIDs (true) or by their sequence numbers in the mailbox (false).
  • Criteria - search criteria as defined in [RFC 3501].
  • Charset - message charset.

Return value

    Returns TElIMAPFetchResponse object which provides access to all response lines.

Description

    Use this method to search for messages in the active mailbox.

See also:     MailBox    

Discuss this help topic in SecureBlackbox Forum