phpgroupware-cvs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Phpgroupware-cvs] email/inc class.spell_struct.inc.php, 1.5 class.spell


From: powerstat
Subject: [Phpgroupware-cvs] email/inc class.spell_struct.inc.php, 1.5 class.spell_svc_php.inc.php, 1.5 class.bopreferences.inc.php, 1.26 class.spell.inc.php, 1.5 class.svc_debug.inc.php, 1.4 class.email_service.inc.php, 1.3 class.msg_bootstrap.inc.php, 1.5 class.svc_nextmatches.inc.php, 1.5 class.mail_dcom_base_sock.inc.php, 1.28 class.so_mail_msg.inc.php, 1.4 class.mail_dcom_base.inc.php, 1.12 class.bomessage.inc.php, 1.17 class.html_widgets.inc.php, 1.6 class.bosend.inc.php, 1.14 class.spell_svc_none.inc.php, 1.5 class.bojsaddressbook.inc.php, 1.4
Date: Wed, 11 May 2005 20:06:00 +0200

Update of email/inc

Modified Files:
     Branch: MAIN
            class.spell_struct.inc.php lines: +51 -56
            class.spell_svc_php.inc.php lines: +33 -43
            class.bopreferences.inc.php lines: +20 -20
            class.spell.inc.php lines: +88 -65
            class.svc_debug.inc.php lines: +17 -31
            class.email_service.inc.php lines: +25 -143
            class.msg_bootstrap.inc.php lines: +29 -41
            class.svc_nextmatches.inc.php lines: +17 -31
            class.mail_dcom_base_sock.inc.php lines: +241 -135
            class.so_mail_msg.inc.php lines: +18 -32
            class.mail_dcom_base.inc.php lines: +21 -37
            class.bomessage.inc.php lines: +20 -21
            class.html_widgets.inc.php lines: +37 -48
            class.bosend.inc.php lines: +11 -7
            class.spell_svc_none.inc.php lines: +34 -42
            class.bojsaddressbook.inc.php lines: +18 -30

Log Message:
Added phpdocs

====================================================
Index: email/inc/class.spell_struct.inc.php
diff -u email/inc/class.spell_struct.inc.php:1.4 
email/inc/class.spell_struct.inc.php:1.5
--- email/inc/class.spell_struct.inc.php:1.4    Sun Mar 13 23:22:44 2005
+++ email/inc/class.spell_struct.inc.php        Wed May 11 18:06:59 2005
@@ -1,71 +1,67 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare                            
        *
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - SpellChecking Header Include file
+       *
+       * Structures shared between Spell Checking and HTML widgets
+       * A simple C-Style Include .h file, holds public data structure classes 
for
+       * class email spell.
+       * Class Email Spell can be used with other classess such as the html 
widget class,
+       * however the html widget class, in this example, must be made aware of 
any data
+       * structures that the spell class may pass to it. Use this file like an 
include
+       * file for such purposes. I suggest require_once.
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - E-Mail SpellChecking Header Include file                  
        *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Class Structures shared between Spell Checking and HTML widgets       
        *
-       * Copyright (C) 2002 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
+

-       /* $Id$ */
-       /*!
-       @class spell_struct
-       @abstract A simple C-Style Include .h file, holds public data structure 
classes for class email spell
-       @discussion  Class Email Spell can be used with other classess such as 
the html widget class,
-       however the html widget class, in this example, must be made aware of 
any data structures
-       that the spell class may pass to it. Use this file like an include file 
for such purposes. I
-       suggest require_once.
-       */
-
-       
/**************************************************************************\
-       *       CONSTANTS - custom for our use here
-       
\**************************************************************************/
-
-       /*!
-       @constant SP_FEED_
-       @abstract does dpell checker want single words or lines of text, 
SP_FEED_UNKNOWN or SP_FEED_WORDS or SP_FEED_LINES
-       @author Angles
-       @discussion there should be different ways to spell check depending on 
what your system has installed.
-       The php builtin pspell extension appears to take one word at a time, 
the command line version of aspell
-       takes a string, a line of text, at one time. class.spell constructor 
should determine this and fill $this->sp_feed_type.
-       */
+       /**
+        * Unknown what spell checker wants
+        */
        define('SP_FEED_UNKNOWN',1);
+       /**
+        * Spell checker want single words
+        */
        define('SP_FEED_WORDS',2);
+       /**
+        * Spell checker want lines of text
+        */
        define('SP_FEED_LINES',4);

-       /*!
-       @class correction_info
-       @abstract   coherently combine spelling suggextions with the original 
text
-       @param $orig_word string
-       $line_num int
-       $word_num int
-       $suggestions array of strings
-       @discussion  holds information about a misspelled word including where
-       it appears in the original text and up to MAX_SUGGEST suggestions
-       */
+
+       /**
+       * Coherently combine spelling suggextions with the original text
+       *
+       * Holds information about a misspelled word including where
+       * it appears in the original text and up to MAX_SUGGEST suggestions.
+       * There should be different ways to spell check depending on what your 
system
+       * has installed. The php builtin pspell extension appears to take one 
word
+       * at a time, the command line version of aspell takes a string, a line 
of text,
+       * at one time. class.spell constructor should determine this and fill 
$this->sp_feed_type.
+       * @package email
+       */
        class correction_info
        {
-               // coherently combine spelling suggextions with the original 
text
+               /**
+                * @var string $orig_word
+                */
                var $orig_word;
                var $orig_word_clean;
+               /**
+                * @var integer $line_num
+                */
                var $line_num;
+               /**
+                * @var integer $word_num
+                */
                var $word_num;
+               /**
+                * @var array $suggestions
+                */
                var $suggestions;

                function correction_info()
@@ -77,5 +73,4 @@
                        $this->suggestions=array();
                }
        }
-
 ?>

====================================================
Index: email/inc/class.spell_svc_php.inc.php
diff -u email/inc/class.spell_svc_php.inc.php:1.4 
email/inc/class.spell_svc_php.inc.php:1.5
--- email/inc/class.spell_svc_php.inc.php:1.4   Sun Mar 13 23:22:44 2005
+++ email/inc/class.spell_svc_php.inc.php       Wed May 11 18:06:58 2005
@@ -1,59 +1,49 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare                            
        *
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - SpellChecking Backend Service Class - for PHP pspell Extension
+       *
+       * This is loaded if PHP has psspell support compiled in. If it is not 
compiled
+       * in, a dummy module spell_ svc_none is loaded so there are no errors 
related
+       * to undefined pspell functions.
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - Email SpellChecking Backend Service Class                 
        *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Email SpellChecking Backend Service Class - for PHP pspell Extension  
*
-       * Copyright (C) 2002 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
-
-       /* $Id$ */
+

-       /*!
-       @class spell_svc_php
-       @abstract Wraps calls to the spell checking backend psspell buildin tp 
PHP
-       @param can_spell (boolean) PRIVATE - flag if this is a working module 
or a dummy one
-       Only the calling spell class should access this, from there it is made 
public.
-       @param $sp_feed_type (defined int) PRIVATE , if tis services takes 
single words or strings,
-       values are defined in spell class, which gets the value from here and 
makes it public.
-       @author  Angles
-       @discussion  This is loaded if PHP has psspell support compiled in. If 
it is not
-       compiled in, a dummy module spell_ svc_none is loaded so there are no 
errors
-       related to undefined pspell functions.
-       */
+       /**
+       * Wraps calls to the spell checking backend psspell buildin tp PHP
+       *
+       * @package email
+       */
        class spell_svc_php
        {
-               
/**************************************************************************\
-               *       VARS
-               
\**************************************************************************/
+               /**
+                * Flag if this is a working module or a dummy one
+                * @var boolean
+                * @access private
+                */
                var $can_spell = True;
+               /**
+                * If tis services takes single words or strings, values are 
defined
+                * in spell class, which gets the value from here and makes it 
public.
+                * @var integer
+                * @access private
+                */
                var $sp_feed_type;

-               
/**************************************************************************\
-               *       CONSTRUCTOR
-               
\**************************************************************************/
+               /**
+               * Constructor
+               */
                function spell_svc_php()
                {
                        $this->can_spell = True;
                        // SP_FEED_WORDS is defined in the spell class.
                        $this->sp_feed_type = SP_FEED_WORDS;
-                       return;
                }

                
/**************************************************************************\

====================================================
Index: email/inc/class.bopreferences.inc.php
diff -u email/inc/class.bopreferences.inc.php:1.25 
email/inc/class.bopreferences.inc.php:1.26
--- email/inc/class.bopreferences.inc.php:1.25  Sun Mar 13 23:22:43 2005
+++ email/inc/class.bopreferences.inc.php       Wed May 11 18:06:59 2005
@@ -1,26 +1,26 @@
 <?php
-       
/***********************************************************************\
-       * phpGroupWare - E-Mail Preferences Handlers                            
        *
-       * http://www.phpgroupware.org                                           
                        *
-       * --------------------------------------------                          
                        *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                                *
-       
\***********************************************************************/
+       /**
+       * EMail - Preferences
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @author Mark Peters <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       */

-       /* $Id$ */

-       /*!
-       @class bopreferences
-       @abstract Much logic of email preference handling is here, especially 
submitting and
-       multiple account preference handling.
-       @author Angles, and skeeter helped on function "preferences"
-       @discussion NOTE: if prefs are submitted that alter anything relative 
to a cached
-       data item, the that cached item MUST BE EXPIRED, for example
-       GLOBALS[phpgw]->msg->expire_session_cache_item("mailserver_callstr")
-       @access public
-       */
+       /**
+       * Preferences
+       *
+       * If prefs are submitted that alter anything relative to a cached data 
item,
+       * the cached item MUST BE EXPIRED, for example
+       * GLOBALS[phpgw]->msg->expire_session_cache_item("mailserver_callstr")
+       * @package email
+       */
        class bopreferences
        {
                var $public_functions = array(

====================================================
Index: email/inc/class.spell.inc.php
diff -u email/inc/class.spell.inc.php:1.4 email/inc/class.spell.inc.php:1.5
--- email/inc/class.spell.inc.php:1.4   Sun Mar 13 23:22:44 2005
+++ email/inc/class.spell.inc.php       Wed May 11 18:06:58 2005
@@ -1,91 +1,98 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare                            
        *
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - SpellChecking Functions
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - E-Mail SpellChecking Functions                            
                *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Handles Spell Checking Email                                          
                        *
-       * Copyright (C) 2002 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
-
-       /* $Id$ */
+

-       /*!
-       @class spell
-       @abstract  Handles spell checking for email messages. Give it all 
necessary data and it handles the rest. All class params are
-       private unless an OOP style access function is provided.
-       @param $max_suggest (int) maximum number is suggestions to show in a 
combobox
-       @param $spell_svc (object) the spell service access class, a dummy 
module if pspell is not compiled in
-       @param $can_spell (boolean) This is picked up from the spell service 
module, a dummy module will report False. Read Only, Access with 
->get_can_spell()
-       @param $sp_feed_type (defined integer) SP_FEED_UNKNOWN or SP_FEED_WORDS 
or SP_FEED_LINES, defined in file class.spell_struct
-       @param $pspell_link (int) a pointer kind of thing you get when you 
create a new pspell dictionary link.
-       @param $my_validator (object of type phpgwapi.validator) used to help 
decide what words to not bother spellchecking, like URLs.
-       @param $widgets (object of type html_widgets)
-       @param $user_lang (string) obtained from "phpgw_info", used when 
creating the pspell disctionary link. Read Only, Access with ->get_user_lang()
-       @param $reject_reason (string) when this class decides a word is not 
worth checking, it fills this with the reason, ex. "do not check URLs"
-       @param $subject (string) use OOP access functions ->set_subject and 
->get_subject.
-       @param $preserve_tokens (array) Scheduled For Depreciation, but still 
used. A list of GPC vars we typically want to preserve
-                       thru the spellchecking process. However, it is too 
limiting to had a hard-coded list, need to allow more flexibility.
-       @param $preserve_vars (array) use OOP access functions 
->set_preserve_var and ->get_preserve_vars. Currently,
-                       you can set any vars you want, but only those in the 
$preserve_tokens will be preserved as hiddenvars. NEEDS FIXING.
-       @param $body_orig  string use OOP access functions ->set_body_orig and 
->get_body_orig.
-                       This is record of the original message before any spell 
check changes.
-       @param $body_display  (PRIVATE) string ACCESS ONLY use OOP access 
functions  ->get_body_display.
-                       Scheduled for depreciation because the function 
"prep_body_display" directly returns this data and
-                       there us no readon to keep it stored in this param. 
"prep_body_display" is quite useful, do not
-                       limit it by bounding it to this param.
-       @param THERE ARE MORE...
-       @discussion  Provide this class with any of the above vars that you 
have. Subject and Body will be
-       spellchecked, but the other data is needed because this class handles 
the rest of the logic from spell
-       checking, to user review of spellcheck, to applying the users choices 
to the body, only then is the
-       message handed off to another object, either class send for sending, or 
class compose if the user wants to
-       edit the text some more. Calling process MUST set any vars it wants 
preserved through the spellcheck
-       process, they will be put in the spellcheck page form.
-       */
+       /**
+       * Handles spell checking for email messages. Give it all necessary data 
and it
+       * handles the rest. All class params are private unless an OOP style 
access
+       * function is provided.
+       *
+       * Provide this class with any of the above vars that you have. Subject 
and
+       * Body will be spellchecked, but the other data is needed because this 
class
+       * handles the rest of the logic from spell checking, to user review of
+       * spellcheck, to applying the users choices to the body, only then is 
the
+       * message handed off to another object, either class send for sending, 
or
+       * class compose if the user wants to edit the text some more. Calling 
process
+       * MUST set any vars it wants preserved through the spellcheck process, 
they
+       * will be put in the spellcheck page form.
+       * @package email
+       */
        class spell
        {
-               
/**************************************************************************\
-               *       VARS
-               
\**************************************************************************/
                var $public_functions = array(
                        'basic_spcheck' => True,
                        'spell_review'  => True,
                        'spell_finished' => True
                );

-               // MAIN CLASS VARS
-               // max suggest is zero based, to 4 suggestions = max_suggest of 
3
+               /**
+                * @var integer $max_suggest Maximum number is suggestions to 
show in a combobox
+                * Max suggest is zero based, to 4 suggestions = max_suggest of 
3
+                */
                var $max_suggest=5;
+               /**
+                * @var object $spell_svc The spell service access class, a 
dummy module if pspell is not compiled in
+                */
                var $spell_svc;
+               /**
+                * @var boolean $can_spell This is picked up from the spell 
service module, a dummy module will report False. Read Only, Access with 
->get_can_spell()
+                */
                var $can_spell = False;
+               /**
+                * @var integer $sp_feed_type SP_FEED_UNKNOWN or SP_FEED_WORDS 
or SP_FEED_LINES, defined in file class.spell_struct
+                */
                var $sp_feed_type=1;
+               /**
+                * @var integer $pspell_link A pointer kind of thing you get 
when you create a new pspell dictionary link.
+                */
                var $pspell_link;
+               /**
+                * @var object $my_validator Used to help decide what words to 
not bother spellchecking, like URLs.
+                */
                var $my_validator;
+               /**
+                * @var object $widgets
+                */
                var $widgets;
                var $msg_bootstrap;
+               /**
+                * @var string $user_lang Obtained from "phpgw_info", used when 
creating the pspell disctionary link. Read Only, Access with ->get_user_lang()
+                */
                var $user_lang='';
+               /**
+                * @var string $reject_reason When this class decides a word is 
not worth checking, it fills this with the reason, ex. "do not check URLs"
+                */
                var $reject_reason='';

                // the form action URI will carry these vars for us:
                // sort, order, start, fldball / msgball, fwd_proc

                // some of the following we must preserve in hidden var
+               /**
+                * @var array $preserve_tokens
+                * A list of GPC vars we typically want to preserve thru the 
spellchecking
+                * process. However, it is too limiting to had a hard-coded 
list, need to
+                * allow more flexibility.
+                * @internal Scheduled For Depreciation, but still used.
+                */
                var $preserve_tokens=array();
+               /**
+                * @var array $preserve_vars
+                * Use OOP access functions ->set_preserve_var and 
->get_preserve_vars.
+                * Currently, you can set any vars you want, but only those in 
the
+                * $preserve_tokens will be preserved as hiddenvars.
+                * @todo NEEDS FIXING.
+                */
                var $preserve_vars=array();
                //var $action='';
                //var $from='';
@@ -94,10 +101,27 @@
                //var $cc='';
                //var $bcc='';
                //var $msgtype='';
+               /**
+                * @var string $subject Use OOP access functions ->set_subject 
and ->get_subject.
+                */
                var $subject='';
+               /**
+                * @var string $body_orig
+                * Use OOP access functions ->set_body_orig and ->get_body_orig.
+                * This is record of the original message before any spell 
check changes.
+                */
                var $body_orig='';
                var $body_array=array();
                var $bad_words=array();
+               /**
+                * @var string $body_display
+                * Scheduled for depreciation because the function 
"prep_body_display"
+                * directly returns this data and there us no readon to keep it 
stored in
+                * this param. "prep_body_display" is quite useful, do not 
limit it by
+                * bounding it to this param.
+                * @internal ACCESS ONLY use OOP access functions  
->get_body_display.
+                * @access private
+                */
                var $body_display='';
                var $body_with_suggest='';
                var $form_open_tags='';
@@ -109,9 +133,9 @@
                var $debug_spell_finished = 0;


-               
/**************************************************************************\
-               *       CONSTRUCTOR
-               
\**************************************************************************/
+               /**
+               * Constructor
+               */
                function spell()
                {
                        if ($this->debug_init > 0) { echo 'ENTERING: 
email.spell.CONSTRUCTOR'.'<br />'."\r\n"; }
@@ -196,7 +220,6 @@
                        if ($this->debug_init > 0) { echo 
'email.spell.CONSTRUCTOR: $this->get_can_spell() returns: 
['.serialize($this->get_can_spell()).']<br />'."\r\n"; }

                        if ($this->debug_init > 0) { echo 'EXIT: 
email.spell.CONSTRUCTOR'.'<br />'."\r\n"; }
-                       return;
                }

                
/**************************************************************************\

====================================================
Index: email/inc/class.svc_debug.inc.php
diff -u email/inc/class.svc_debug.inc.php:1.3 
email/inc/class.svc_debug.inc.php:1.4
--- email/inc/class.svc_debug.inc.php:1.3       Sun Mar 13 23:22:44 2005
+++ email/inc/class.svc_debug.inc.php   Wed May 11 18:06:59 2005
@@ -1,36 +1,22 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare - Debugging Functions      
*
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - Debugging Functions
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2003 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - E-Mail Debugging Functions                                
                *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Copyright (C) 2003 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
-
-       /* $Id$ */
-
-       /*!
-       @class svc_debug
-       @abstract debugging running code utility functions
-       @discussion ?
-       @author Angles
-       */
-
+
+
+       /**
+       * Debugging running code utility functions
+       *
+       * @package email
+       */
        class svc_debug
        {
                // DEBUG OUTPUT TO **UNDER DEVELOPMENT** where to show any 
debug information

====================================================
Index: email/inc/class.email_service.inc.php
diff -u email/inc/class.email_service.inc.php:1.2 
email/inc/class.email_service.inc.php:1.3
--- email/inc/class.email_service.inc.php:1.2   Thu Dec 30 23:13:50 2004
+++ email/inc/class.email_service.inc.php       Wed May 11 18:06:59 2005
@@ -1,259 +1,141 @@
 <?php
-
-/**
-
- * email module service
-
- * @author Philipp Kamps <address@hidden>
-
- * @copyright Copyright (C) 2003 Free Software Foundation http://www.fsf.org/
-
- * @license http://www.fsf.org/licenses/gpl.html GNU General Public License
-
- * @package email
-
- * @subpackage sevice
-
- * @version $Id:
-
- */
-
-
-
+       /**
+       * EMail - Service
+       *
+       * @author @author Philipp Kamps <address@hidden>
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id $
+       */
+
+
+       /**
+       * Service
+       *
+       * @package email
+       */
 class email_service
-
 {
-
-
-
        var $msg_bootstrap; //email.msg_bootstrap
-
        var $bopreferences;

-
-
-       // constructor
-
+       /**
+        * Constructor
+        */
        function email_service()
-
        {
-
                $this->bopreferences = CreateObject('email.bopreferences');
-
        }
-


 /**
-
 * The method provides the list of email folders
-
-* @access public
-
+*
 * @return array
-
+* @access public
 */
-
        function getFolderContent()
-
        {
-
                $tpl_set = 
$GLOBALS['phpgw_info']['user']['preferences']['common']['template_set'];
-
-
-
+
                // make sure we have msg object and a server stream
-
                $this->msg_bootstrap = CreateObject("email.msg_bootstrap");
-
                
$this->msg_bootstrap->ensure_mail_msg_exists('email.bofolder.folder', 
$this->debug);
-
-
-
+
                $standard_account = array ('acctnum'        => 0,
-
                                           'status'         => 'enabled',
-
                                           'display_string' => '[0] standard'
-
                                           );

-
-
                $extra_account_list = $this->bopreferences->ex_accounts_list();

-
-
                array_unshift($extra_account_list, $standard_account);
-
                $account_list = $extra_account_list;

-
-
                $return = array();
-
                for ($i=0; $i < count($account_list); $i++)
-
                {
-
                        if ($account_list[$i]['status'] == 'enabled')
-
                        {
-
                                $account_name = 
substr($account_list[$i]['display_string'],(strrpos($account_list[$i]['display_string'],']')+2));
-
                                $account_name = lang('mailbox').' 
\''.$account_name.'\'';
-
                                $id = 
strval('email_'.$account_list[$i]['acctnum']);
-
                                $return[$id] = array('text'      => 
$account_name,
-
                                                     'parent_id' => '0',
-
                                                     'icon'      => ''
-
                                                          );

-
-
                                $folder_list_i = 
$GLOBALS['phpgw']->msg->get_arg_value('folder_list',$account_list[$i]['acctnum']);

-
-
                                for ($j=0; $j < count($folder_list_i); $j++)
-
                                {
-
                                        $separator = 
$this->get_IMAP_folder_separator($folder_list_i[$j]['folder_long']);
-
                                        $path = explode($separator, 
$folder_list_i[$j]['folder_long']);

-
-
                                        // calculate parent folder
-
                                        if (count($path) == 1)
-
                                        {
-
                                                $parent = 
'email_'.$account_list[$i]['acctnum'];
-
                                        }
-
                                        else
-
                                        {
-
                                                //special handling for the 
courir server
-
                                                if ( $path[count($path) - 2] == 
'INBOX' && $separator == '.' )
-
                                                {
-
                                                        $parent = 
'email_'.$account_list[$i]['acctnum'];
-
                                                }
-
                                                else
-
                                                {
-
                                                        $parent = 
'email_'.$account_list[$i]['acctnum'].'_'.$path[count($path) - 2];
-
                                                }
-
                                        }
-

-
                                        // parse link to view email folder
-
                                        $folderName = 
$GLOBALS['phpgw']->msg->prep_folder_out($folder_list_i[$j]['folder_long']);
-
                                        $folderLink = 
$GLOBALS['phpgw']->link('/index.php','menuaction=email.uiindex.index'.
-
                                                                              
'&fldball[folder]='.$folderName.
-
                                                                              
'&fldball[acctnum]='.$account_list[$i]['acctnum']
-
                                                                              );

-
-
                                        $id = 
'email_'.$account_list[$i]['acctnum'].'_'.$path[count($path)-1];
-
                                        $return[$id] = array('text'      => 
$path[count($path)-1],
-
                                                             'title'     => 
$folder_list_i[$j]['folder_long'],
-
                                                             'icon'      => 
'email/templates/'.$tpl_set.'/images/folders.png',
-
                                                             'parent_id' => 
$parent,
-
                                                             'href'      => 
$folderLink,
-
                                                             'target'    => 
'_parent'
-
                                                            );
-
                                }
-
                        }
-
                }
-
                return array('content' => $return);
-
        }
-


 /**
-
 * Get the IMAP folder separator
-
-* @access privat
-
+*
 * @return string
-
+* @access privat
 */
-
        function get_IMAP_folder_separator($string)
-
        {
-
                //exchange
-
                if (strpos($string, '/'))
-
                {
-
                        $separator = '/';
-
                }
-
                //courir
-
                elseif (strpos($string, '.'))
-
                {
-
                        $separator = '.';
-
                }
-
                else
-
                {
-
                        $separator = 'I doubt this string is used somewhere';
-
                }
-
                return $separator;
-
        }
-
 }
-
 ?>

====================================================
Index: email/inc/class.msg_bootstrap.inc.php
diff -u email/inc/class.msg_bootstrap.inc.php:1.4 
email/inc/class.msg_bootstrap.inc.php:1.5
--- email/inc/class.msg_bootstrap.inc.php:1.4   Sun Mar 13 23:22:44 2005
+++ email/inc/class.msg_bootstrap.inc.php       Wed May 11 18:06:58 2005
@@ -1,49 +1,37 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare                            
        *
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - Bootstrap the mail_msg object
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - Bootstrap the mail_msg object                             
                *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Bootstrap the mail_   msg object                                      
                                *
-       * Copyright (C) 2002 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
-
-       /* $Id$ */
+

-       /*!
-       @class msg_bootstrap
-       @abstract Utility class shared throught out the email app which ensures 
the GLOBALS->msg exists and is logged in
-       @param $do_login (boolean) defaults to True, most often you do not need 
to change this.
-       @author Angles
-       @discussion  only has one function which bootstraps the GLOBALS->msg  
(if necessary). It should be safe to call
-       CreateObject on this class at any time for object 
$GLOBALS[phpgw]->msg_bootstrap because api is smart
-       enough to not re-create it and theres nothing in the constructor, so 
this bootstrap capability should be available
-       at any time to any code file. If there is a problem logging in, 
function GLOBALS["phpgw"]->msg->login_error() is called,
-       giving an error message, and the script exits.
-       @example
-       $GLOBALS["phpgw"]->msg_bootstrap = CreateObject("email.msg_bootstrap");
-       $GLOBALS['phpgw']->msg_bootstrap->login();
-       ## OR, if you care about debug info, an alternative is to use this, 
does the same thing but gives debug info.
-       $GLOBALS['phpgw']->msg_bootstrap->ensure_mail_msg_exists('name of my 
function');
-       @access public
-       */
+       /**
+       * Utility class shared throught out the email app which ensures the 
GLOBALS->msg exists and is logged in
+       *
+       * Processes client side requests for actions like deleting or moving 
mail,
+       * getting attachments and for viewing html mail. Also contains code for 
an
+       * alternative to the redirect as a way to go to the next page view.
+       * Only has one function which bootstraps the GLOBALS->msg  (if 
necessary).
+       * It should be safe to call CreateObject on this class at any time for 
object
+       * $GLOBALS[phpgw]->msg_bootstrap because api is smart enough to not 
re-create
+       * it and theres nothing in the constructor, so this bootstrap 
capability should
+       * be available at any time to any code file. If there is a problem 
logging in,
+       * function GLOBALS["phpgw"]->msg->login_error() is called, giving an 
error
+       * message, and the script exits.
+       * @package email
+       */
        class msg_bootstrap
        {
+               /**
+                * @var boolean $do_login Defaults to True, most often you do 
not need to change this.
+                */
                var $do_login = True;
                //var $do_login = False;
                var $do_login_ex = 0;

====================================================
Index: email/inc/class.svc_nextmatches.inc.php
diff -u email/inc/class.svc_nextmatches.inc.php:1.4 
email/inc/class.svc_nextmatches.inc.php:1.5
--- email/inc/class.svc_nextmatches.inc.php:1.4 Sun Mar 13 23:22:44 2005
+++ email/inc/class.svc_nextmatches.inc.php     Wed May 11 18:06:59 2005
@@ -1,37 +1,23 @@
 <?php
-       
/**************************************************************************\
-       * phpGroupWare API - nextmatchs                                         
                *
-       * This file written by Joseph Engo <address@hidden>                     
*
-       * with email only additions by Angles <address@hidden>          *
-       * Handles limiting number of rows displayed                             
                *
-       * Small Email Only changes adapted from phpGroupWare API                
        *
-       * file by Joseph Engo <address@hidden>                                  
*
-       * Copyright (C) 2000, 2001 Joseph Engo                                  
                *
-       * Email only additions Copyright (C) 2002 Angelo "Angles" Puglisi       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is part of the phpGroupWare API                          
                *
-       * http://www.phpgroupware.org/api                                       
                        *
-       * 
------------------------------------------------------------------------        
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
+       /**
+       * EMail - Handles limiting number of rows displayed
+       *
+       * @author Joseph Engo <address@hidden>
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       */

-       /* $Id$ */
-       /* $Source$ */

-       /*!
-       @class svc_nextmatches
-       @abstract service class for email, implements nextmatches that ONLY 
EMAIL needs
-       */
+       /**
+       * Service class for email, implements nextmatches that ONLY EMAIL needs
+       *
+       * @package email
+       */
        class svc_nextmatches
        {
                var $maxmatches;

====================================================
Index: email/inc/class.mail_dcom_base_sock.inc.php
diff -u email/inc/class.mail_dcom_base_sock.inc.php:1.27 
email/inc/class.mail_dcom_base_sock.inc.php:1.28
--- email/inc/class.mail_dcom_base_sock.inc.php:1.27    Thu May  5 17:48:10 2005
+++ email/inc/class.mail_dcom_base_sock.inc.php Wed May 11 18:06:58 2005
@@ -1,33 +1,41 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare API - MAIL                                                    
                        *
-  * This file written by Mark Peters <address@hidden>                  *
-  * and Angelo "Angles" Puglisi <address@hidden>                               
*
-  * Handles general functionality for mail/mail structures                     
                *
-  * Copyright (C) 2001 Mark Peters                                             
                        *
-  * Copyright (C) 2001, 2002 Angelo "Angles" Puglisi                           
                *
-  * -------------------------------------------------------------------------  
                *
-  * This library is part of the phpGroupWare API                             *
-  * http://www.phpgroupware.org/api                                          *
-  * ------------------------------------------------------------------------ *
-  * This library is free software; you can redistribute it and/or modify it  *
-  * under the terms of the GNU Lesser General Public License as published by *
-  * the Free Software Foundation; either version 2.1 of the License,         *
-  * or any later version.                                                    *
-  * This library is distributed in the hope that it will be useful, but      *
-  * WITHOUT ANY WARRANTY; without even the implied warranty of               *
-  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
-  * See the GNU Lesser General Public License for more details.              *
-  * You should have received a copy of the GNU Lesser General Public License *
-  * along with this library; if not, write to the Free Software Foundation,  *
-  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA            *
-  \**************************************************************************/
+       /**
+       * EMail - Handles general functionality for mail/mail structures
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @author Mark Peters <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2001-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lessser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       */
+

+       /**
+        * Set status->messages to the number of messages in the mailbox
+        */
        define('SA_MESSAGES',1);
+       /**
+        * Set status->recent to the number of recent messages in the mailbox
+        */
        define('SA_RECENT',2);
+       /**
+        * Set status->unseen to the number of unseen (new) messages in the 
mailbox
+        */
        define('SA_UNSEEN',4);
+       /**
+        * Set status->uidnext to the next uid to be used in the mailbox
+        */
        define('SA_UIDNEXT',8);
+       /**
+        * Set status->uidvalidity to a constant that changes when uids for the 
mailbox may no longer be valid
+        */
        define('SA_UIDVALIDITY',16);
+       /**
+        * Set all of the above
+        */
        define('SA_ALL',31);

        define('SORTDATE',0);
@@ -85,17 +93,19 @@
                'dec' => 12
        );

-       /*!
-       @class mailbox_status (sockets)
-       @abstract part of mail Data Communications class
-       @discussion see PHP function: IMAP_STATUS --  This function returns 
status information on a mailbox other than the current one
-       SA_MESSAGES - set status->messages to the number of messages in the 
mailbox
-       SA_RECENT - set status->recent to the number of recent messages in the 
mailbox
-       SA_UNSEEN - set status->unseen to the number of unseen (new) messages 
in the mailbox
-       SA_UIDNEXT - set status->uidnext to the next uid to be used in the 
mailbox
-       SA_UIDVALIDITY - set status->uidvalidity to a constant that changes 
when uids for the mailbox may no longer be valid
-       SA_ALL - set all of the above
-       */
+
+       /**
+       * Part of mail Data Communications class
+       *
+       * Returns status information on a mailbox other than the current one.
+       * Can be used to obtain data on a folder that is NOT currently selected 
(opened)
+       * by the client. For pop3 this difference means nothing, for imap this 
means the
+       * client need NOT select (i.e. open) the target folder before 
requesting status
+       * data. Still, IMAP_STATUS can be used on any folder wheter it is 
currently
+       * selected (opened) or not.
+       * Don't returns size data.
+       * @package email
+       */
        class mailbox_status
        {
                var $messages = '';
@@ -107,103 +117,144 @@
                var $quota = '';
                var $quota_all = '';
        }
-
-       /*!
-       @class mailbox_msg_info (sockets)
-       @abstract part of mail Data Communications class
-       @discussion see PHP function: IMAP_MAILBOXMSGINFO -- Get information 
about the current mailbox
-       @syntax structure returns this data
-       Date            date of last change
-       Driver          driver
-       Mailbox name of the mailbox
-       Nmsgs   number of messages
-       Recent          number of recent messages
-       Unread  number of unread messages
-       Deleted number of deleted messages
-       Size            mailbox size
-       */
+
+
+       /**
+       * Get information about the current mailbox
+       *
+       * Only used for the folder that the client is currently logged into,
+       * for pop3 this is always "INBOX", for imap this is the currently
+       * selected (opened) folder. Therefor, with imap the target folder must
+       * already be selected (via IMAP_OPEN or IMAP_REOPEN)
+       * Returns size data.
+       * This size data adds all the sizes of the messages in that folder
+       * together to get the total folder size.
+       * Some IMAP servers can take alot of time and CPU cycles to get this 
total,
+       * particularly with MAILDIR type imap servers such as Courier-imap, 
while
+       * other imap servers seem to return this size data with little 
difficulty.
+       * @package email
+       */
        class mailbox_msg_info
        {
+               /**
+                * Date of last change
+                */
                var $Date = '';
+               /**
+                * Driver
+                */
                var $Driver ='';
+               /**
+                * Name of the mailbox
+                */
                var $Mailbox = '';
+               /**
+                * Number of messages
+                */
                var $Nmsgs = '';
+               /**
+                * Number of recent messages
+                */
                var $Recent = '';
+               /**
+                * Number of unread messages
+                */
                var $Unread = '';
+               /**
+                * Mailbox size
+                */
                var $Size = '';
        }

-       /*!
-       @class mailbox_status (sockets) discussion VS. class mailbox_msg_info 
(sockets)
-       @abstract compare these two similar classes and their functions
-       @discussion class mailbox_status is used by function IMAP_STATUS
-       class mailbox_msg_info is used by function IMAP_MAILBOXMSGINFO
-       These two functions / classes are similar,  some notes on their usage 
is the example below
-       @example Note 1)
-       IMAP_MAILBOXMSGINFO is only used for the folder that the client is 
currently logged into,
-       for pop3 this is always "INBOX", for imap this is the currently 
selected (opened) folder.
-       Therefor, with imap the target folder must already be selected (via 
IMAP_OPEN or IMAP_REOPEN)
-       Note 2)
-       IMAP_STATUS is can be used to obtain data on a folder that is NOT 
currently selected (opened)
-       by the client. For pop3 this difference means nothing, for imap this 
means the client
-       need NOT select (i.e. open) the target folder before requesting status 
data.
-       Still, IMAP_STATUS can be used on any folder wheter it is currently 
selected (opened) or not.
-       Note 3)
-       The main functional difference is that one function returns size data, 
and the other does not.
-       imap_mailboxmsginfo returns size data, imap_status does NOT.
-       This size data adds all the sizes of the messages in that folder 
together to get the total folder size.
-       Some IMAP servers can take alot of time and CPU cycles to get this 
total,
-       particularly with MAILDIR type imap servers such as Courier-imap, while 
other imap servers
-       seem to return this size data with little difficulty.
-       */

-       /*!
-       @class msg_structure (sockets)
-       @abstract part of mail Data Communications class
-       @discussion see PHP function: imap_fetchstructure --  Read the 
structure of a particular message
-       @syntax structure of return data is this
-       type                    Primary body type
-       encoding                Body transfer encoding
-       ifsubtype               TRUE if there is a subtype string
-       subtype         MIME subtype
-       ifdescription           TRUE if there is a description string
-       description             Content description string
-       ifid                    TRUE if there is an identification string
-       id                      Identification string
-       lines                   Number of lines
-       bytes                   Number of bytes
-       ifdisposition           TRUE if there is a disposition string
-       disposition             Disposition string
-       ifdparameters           TRUE if the dparameters array exists
-       dparameters             Disposition parameter array
-       ifparameters            TRUE if the parameters array exists
-       parameters              MIME parameters array
-       parts                   Array of objects describing each message part
-       */
+       /**
+       * Read the structure of a particular message
+       *
+       * @package email
+       */
        class msg_structure
        {
+               /**
+                * Primary body type
+                */
                var $type = '';
+               /**
+                * Body transfer encoding
+                */
                var $encoding = '';
+               /**
+                * TRUE if there is a subtype string
+                */
                var $ifsubtype = False;
+               /**
+                * MIME subtype
+                */
                var $subtype = '';
+               /**
+                * TRUE if there is a description string
+                */
                var $ifdescription = False;
+               /**
+                * Content description string
+                */
                var $description = '';
+               /**
+                * TRUE if there is an identification string
+                */
                var $ifid = False;
+               /**
+                * Identification string
+                */
                var $id = '';
+               /**
+                * Number of lines
+                */
                var $lines = '';
+               /**
+                * Number of bytes
+                */
                var $bytes = '';
+               /**
+                * TRUE if there is a disposition string
+                */
                var $ifdisposition = False;
+               /**
+                * Disposition string
+                */
                var $disposition = '';
+               /**
+                * TRUE if the dparameters array exists
+                */
                var $ifdparameters = False;
+               /**
+                * Disposition parameter array
+                */
                var $dparameters = array();
+               /**
+                * TRUE if the parameters array exists
+                */
                var $ifparameters = False;
+               /**
+                * MIME parameters array
+                */
                var $parameters = array();
-               // custom phpgw data to aid in building this structure
+               /*
+                * Custom phpgw data to aid in building this structure
+                */
                var $custom = array();
+               /**
+                * Array of objects describing each message part
+                */
                var $parts = array();
        }

-       // gonna have to decide on one of the next two
+       // Gonna have to decide on one of the next two
+
+       /**
+       * Message parameters
+       *
+       * @package email
+       */
        class msg_params
        {
                var $attribute;
@@ -215,12 +266,25 @@
                        $this->value     = $val;
                }
        }
+
+
+       /**
+        * Attribute Parameter
+       *
+       * @package email
+        */
        class att_parameter
        {
                var $attribute;
                var $value;
        }

+
+       /**
+       * Address
+       *
+       * @package email
+       */
        class address
        {
                var $personal;
@@ -229,36 +293,79 @@
                var $adl;
        }

-       /*!
-       @class msg_overview (sockets)
-       @abstract part of mail Data Communications class
-       @discussion see PHP function:  imap_fetch_overview -- Read an overview 
of the information in the
-       headers of the given message. NOT CURRENTY IMPLEMENTED
-       */
+
+       /**
+       * Read an overview of the information in the headers of the given 
message.
+       *
+       * @internal NOT CURRENTLY IMPLEMENTED
+       * @package email
+       */
        class msg_overview
        {
-               var $subject;   // the messages subject
-               var $from;      // who sent it
-               var $date;      // when was it sent
-               var $message_id;        // Message-ID
-               var $references;        // is a reference to this message id
-               var $size;              // size in bytes
-               var $uid;               // UID the message has in the mailbox
-               var $msgno;     // message sequence number in the maibox
-               var $recent;    // this message is flagged as recent
-               var $flagged;   // this message is flagged
-               var $answered;  // this message is flagged as answered
-               var $deleted;   // this message is flagged for deletion
-               var $seen;      // this message is flagged as already read
-               var $draft;     // this message is flagged as being a draft
+               /**
+                * The messages subject
+                */
+               var $subject;
+               /**
+                * who sent it
+                */
+               var $from;
+               /**
+                * when was it sent
+                */
+               var $date;
+               /**
+                * Message-ID
+                */
+               var $message_id;
+               /**
+                * Is a reference to this message id
+                */
+               var $references;
+               /**
+                * size in bytes
+                */
+               var $size;
+               /**
+                * UID the message has in the mailbox
+                */
+               var $uid;
+               /**
+                * message sequence number in the maibox
+                */
+               var $msgno;
+               /**
+                * this message is flagged as recent
+                */
+               var $recent;
+               /**
+                * this message is flagged
+                */
+               var $flagged;
+               /**
+                * this message is flagged as answered
+                */
+               var $answered;
+               /**
+                * this message is flagged for deletion
+                */
+               var $deleted;
+               /**
+                * this message is flagged as already read
+                */
+               var $seen;
+               /**
+                * this message is flagged as being a draft
+                */
+               var $draft;
        }

-       /*!
-       @class hdr_info_envelope (sockets)
-       @abstract part of mail Data Communications class
-       @discussion see PHP function:  imap_headerinfo -- Read the header of 
the message
-       see PHP function:   imap_header  which is simply an alias to 
imap_headerinfo
-       */
+
+       /**
+       * Read the header of the message
+       *
+       * @package email
+       */
        class hdr_info_envelope
        {
                // --- Various Header Data ---
@@ -304,18 +411,17 @@
                var $Size = '';
        }

-       /*!
-       @class mail_dcom_base (sockets)
-       @abstract part of mail Data Communications class
-       @discussion mail_dcom_base Extends phpgw api class network
-       After mail_dcom_base is loaded, a top level class mail_dcom is created
-       specifically for the necessary propocol, either POP3, IMAP, or NNTP
-       @syntax CreateObject('email.mail_dcom');
-       @author Angles, Skeeter, Itzchak Rehberg, Joseph Engo
-       @copyright LGPL
-       @package email (to be moved to phpgwapi when mature)
-       @access public
-       */
+
+       /**
+       * After mail_dcom_base is loaded, a top level class mail_dcom is created
+       * specifically for the necessary propocol, either POP3, IMAP, or NNTP
+       *
+       * @author Angles
+       * @author Skeeter
+       * @author Itzchak Rehberg
+       * @author Joseph Engo
+       * @package email
+       */
        class mail_dcom_base extends network
        {
                // OBSOLETED "folder_list_changed" by the newer function 
"folder_list_did_change"

====================================================
Index: email/inc/class.so_mail_msg.inc.php
diff -u email/inc/class.so_mail_msg.inc.php:1.3 
email/inc/class.so_mail_msg.inc.php:1.4
--- email/inc/class.so_mail_msg.inc.php:1.3     Sun Mar 13 23:22:44 2005
+++ email/inc/class.so_mail_msg.inc.php Wed May 11 18:06:58 2005
@@ -1,37 +1,23 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Message Data Storage for Caching Functions         
*
-       * http://www.anglemail.org                                              
                        *
-       */
-       
/**************************************************************************\
-       * AngleMail - E-Mail Message Data Storage for Caching Functions         
        *
-       * This file written by Angelo Puglisi (Angles) <address@hidden> *
-       * Handles data storage functions for email caching of data              
        *
-       * Copyright (C) 2001, 2002, 2003 Angelo Tony Puglisi (Angles)           
                *
-       * 
------------------------------------------------------------------------        
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
        *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
-
-       /* $Id$ */
-
-       // =====  INTERFACE FUNCTIONS AND/OR  WRAPPER FUNCTIONS =====
-
-       /*!
-       @class so_mail_msg
-       @abstract E-Mail Message Data Storage for Data Caching
-       @discussion ?
-       @author Angles
+       /**
+       * EMail - Message Data Storage for Caching Functions
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2003 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
+
+
+       /**
+       * E-Mail Message Data Storage for Data Caching
+       *
+       * INTERFACE FUNCTIONS AND/OR  WRAPPER FUNCTIONS
+       * @package email
+       */
        class so_mail_msg
        {
                var $use_group_data=True;

====================================================
Index: email/inc/class.mail_dcom_base.inc.php
diff -u email/inc/class.mail_dcom_base.inc.php:1.11 
email/inc/class.mail_dcom_base.inc.php:1.12
--- email/inc/class.mail_dcom_base.inc.php:1.11 Sun Mar 13 23:22:44 2005
+++ email/inc/class.mail_dcom_base.inc.php      Wed May 11 18:06:58 2005
@@ -1,42 +1,26 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail     http://www.anglemail.org                                
                                *
-       */
-       
/**************************************************************************\
-       * AngleMail - E-Mail Data Communications Class Core Functions           
        *
-       * This file written by Angelo "Angles" Puglisi <address@hidden> *
-       * Copyright (C) 2001-2002 Angelo "Angles" Puglisi                       
                        *
-       * 
-------------------------------------------------------------------------       
                                      *
-       * Most funtions have an authors line which attempts to identify and 
credit      *
-       * any previous authors and maintainers.                                 
                        *
-       * AngleMail appreciates the hard work of previous authors and 
maintainers.      *
-       * 
-------------------------------------------------------------------------       
                      *
-       * This file designed to work as part of a drop in email module for      
        *
-       * phpGroupWare  http://www.phpgroupware.org                             
        *
-       * 
-------------------------------------------------------------------------       
                      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
        *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of            
*
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
-
-       /* $Id$ */
-
-       /*!
-       @class mail_dcom_base
-       @abstract E-Mail Data Communications API
-       @discussion Part of a group of files which together comprise the "Data 
Communications"
-       API for AngleMail. Certain files are loaded if IMAP is compiled into 
php, while other
-       files are loaded if the sockets replacement functions are needed.
-       @author Each function has an authors line.
+       /**
+       * EMail - Data Communications Core Functions
+       *
+       * This file designed to work as part of a drop in email module for 
phpgroupware
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
+
+
+       /**
+       * E-Mail Data Communications API
+       *
+       * Part of a group of files which together comprise the "Data 
Communications"
+       * API for AngleMail. Certain files are loaded if IMAP is compiled into 
php,
+       * while other files are loaded if the sockets replacement functions are 
needed.
+       * @package email
+       */
        class mail_dcom_base
        {
                var $msg_struct;

====================================================
Index: email/inc/class.bomessage.inc.php
diff -u email/inc/class.bomessage.inc.php:1.16 
email/inc/class.bomessage.inc.php:1.17
--- email/inc/class.bomessage.inc.php:1.16      Sun Mar 13 23:22:43 2005
+++ email/inc/class.bomessage.inc.php   Wed May 11 18:06:58 2005
@@ -1,26 +1,25 @@
 <?php
-       
/**************************************************************************\
-       * Anglemail - E-Mail    BO for displaying email message content         
*
-       * http://www.anglemail.org                                              
                *
-       * Written by Angelo (Angles) Puglisi <address@hidden>           *
-       * Copyright 2001, 2002 Angelo "Angles" Puglisi
-       * --------------------------------------------                          
                        *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                *
-       
\**************************************************************************/
-
-       /* $Id$ */
-
-       /*!
-       @class bomessage
-       @abtract works with mail_msg class to produce data for displaying a 
message messages
-       @author angles and others, some handling of "to" and "from" data are 
left over from
-       previous maintainers.
-       @discussion takes the complex mime data provided by php, turns it into 
a flat array
-       with human understandable descriptions of what the parts do,
+       /**
+       * EMail - Message content
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
+
+
+       /**
+       * Message content
+       *
+       * Works with mail_msg class to produce data for displaying a message.
+       * Takes the complex mime data provided by php, turns it into a flat 
array
+       * with human understandable descriptions of what the parts do.
+       * @package email
+       */
        class bomessage
        {
                var $public_functions = array(

====================================================
Index: email/inc/class.html_widgets.inc.php
diff -u email/inc/class.html_widgets.inc.php:1.5 
email/inc/class.html_widgets.inc.php:1.6
--- email/inc/class.html_widgets.inc.php:1.5    Sun Mar 13 23:22:44 2005
+++ email/inc/class.html_widgets.inc.php        Wed May 11 18:06:58 2005
@@ -1,43 +1,31 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare                            
        *
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - HTML Widgets and Utility Functions
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - HTML Widgets                                              
                        *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Email related HTML Widgets and Utility Functions                      
                *
-       * Copyright (C) 2002 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
+

-       /* $Id$ */
-       /*!
-       @class html_option
-       @abstract data structure used with class html_widgets
-       @param $value (class var) (string) this options value that will be 
submitted if selected
-       @param $text (class var) (string) the text the user sees, a description 
of this option
-       @param $selected  (class var) (boolean)  whether this option should be 
pre-selected in a combobox, default False
-       @author Angles
-       @discussion used in making select text, value items, such as in the 
combobox widget.
-       @access private
-       */
+       /**
+       * Data structure used with class html_widgets
+       *
+       * Used in making select text, value items, such as in the combobox 
widget.
+       * @package email
+       * @access private
+       */
        class html_option
        {
+               // @param $value (class var) (string) this options value that 
will be submitted if selected
                var $value;
+               // @param $text (class var) (string) the text the user sees, a 
description of this option
                var $text;
+               // @param $selected  (class var) (boolean)  whether this option 
should be pre-selected in a combobox, default False
                var $selected;

                function html_option()
@@ -48,12 +36,13 @@
                }
        }

-       /*!
-       @class hiddenvar_option
-       @abstract data structure used with hidden data in forms
-       @discussion ?
-       @access private
-       */
+
+       /**
+       * Data structure used with hidden data in forms
+       *
+       * @package email
+       * @access private
+       */
        class hiddenvar_option
        {
                var $name;
@@ -66,15 +55,15 @@
                }
        }

-       /*!
-       @class html_widgets
-       @abstract generate HTML widgets for use in web pages.
-       @author Angles
-       @access public
-       @discussion OOP style class for producing common widgets in html pages, 
such as a combobox.
-       Designed to reduce bain damage to the developer by hiding the details 
of the html tags and by
-       treating these things as widgets which is what they are, more than just 
simple html markup.
-       */
+
+       /**
+       * Generate HTML widgets for use in web pages.
+       *
+       * Producing common widgets in html pages, such as a combobox.
+       * Designed to hiding the details of the html tags and by treating these
+       * things as widgets which is what they are, more than just simple html 
markup.
+       * @package email
+       */
        class html_widgets
        {
                
/**************************************************************************\

====================================================
Index: email/inc/class.bosend.inc.php
diff -u email/inc/class.bosend.inc.php:1.13 email/inc/class.bosend.inc.php:1.14
--- email/inc/class.bosend.inc.php:1.13 Sun Mar 13 23:22:44 2005
+++ email/inc/class.bosend.inc.php      Wed May 11 18:06:58 2005
@@ -1,20 +1,24 @@
 <?php
        /**
-       * phpGroupWare - email send non-SMTP functions
+       * EMail - Send non-SMTP functions
+       *
        * @author Angelo (Angles) Puglisi <address@hidden>
-       * @author Dave Hall - skwashd at phpgroupware.org
-       * @copyright Portions Copyright (C) 2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @author Dave Hall <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
        * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
        * @package email
        * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       * @internal Server side attachment storage technique borrowed from 
Squirrelmail
        */


        /**
-       * class bosend
+       * Send non-SMTP functions
        *
-       * bo class for assembling messages for sending via class send
-       * @internal server side attachment storage technique borrowed from 
Squirrelmail
+       * Assembling messages for sending
+       * @package email
        */
        class bosend
        {

====================================================
Index: email/inc/class.spell_svc_none.inc.php
diff -u email/inc/class.spell_svc_none.inc.php:1.4 
email/inc/class.spell_svc_none.inc.php:1.5
--- email/inc/class.spell_svc_none.inc.php:1.4  Sun Mar 13 23:22:44 2005
+++ email/inc/class.spell_svc_none.inc.php      Wed May 11 18:06:58 2005
@@ -1,53 +1,45 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Module for phpGroupWare                            
        *
-       * http://www.anglemail.org                                              
                        *
-       * http://www.phpgroupware.org                                           
                        *
+       /**
+       * EMail - SpellChecking Backend Service Class - Dummy Class
+       *
+       * If PHP psspell support is not compiled in,  this  dummy module
+       * spell_svc_none is loaded so there are no errors related to undefined
+       * pspell functions.
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General 
Public License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
-       
/**************************************************************************\
-       * AngleMail - Email SpellChecking Backend Service Class                 
        *
-       * This file written by "Angles" Angelo Puglisi <address@hidden> *
-       * Email SpellChecking Backend Service Class - Dummy Class               
        *
-       * Copyright (C) 2002 Angelo Tony Puglisi (Angles)                       
                *
-       * 
-------------------------------------------------------------------------       
      *
-       * This library is free software; you can redistribute it and/or modify 
it               *
-       * under the terms of the GNU Lesser General Public License as published 
by      *
-       * the Free Software Foundation; either version 2.1 of the License,      
                *
-       * or any later version.                                                 
                                *
-       * This library is distributed in the hope that it will be useful, but   
                *
-       * WITHOUT ANY WARRANTY; without even the implied warranty of    *
-       * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  *
-       * See the GNU Lesser General Public License for more details.           
        *
-       * You should have received a copy of the GNU Lesser General Public 
License      *
-       * along with this library; if not, write to the Free Software 
Foundation,               *
-       * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA         
        *
-       
\**************************************************************************/
+

-       /* $Id$ */
-
-       /*!
-       @class spell_svc_none
-       @abstract  dummy placeholder for spell-less installations
-       @param can_spell (boolean) PRIVATE - flag if this is a working module 
or a dummy one
-       Only the calling spell class should access this, from there it is made 
public.
-       @param $sp_feed_type (defined int) PRIVATE , if tis services takes 
single words or strings,
-       values are defined in spell class, which gets the value from here and 
makes it public.
-       @author Angles
-       @discussion  If PHP psspell support is not compiled in,  this  dummy 
module
-       spell_ svc_none is loaded so there are no errors related to undefined 
pspell functions.
-       @access public
-       */
+       /**
+       * Dummy placeholder for spell-less installations
+       *
+       * @package email
+       */
        class spell_svc_none
        {
-               
/**************************************************************************\
-               *       VARS
-               
\**************************************************************************/
+               /**
+                * Flag if this is a working module or a dummy one.
+                *
+                * @var boolean $can_spell F
+                * @access private
+                */
                var $can_spell = False;
+               /**
+                * If tis services takes single words or strings, values are 
defined
+                * in spell class, which gets the value from here and makes it 
public.
+                * @var integer $sp_feed_type
+                * @access private
+                */
                var $sp_feed_type;

-               
/**************************************************************************\
-               *       CONSTRUCTOR
-               
\**************************************************************************/
+               /**
+               * Constructor
+               */
                function spell_svc_none()
                {
                        // this is a dummy module for installations with no 
spell capability

====================================================
Index: email/inc/class.bojsaddressbook.inc.php
diff -u email/inc/class.bojsaddressbook.inc.php:1.3 
email/inc/class.bojsaddressbook.inc.php:1.4
--- email/inc/class.bojsaddressbook.inc.php:1.3 Sun Mar 13 23:22:43 2005
+++ email/inc/class.bojsaddressbook.inc.php     Wed May 11 18:06:58 2005
@@ -1,35 +1,23 @@
 <?php
-/**************************************************************************\
- * phpGroupWare - Todo list                                                 *
- * http://www.phpgroupware.org                                              *
- * Written by Alex Borges <address@hidden>                          *
- * Low Level Design also by    Dave Hall address@hidden                        
  *
- * UI Design and market research by Gerardo Ramirez address@hidden
- *-----------------------------------------------                          *
- *  This program is free software; you can redistribute it and/or modify it *
- *  under the terms of the GNU General Public License as published by the   *
- *  Free Software Foundation; either version 2 of the License, or (at your  *
- *  option) any later version.                                              *
- \**************************************************************************/
+       /**
+       * EMail - JavaScript addressbook
+       *
+       * @author Alex Borges <address@hidden>
+       * @author Dave Hall <address@hidden>
+       * @author Gerardo Ramirez <address@hidden>
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal
+       */

-/*!
-  @class bojsaddressbiij
-  @abstract logic for the javascript addressbook is here
-  @author Lex
-  @ discussion  Understand that
-  this is my first attempt to a bo,ui pair of objects
-  that will do the job. I turned to do this because
-  this thingie has to be available for use by all the
-  phpgw 0.9.14 apps.
-  My approach is to use abstraction as much as possible.
-  This class will handle all data. DATA you hear?
-  This means that the state of the abstraction we call
-  the cool addressbook chooser is here.... THE STATE!
-  Nothing webish about this file. This file will no receive
-  ever variables from HTTP_POST or GET. That is for the UI class
-  to handle. This class has methods that receive parameters so you
-  can use it from anyware.
- */
+
+       /**
+       * JavaScript addressbook
+       *
+       * @package email
+       */
         class bojsaddressbook
        {
                //@param $contacts phpgwapi contacts object






reply via email to

[Prev in Thread] Current Thread [Next in Thread]