diff options
Diffstat (limited to 'src/objc/imap/MCOIMAPSearchExpression.h')
-rw-r--r-- | src/objc/imap/MCOIMAPSearchExpression.h | 93 |
1 files changed, 53 insertions, 40 deletions
diff --git a/src/objc/imap/MCOIMAPSearchExpression.h b/src/objc/imap/MCOIMAPSearchExpression.h index d0c439e9..17a7656a 100644 --- a/src/objc/imap/MCOIMAPSearchExpression.h +++ b/src/objc/imap/MCOIMAPSearchExpression.h @@ -10,64 +10,77 @@ #define __MAILCORE_MCOIMAPSEARCHEXPRESSION_H_ -// This class implements a search expression. +/** Used to construct an IMAP search query */ #import <Foundation/Foundation.h> #import <MailCore/MCOConstants.h> @interface MCOIMAPSearchExpression : NSObject +/** + Creates a search expression that matches the sender of an email. -// Creates a search expression that matches the sender of an email. -// -// Example: -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchFrom:@"laura@etpan.org"] -// + Example: + + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchFrom:@"laura@etpan.org"] +*/ + (MCOIMAPSearchExpression *) searchFrom:(NSString *)value; -// Creates a search expression that matches any recipient of an email. -// -// Example: -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchRecipient:@"ngan@etpan.org"] -// +/** + Creates a search expression that matches any recipient of an email. + + Example: + + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchRecipient:@"ngan@etpan.org"] +**/ + (MCOIMAPSearchExpression *) searchRecipient:(NSString *)value; -// Creates a search expression that matches the subject of an email. -// -// Example: -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchSubject:@"airline"] -// +/* + Creates a search expression that matches the subject of an email. + + Example: + + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchSubject:@"airline"] +**/ + (MCOIMAPSearchExpression *) searchSubject:(NSString *)value; -// Creates a search expression that matches the content of an email. -// -// Example: -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchContent:@"meeting"] -// +/** + Creates a search expression that matches the content of an email. + + Example: + + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchContent:@"meeting"] +*/ + (MCOIMAPSearchExpression *) searchContent:(NSString *)value; -// Creates a search expression that matches the content of a specific header. -// -// Example: -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchHeader:@"List-Id" value:@"shoes"] -// +/** + Creates a search expression that matches the content of a specific header. + + Example: + + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchHeader:@"List-Id" value:@"shoes"] +**/ + (MCOIMAPSearchExpression *) searchHeader:(NSString *)header value:(NSString *)value; -// Creates a search expression that's a disjunction of two search expressions. -// -// Example: -// MCOIMAPSearchExpression * exprFrom = [MCOIMAPSearchExpression searchFrom:@"laura@etpan.org"] -// MCOIMAPSearchExpression * exprSubject = [MCOIMAPSearchExpression searchContent:@"meeting"] -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchAnd:exprFrom other:exprSubject]; -// +/** + Creates a search expression that's a disjunction of two search expressions. + + Example: + + MCOIMAPSearchExpression * exprFrom = [MCOIMAPSearchExpression searchFrom:@"laura@etpan.org"] + MCOIMAPSearchExpression * exprSubject = [MCOIMAPSearchExpression searchContent:@"meeting"] + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchAnd:exprFrom other:exprSubject]; +**/ + + (MCOIMAPSearchExpression *) searchAnd:(MCOIMAPSearchExpression *)expression other:(MCOIMAPSearchExpression *)other; +/** + Creates a search expression that's a conjunction of two search expressions. -// Creates a search expression that's a conjunction of two search expressions. -// -// Example: -// MCOIMAPSearchExpression * exprFrom = [MCOIMAPSearchExpression searchFrom:@"laura@etpan.org"] -// MCOIMAPSearchExpression * exprOtherFrom = [MCOIMAPSearchExpression searchRecipient:@"ngan@etpan.org"] -// MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchOr:exprFrom exprOtherFrom]; -// + Example: + + MCOIMAPSearchExpression * exprFrom = [MCOIMAPSearchExpression searchFrom:@"laura@etpan.org"] + MCOIMAPSearchExpression * exprOtherFrom = [MCOIMAPSearchExpression searchRecipient:@"ngan@etpan.org"] + MCOIMAPSearchExpression * expr = [MCOIMAPSearchExpression searchOr:exprFrom exprOtherFrom]; +*/ + (MCOIMAPSearchExpression *) searchOr:(MCOIMAPSearchExpression *)expression other:(MCOIMAPSearchExpression *)other; @end |