Skip to content
Jack Dodds edited this page Feb 28, 2018 · 10 revisions

Technical documentation

New to Mailpile development? Want to contribute? Thinking of writing a plugin? Read on...

Turning on debugging

If you're developing Mailpile, you probably want a lot more debug output than otherwise. Simply:

set sys.debug = ["log"]

where ["log"] is a list of types of debug messages you want to see printed out. Options include:

  • log
  • http
  • gnupg
  • cryptostate
  • sources
  • keywords
  • vcard
  • pop3
  • imap
  • imaplib
  • rescan
  • autotag
  • oauth
  • jinja
  • timing
  • httpdata
  • connbroker

Testing

  • compose
  • sendmail

See also Debugging actual data

Writing plugins

Committing to Mailpile core

  • Come hang out on our IRC channel - introduce yourself. It's easier to get into things if you chat with us. :-)
  • If you're a backend developer, go read mailpile/app.py, mailpile/command.py and mailpile/ui.py at the very least. Take note of the "session" and "config" objects that are floating about. They're very central.
  • If you're a frontend developer, read Front End Development Guide, familiarize yourself with the Commands structure, the Search Result Json and the Jinja2 templating engine. Then visit Themes
Clone this wiki locally