Searches message what matches specified search criteria.
Declaration Syntax
C# | Visual Basic | Visual C++ | F# |
public int[] Search( bool uid, Encoding charset, IMAP_Search_Key criteria )
Public Function Search ( uid As Boolean, charset As Encoding, criteria As IMAP_Search_Key ) As Integer()
public: array<int>^ Search( bool uid, Encoding^ charset, IMAP_Search_Key^ criteria )
member Search : uid : bool * charset : Encoding * criteria : IMAP_Search_Key -> int[]
Parameters
- uid (Boolean)
- If true then UID SERACH, otherwise normal SEARCH.
- charset (Encoding)
- Charset used in search criteria. Value null means ASCII. The UTF-8 is reccomended value non ASCII searches.
- criteria (IMAP_Search_Key)
- Search criteria.
Return Value
array<Int32>[]()[][]
Returns search expression matehced messages sequence-numbers or UIDs(This depends on argument uid value).
Returns search expression matehced messages sequence-numbers or UIDs(This depends on argument uid value).
Exceptions
Exception | Condition |
---|---|
ObjectDisposedException | Is raised when this object is disposed and and this method is accessed. |
InvalidOperationException | Is raised when IMAP client is not in valid state. For example 'not connected'. |
ArgumentNullException | Is rised when criteria is null reference. |
IMAP_ClientException | Is raised when server refuses to complete this command and returns error. |
Assembly: LumiSoft.Net (Module: LumiSoft.Net.dll) Version: 4.5.5510.19119