aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/imap/MCOIMAPSearchOperation.h
blob: a594730d45fa4f284d4defd8e39831e9db8df41e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
//
//  MCOIMAPSearchOperation.h
//  mailcore2
//
//  Created by DINH Viêt Hoà on 3/25/13.
//  Copyright (c) 2013 MailCore. All rights reserved.
//

#ifndef MAILCORE_MCOSEARCHOPERATION_H

#define MAILCORE_MCOSEARCHOPERATION_H

/** This class runs an IMAP search operation */

#import <MailCore/MCOIMAPBaseOperation.h>

@class MCOIndexSet;

NS_ASSUME_NONNULL_BEGIN
@interface MCOIMAPSearchOperation : MCOIMAPBaseOperation

/** 
 Starts the asynchronous search operation.

 @param completionBlock Called when the operation is finished.

 - On success `error` will be nil and `searchResults` will contain the UIDs of any matching messages
 
 - On failure, `error` will be set with `MCOErrorDomain` as domain and an 
   error code available in MCOConstants.h, `searchResult` will be nil
*/

- (void) start:(void (^)(NSError * __nullable error, MCOIndexSet * __nullable searchResult))completionBlock;

@end
NS_ASSUME_NONNULL_END

#endif