head	1.3;
access;
symbols
	camas_1_3:1.1.1.1
	camas:1.1.1
	camas_1_2_7:1.1
	camas_1_2_6:1.1
	camas_1_2_5:1.1
	camas_1_2_4:1.1
	camas_1_2_3:1.1
	camas_1_2_2:1.1
	camas_1_2_1:1.1
	camas_1_2:1.1.0.2;
locks; strict;
comment	@# @;


1.3
date	2003.03.19.11.59.40;	author kiwi;	state Exp;
branches;
next	1.2;

1.2
date	2003.03.18.09.30.02;	author vida;	state dead;
branches;
next	1.1;

1.1
date	2002.05.07.07.34.46;	author gourdelier;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2003.03.18.10.01.44;	author vida;	state Exp;
branches;
next	;


desc
@@


1.3
log
@Fixing Vida's work.
@
text
@CAMAS mailboxes related variable organization
--------------------------------------------

See etc/include/camas/global.h for definition of all MB_* predefined variables.

$Id: mailboxes,v 1.1 2002/05/07 07:34:46 gourdelier Exp $

Key					Type			Usage

sessobj->mailboxes			array(array)		array of information on all folders. The size of the array is the size is the number of mailboxes. 

sessobj->mailboxes[x]			array(mixed)		array of information on one folder. The size = 5.
all folders.

sessobj->mailboxes[x][MB_FOLDERNAME_IDX]	string		Internal name (mean on the IMAP server) of the folder at position 'x'
sessobj->mailboxes[x][MB_DISPLAYNAME_IDX]	string		Folder name to display to end user.

sessobj->mailboxes[x][MB_FLAGS_IDX]		int		IMAP Flags of the folder. Typical values are MB_NOSELECT for the \\Noselect Flag and MB_NOINFERIOR for the \\Noinferiors flag. See RFC 2060  7.2.2

sessobj->mailboxes[x][MB_SEPARATOR_IDX]		int|string	The mailbox hierarchy. Typical values include 0, "/" or ".". 0 is for the parent folder aka INBOX

sessobj->mailboxes[x][MB_HIERARCHY_IDX]		array(string)	Array of the foldername and maybe on of its children. If sizeof > 1, then there is a child for this folder.

sessobj->foldersinfo				mapping		
sessobj->foldertoscan				array
sessobj->nodefoldersinfo			mapping

Here is an example of sessobj->mailboxes when there is only the INBOX mailbox:

sessobj->mailboxes = 
({ /* 1 element */
  ({ /* 5 elements */
     "INBOX",
     "INBOX",
     2,
     0,
     ({ /* 1 element */
       "INBOX"
     })
   })
})


@


1.2
log
@Current 1.3 is removed.
@
text
@@


1.1
log
@Added a little doc about some well used imapclient variables.
Maybe someone who know better imapclient can complete some of them.
@
text
@d6 1
a6 1
$Id$
@


1.1.1.1
log
@1.3 sync with 1.2
@
text
@d6 1
a6 1
$Id: mailboxes,v 1.1 2002/05/07 07:34:46 gourdelier Exp $
@


