NGImap4Client
Inherits From: NSObject
Declared In: NGImap4Client.h
Methods: + clientWithAddress: , + clientWithHost: , - initWithHost: , - initWithAddress: , - isEqual: , - isEqualToClient: , - socket , - address , - delimiter , - registerForResponseNotification: , - removeFromResponseNotification: , - openConnection , - closeConnection , - isConnected , - reconnect , - login:password: , - logout , - noop , - list:pattern: , - lsub:pattern: , - select: , - status:flags: , - rename:to: , - delete: , - create: , - subscribe: , - unsubscribe: , - expunge , - sort:qualifier: , - fetchUids:parts: , - fetchUid:parts: , - fetchFrom:to:parts: , - storeUid:add:flags: , - storeFrom:to:add:flags: , - copyUid:toFolder: , - copyFrom:to:toFolder: , - append:toFolder:withFlags: , - searchWithQualifier: , - description


Class Description
No class description.


Defined Types

Synopsis:

typedef enum {    
    UnConnected_NGImap4State = 1,
    NonAuthenticated_NGImap4State,
    Authenticated_NGImap4State,
    Selected_NGImap4State,
} NGImap4State;



Instance Variables
id<NGActiveSocket> socket;
id<NGExtendedTextStream> text;
id<NGSocketAddress> address;
NGImap4ResponseParser *parser;
NSMutableArray *responseReceiver;
BOOL isLogin;
unsigned tagId;
NSString *delimiter;
NSString *selectedFolder;
NSString *login;
NSString *password;
BOOL debug;

socketNo description.
textNo description.
addressNo description.
parserNo description.
responseReceiverNo description.
isLoginNo description.
tagIdNo description.
delimiterNo description.
selectedFolderNo description.
loginNo description.
passwordNo description.
debugNo description.



Method Types
+ clientWithAddress:
+ clientWithHost:
- initWithHost:
- initWithAddress:
- isEqual:
- isEqualToClient:
- socket
- address
- delimiter
- registerForResponseNotification:
- removeFromResponseNotification:
- openConnection
- closeConnection
- isConnected
- reconnect
- login:password:
- logout
- noop
- list:pattern:
- lsub:pattern:
- select:
- status:flags:
- rename:to:
- delete:
- create:
- subscribe:
- unsubscribe:
- expunge
- sort:qualifier:
- fetchUids:parts:
- fetchUid:parts:
- fetchFrom:to:parts:
- storeUid:add:flags:
- storeFrom:to:add:flags:
- copyUid:toFolder:
- copyFrom:to:toFolder:
- append:toFolder:withFlags:
- searchWithQualifier:
- description


Class Methods
clientWithAddress:
+ (id)clientWithAddress:(id<NGSocketAddress>)_address
No method description.

clientWithHost:
+ (id)clientWithHost:(id)_host
No method description.


Instance Methods
address
- (id<NGSocketAddress>)address
No method description.

append:toFolder:withFlags:
- (NSDictionary *)append:(NSData *)_message toFolder:(NSString *)_folder withFlags:(NSArray *)_flags
Implementation of the append command Does only append messages with less than 15000 Byte

closeConnection
- (void)closeConnection
Close a consisting connection.

copyFrom:to:toFolder:
- (NSDictionary *)copyFrom:(unsigned)_from to:(unsigned)_to toFolder:(NSString *)_folder
Implementation of the COPY command

copyUid:toFolder:
- (NSDictionary *)copyUid:(unsigned)_uid toFolder:(NSString *)_folder
Implementation of the UID COPY command

create:
- (NSDictionary *)create:(NSString *)_name
Implementation of the CREATE command

delete:
- (NSDictionary *)delete:(NSString *)_folder
Implementation of the DELETE command

delimiter
- (NSString *)delimiter
No method description.

description
- (NSString *)description
No method description.

expunge
- (NSDictionary *)expunge
Implementation of the EXPUNGE command

fetchFrom:to:parts:
- (NSDictionary *)fetchFrom:(unsigned)_from to:(unsigned)_to parts:(NSArray *)_parts
Implementation of the FETCH command

fetchUid:parts:
- (NSDictionary *)fetchUid:(unsigned)_uid parts:(NSArray *)_parts
No method description.

fetchUids:parts:
- (NSDictionary *)fetchUids:(NSArray *)_uids parts:(NSArray *)_parts
Implementation of the UID FETCH command

initWithAddress:
- (id)initWithAddress:(id<NGSocketAddress>)_address
designated initializer

initWithHost:
- (id)initWithHost:(id)_host
No method description.

isConnected
- (NSNumber *)isConnected
Check whether stream is already open (could be closed because server-timeout)

isEqual:
- (BOOL)isEqual:(id)_obj
No method description.

isEqualToClient:
- (BOOL)isEqualToClient:(NGImap4Client *)_obj
No method description.

list:pattern:
- (NSDictionary *)list:(NSString *)_folder pattern:(NSString *)_pattern
Implementation of the LIST command. The method build statements like 'LIST "_folder" "_pattern"'. The Cyrus IMAP4 v1.5.14 server ignores the given folder. Instead of you should use the pattern to get the expected result. If folder is NIL it would be set to empty string ''. If pattern is NIL it would be set to ''.

login:password:
- (NSDictionary *)login:(NSString *)_login password:(NSString *)_passwd
login with plaintext password authenticating

logout
- (NSDictionary *)logout
No method description.

lsub:pattern:
- (NSDictionary *)lsub:(NSString *)_folder pattern:(NSString *)_pattern
Implementation of the LSUB command. The method build statements like 'LSUB "_folder" "_pattern"'. The returnvalue is the same like the list:pattern: method

noop
- (NSDictionary *)noop
Implementation of the NOOP command

openConnection
- (NSDictionary *)openConnection
No method description.

reconnect
- (void)reconnect
No method description.

registerForResponseNotification:
- (void)registerForResponseNotification:(id<NGImap4ResponseReceiver>)_obj
No method description.

removeFromResponseNotification:
- (void)removeFromResponseNotification:(id<NGImap4ResponseReceiver>)_obj
No method description.

rename:to:
- (NSDictionary *)rename:(NSString *)_folder to:(NSString *)_newName
No method description.

searchWithQualifier:
- (NSDictionary *)searchWithQualifier:(EOQualifier *)_qualifier
No method description.

select:
- (NSDictionary *)select:(NSString *)_folder
Implementation of the SELECT command

socket
- (id<NGActiveSocket>)socket
No method description.

sort:qualifier:
- (NSDictionary *)sort:(NSArray *)_sortOrderings qualifier:(EOQualifier *)_qual
No method description.

status:flags:
- (NSDictionary *)status:(NSString *)_folder flags:(NSArray *)_flags
Implementation of the STATUS command

storeFrom:to:add:flags:
- (NSDictionary *)storeFrom:(unsigned)_from to:(unsigned)_to add:(NSNumber *)_add flags:(NSArray *)_flags
Implementation of the STORE command

storeUid:add:flags:
- (NSDictionary *)storeUid:(unsigned)_uid add:(NSNumber *)_add flags:(NSArray *)_flags
Implementation of the UID STORE command

subscribe:
- (NSDictionary *)subscribe:(NSString *)_name
Implementation of the SUBSCRIBE command

unsubscribe:
- (NSDictionary *)unsubscribe:(NSString *)_name
Implementation of the UNSUBSCRIBE command


Version 1.3 Copyright ©2002 by SKYRIX Software AG. All Rights Reserved.