Store3.h File Reference

#include "LgiInterfaces.h"
#include "GMime.h"
#include "GOptionsFile.h"
#include "GVariant.h"

Go to the source code of this file.

Classes
class	GDataIterator< T >
	This class is an interface to a collection of objects (NOT thread-safe). More...
class	GDataPropI
	A generic interface for getting / setting properties. More...
class	GDataI
class	GDataFolderI
	An interface to a folder structure. More...
class	GDataEventsI
class	GDataStoreI
Defines
#define	M_STORAGE_EVENT   (M_USER+0x500)
#define	FIELD_IS_ONLINE   -100
	The storage class has this property (positive properties are owned by the app.
Enumerations
enum	Store3Status { Store3Error, Store3Delayed, Store3Success }
	This defines the possible outcomes of calling a function. More...
enum	Store3DataState
	GDataI load state.
Functions
GDataStoreI *	OpenMail2 (char *Mail2Folders, GDataEventsI *Callback, bool Create=false)
GDataStoreI *	OpenMail3 (char *Mail3Folder, GDataEventsI *Callback, bool Create=false)
GDataStoreI *	OpenImap (char *Host, char *User, char *Pass, int ConnectFlags, GDataEventsI *Callback, GStream *Log, int AccoundId=0)

---

Detailed Description

Author:

Matthew Allen, fret@memecode.com

---

Define Documentation

#define M_STORAGE_EVENT   (M_USER+0x500)

A storage event a = (GDataStoreI*)Storage b = (void*)UserParam

See also:

GDataEventsI::Post

---

Enumeration Type Documentation

enum Store3Status

This defines the possible outcomes of calling a function.

Enumerator:

Store3Error	The method failed and no action was taken.
Store3Delayed	The method succeeded but the action was not completed immediately, notification of the actions completion will come later via the callback interface.
Store3Success	The method succeeded and the action has been already completed.

---

Function Documentation

GDataStoreI* OpenImap	(	char *	Host,
		char *	User,
		char *	Pass,
		int	ConnectFlags,
		GDataEventsI *	Callback,
		GStream *	Log,
		int	AccoundId = 0
	)

Open am imap store

Returns:

a valid ptr or NULL on failure

Parameters:

Host	The host name of the IMAP server
User	The user name of the account to connect to
Pass	[Optional] The password of the user
ConnectFlags	Various flags that control the type of connection made: See also: MAIL_SSL, MAIL_SECURE_AUTH

GDataStoreI* OpenMail2	(	char *	Mail2Folders,
		GDataEventsI *	Callback,
		bool	Create = false
	)

Open a mail2 file

Returns:

a valid ptr or NULL on failure

Parameters:

Mail2Folders	The file to open
Callback	Event interface,
Create	true if you want to create a new mail2 file.

GDataStoreI* OpenMail3	(	char *	Mail3Folder,
		GDataEventsI *	Callback,
		bool	Create = false
	)

Open a mail3 folder

Returns:

a valid ptr or NULL on failure

Parameters:

Mail3Folder	The file to open
Callback	Event interface,
Create	true if you want to create a new mail2 file.