[dev] Fancy Horde/Imap_Client documentation

[Michael J Rubinsky]

Quoting Michael M Slusarz <slusarz at horde.org>:

> Finally.  It's about time.
>
> Initial implementation has been placed here:
>
> http://dev.horde.org/imap_client/
>
> (Looks a bit like the Routes documentation for some reason...)
>
> Not sure if this is the best place to store this.  Comments welcome.  
>  And ideas how to link from our main www.horde.org pages is also  
> welcome.
>
> Also would be interested to hear thoughts on what else to put on  
> there.  Obviously the examples page needs to be fleshed out more,  
> but I'm not going to spend the time doing too much unless/until  
> people actually start using it.  So if anybody wants examples of a  
> certain feature, now is the time to speak up.

Great start Michael.

I normally prefer to read the inline phpdoc while coding with a new  
library and I felt the existing phpdoc more than met my needs.  
However, if it helps, these are the areas that I personally focused on  
while developing ActiveSync email support, and would have liked to  
have had some more examples:

- Without giving a lesson on the purpose of MODSEQ values etc...  
examples on the use of MODSEQ values and the 'changedsince' parameters  
to fetch recently changed messages.

- Fetching messages that have VANISHED, with a description of why you  
should provide a list of known UIDs when requesting VANISHED messages  
(lesson learned the hard way for me).

- Fetching only certain MIME parts.

- Dealing with encoding issues.

- Using the various options of the search/fetch query object to change  
what is returned.
-- 
mike

The Horde Project (www.horde.org)
mrubinsk at horde.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-keys
Size: 2200 bytes
Desc: PGP Public Key
URL: <http://lists.horde.org/archives/dev/attachments/20130618/7c7b036e/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 6062 bytes
Desc: S/MIME Cryptographic Signature
URL: <http://lists.horde.org/archives/dev/attachments/20130618/7c7b036e/attachment-0001.bin>