diff options
Diffstat (limited to 'src/objc/pop/MCOPOPSession.h')
-rw-r--r-- | src/objc/pop/MCOPOPSession.h | 68 |
1 files changed, 66 insertions, 2 deletions
diff --git a/src/objc/pop/MCOPOPSession.h b/src/objc/pop/MCOPOPSession.h index 81ae2e86..7b59256d 100644 --- a/src/objc/pop/MCOPOPSession.h +++ b/src/objc/pop/MCOPOPSession.h @@ -20,23 +20,87 @@ @class MCOPOPOperation; @class MCOIndexSet; +// This class implements asynchronous POP3 protocol. + @interface MCOPOPSession : NSObject +// This is the hostname of the POP3 server to connect to. @property (nonatomic, copy) NSString * hostname; + +// This is the port of the POP3 server to connect to. @property (nonatomic, assign) unsigned int port; + +// This is the username of the account. @property (nonatomic, copy) NSString * username; + +// This is the password of the account. @property (nonatomic, copy) NSString * password; + +// This is the authentication type to use to connect. +// MCOAuthTypeSASLNone means that it uses the clear-text password authentication. +// It's the default. +// Note: However, over a encrypted connection, the password will be safe. @property (nonatomic, assign) MCOAuthType authType; + +// This is the encryption type to use. +// See MCOConnectionType for more information. @property (nonatomic, assign) MCOConnectionType connectionType; + +// This is the timeout of the connection. @property (nonatomic, assign) NSTimeInterval timeout; + +// When set to YES, the connection will fail if the certificate is incorrect. @property (nonatomic, assign, getter=isCheckCertificateEnabled) BOOL checkCertificateEnabled; +// Returns an operation that will fetch the list of messages. +// +// { +// ... +// MCOPOPFetchMessagesOperation * op [session fetchMessagesOperation]; +// [op start:^(NSError *error, NSArray * messages) { +// // messages is an array of MCOPOPMessageInfo +// // [info index] can be used as reference for a given message in the other operations. +// }]]; +// - (MCOPOPFetchMessagesOperation *) fetchMessagesOperation; + +// Returns an operation that will fetch the header of the given message. +// +// { +// ... +// MCOPOPFetchHeaderOperation * op [session fetchHeaderOperationWithIndex:idx]; +// [op start:^(NSError *error, MCOMessageHeader * header) { +// // header is the parsed header of the message. +// }]]; +// - (MCOPOPFetchHeaderOperation *) fetchHeaderOperationWithIndex:(unsigned int)index; + +// Returns an operation that will fetch the content of the given message. +// +// { +// ... +// MCOPOPFetchMessageOperation * op [session fetchMessageOperationWithIndex:idx]; +// [op start:^(NSError *error, NSData * messageData) { +// // messageData is the RFC 822 formatted message data. +// }]]; +// - (MCOPOPFetchMessageOperation *) fetchMessageOperationWithIndex:(unsigned int)index; -// Will disconnect. -- (MCOPOPOperation *) deleteMessagesWithIndexes:(MCOIndexSet *)indexes; +// Returns an operation that will delete the given messages. +// Will disconnect when finished. +// +// { +// ... +// MCOIndexSet * indexes = [MCOIndexSet indexSet]; +// [indexes addIndex:1]; +// [indexes addIndex:2]; +// [indexes addIndex:3]; +// MCOPOPOperation * op [session deleteMessagesOperationWithIndexes:indexes]; +// [op start:^(NSError *error) { +// ... +// }]]; +// +- (MCOPOPOperation *) deleteMessagesOperationWithIndexes:(MCOIndexSet *)indexes; @end |