django-postman / docs / quickstart.rst

Quick start guide

Requisites and dependances

Python version >= 2.6

Some reasons:

  • use of str.format()

Django version >= 1.2.2

Some reasons:

  • use of self.stdout in management commands

Installation

Get the code from the repository, which is hosted at Bitbucket.

You have two main ways to obtain the latest code and documentation:

With the version control software Mercurial installed, get a local copy by typing:

hg clone http://bitbucket.org/psam/django-postman/

Or download a copy of the package, which is available in several compressed formats, either from the Download tab or from the get source menu option.

In both case, make sure the directory is accessible from the Python import path.

Configuration

Required settings

Add postman to the INSTALLED_APPS setting of your project.

Run a :command:`manage.py syncdb`

Include the URLconf postman.urls in your project's root URL configuration.

Optional settings

If you want to make use of a postman_unread_count context variable in your templates, add postman.context_processors.inbox to the TEMPLATE_CONTEXT_PROCESSORS setting of your project.

You may specify some additional configuration options in your :file:`settings.py`:

POSTMAN_DISALLOW_ANONYMOUS

Set it to True if you do not allow visitors to write to users. That way, messaging is restricted to a User-to-User exchange.

Defaults to: False.

POSTMAN_DISALLOW_MULTIRECIPIENTS

Set it to True if you do not allow more than one username in the recipient field.

Defaults to: False.

POSTMAN_DISALLOW_COPIES_ON_REPLY

Set it to True if you do not allow additional recipients when replying.

Defaults to: False.

POSTMAN_AUTO_MODERATE_AS

The default moderation status when no auto-moderation functions, if any, were decisive.

  • True to accept messages.
  • False to reject messages.
  • None to leave messages to a moderator review.

Defaults to: None.

To disable the moderation feature (no control, no filter):

  • Set this option to True
  • Do not provide any auto-moderation functions
POSTMAN_NOTIFIER_APP

A notifier application name, used in preference to the basic emailing, to notify users of their rejected or received messages.

Defaults to: 'notification', as in django-notification.

If you already have a notifier application with the default name in the installed applications but you do not want it to be used by this application, set the option to None.

POSTMAN_MAILER_APP

An email application name, used in preference to the basic django.core.mail, to send emails.

Defaults to: 'mailer', as in django-mailer.

If you already have a mailer application with the default name in the installed applications but you do not want it to be used by this application, set the option to None.

POSTMAN_AUTOCOMPLETER_APP

An auto-completer application specification, useful for recipient fields. To enable the feature, define a dictionary with these keys:

  • 'name'

    The name of the auto-completer application. Defaults to 'ajax_select'

  • 'field'

    The model class name. Defaults to 'AutoCompleteField'

  • 'arg_name'

    The name of the argument Defaults to 'channel'

  • 'arg_default'

    No default value. This is a mandatory default value, but you may supersede it in the field definition of a custom form or pass it in the url pattern definitions.

Defaults to: an empty dictionary.

Templates

A complete set of working templates is provided with the application. You may use it as it is with a CSS design of yours, re-use it or extend some parts of it, or only view it as an example.

Relations between templates:

base.html
|_ base_folder.html
|  |_ inbox.html
|  |_ sent.html
|  |_ archives.html
|  |_ trash.html
|_ base_write.html
|  |_ write.html
|  |_ reply.html
|_ view.html

If the django-ajax-selects application is used, the following URLs are referenced by this set:

  • {% admin_media_prefix %}js/jquery.min.js
  • {{ MEDIA_URL }}js/jquery.autocomplete.min.js
  • {{ MEDIA_URL }}css/jquery.autocomplete.css
  • {{ MEDIA_URL }}css/indicator.gif

The :file:`postman/base.html` template extends a :file:`base.html` site template, in which some blocks are expected:

  • title: in <html><head><title>, at least for a part of the entire title string
  • extrahead: in <html><head>, to put some <script> and <link> elements
  • content: in <html><body>, to put the page contents
  • postman_menu: in <html><body>, to put a navigation menu

Medias

A CSS file is provided with the application, for the Admin site: :file:`postman/css/admin.css`. It is not obligatory but makes the display more confortable.

The file is provided under :file:`postman/medias/`. It's up to you to make it visible to the URL resolver.

For example:

  • In a production environment, set :file:`/<MEDIA_URL>/postman/` as a symlink to :file:`<Postman_module>/medias/postman/`

  • In a development environment (django's runserver), you can put in the URLconf, something like:

    ('^' + settings.MEDIA_URL.strip('/') + r'/(?P<path>postman/.*)$', 'django.views.static.serve',
        {'document_root': os.path.join(imp.find_module('postman')[1], 'medias')}),
    

See also :ref:`styles` for the stylesheets of views.

Examples

:file:`settings.py`:

INSTALLED_APPS = (
    # ...
    'postman',
    # ...
    # 'pagination'
    # 'ajax_select'
    # 'notification'
    # 'mailer'
)
# POSTMAN_DISALLOW_ANONYMOUS = True # default is False
# POSTMAN_DISALLOW_MULTIRECIPIENTS = True # default is False
# POSTMAN_DISALLOW_COPIES_ON_REPLY = True # default is False
# POSTMAN_AUTO_MODERATE_AS = True # default is None
# POSTMAN_NOTIFIER_APP = None # default is 'notification'
# POSTMAN_MAILER_APP = None # default is 'mailer'
# POSTMAN_AUTOCOMPLETER_APP = {
    # 'name': '', # default is 'ajax_select'
    # 'field': '', # default is 'AutoCompleteField'
    # 'arg_name': '', # default is 'channel'
    # 'arg_default': 'postman_friends', # no default, mandatory to enable the feature
# } # default is {}

:file:`urls.py`:

(r'^messages/', include('postman.urls')),
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.