Ticket #536 (assigned enhancement )

Opened 5 years ago

Last modified 3 months ago

Add IMAP server howto

Reported by: spiv Assigned to: thijs (accepted)
Type: enhancement Priority: normal
Milestone: Component: mail
Keywords: documentation Cc: exarkun, spiv, thijs
Branch: branches/imap-howto-536 Author: thijs
Launchpad Bug:

Attachments

imap-howto-536.patch (1.9 kB) - added by thijs 4 months ago.

Change History

  2004-03-04 06:33:58+00:00 changed by spiv 

This email from JP:
    http://twistedmatrix.com/pipermail/twisted-python/2004-March/007247.html
would serve as a good basis for a mini-howto on writing IMAP servers.

  2006-06-24 23:01:12+00:00 changed by hypatia

  • cc changed from exarkun, spiv, hypatia to exarkun, spiv
  • owner changed from hypatia to edsuom
  • component changed from conch to mail

  2008-07-01 04:59:17+00:00 changed by collab

  • cc changed from exarkun, spiv to exarkun, spiv, collab
  • owner changed from edsuom to collab
  • status changed from new to assigned
  • branch deleted
  • author deleted

  2008-07-09 17:10:23+00:00 changed by thijs

  • cc changed from exarkun, spiv, collab to exarkun, spiv, thijs
  • owner changed from collab to thijs
  • status changed from assigned to new

  2008-07-13 09:08:30+00:00 changed by thijs

  • attachment imap-howto-536.patch added

  2008-07-13 09:09:34+00:00 changed by thijs

  • keywords changed from documentation to documentation, review
  • owner deleted

See attached patch for a howto based on the mailinglist post.

  2008-07-15 00:42:12+00:00 changed by exarkun

  • keywords changed from documentation, review to documentation
  • owner set to thijs

Thanks. Still needs some work, I suppose:

  • should start out with some sections which should be standard in our docs:
    • what you can expect to learn to do by reading this doc
    • what you should already know before trying to read it
  • more markup, eg links to api docs where appropriate
  • __implements__ is wicked obsolete
  • Actually implement the interface here should probably actually implement at least some of the interface. I don't know how much; IMAP4 is complicated, IAccount is a bit large. It's not immediately obvious to me what can be said most usefully here.
  • should end with links to other related documentation

The only kind of feedback I can remember consistently getting about howtos is that they should contain executable examples.

  2008-07-17 11:46:18+00:00 changed by thijs

  • status changed from new to assigned

  2008-08-23 14:15:33+00:00 changed by thijs

  • branch set to branches/imap-howto-536
  • author set to thijs

(In [24626]) Branching to 'imap-howto-536'

Note: See TracTickets for help on using tickets.