CTCoreAccount Class Reference

List of all members.

Protected Attributes
NSSet *	allFolders
NSSet *	subscribedFolders
CTCoreFolder *	folderWithPath:(NSString *)path
void	connectToServer:(NSString *)server port:(int)port connectionType:(int)conType authType:(int)authType login:(NSString *)login password:(NSString *)password
BOOL	isConnected
void	disconnect

Detailed Description

CTCoreAccount is the base class with which you establish a connection to the IMAP server. After establishing a connection with CTCoreAccount you can access all of the folders (I use the term folder instead of mailbox) on the server. All methods throw an exception on failure.

Member Data Documentation

- (NSSet*) allFolders [protected]

Retrieves the list of all the available folders from the server.

Returns:

Returns a NSSet which contains NSStrings of the folders pathnames.

- (void) connectToServer [protected]

This method initiates the connection to the server.

Parameters:

	server	The address of the server.
	port	The port to connect to.
	connnectionType	What kind of connection to use, it can be one of these three values: CONNECTION_TYPE_PLAIN, CONNECTION_TYPE_STARTTLS, CONNECTION_TYPE_TRY_STARTTLS, CONNECTION_TYPE_TLS
	authType	The authentication type, only IMAP_AUTH_TYPE_PLAIN is currently supported
	login	The username to connect with.
	password	The password to use to connect.

- (void) disconnect [protected]

Terminates the connection. If you terminate this connection it will also affect the connectivity of CTCoreFolders and CTMessages that rely on this account.

- (CTCoreFolder*) folderWithPath [protected]

If you have the path of a folder on the server use this method to retrieve just the one folder.

Parameters:

path

A NSString specifying the path of the folder to retrieve from the server.

Returns:

Returns a CTCoreFolder.

- (BOOL) isConnected [protected]

This method returns the current connection status.

Returns:

Returns YES or NO as the status of the connection.

- (NSSet*) subscribedFolders [protected]

Retrieves a list of only the subscribed folders from the server.

Returns:

Returns a NSSet which contains NSStrings of the folders pathnames.