Andreas Solberg once wrote a piece of software called MailIn, written in Perl, to parse incoming email from third party monitoring systems and to translate them into NAV events.
We would to like to include such a system as part of NAV, but since we do have a long term goal of reducing the number of used programming languages, we would like this to be reimplemented as a Python program. This would enable it to make use of the common Python API that NAV already offers.
The University of Tromsø have already started writing a MailIn replacement in Python, and this is up and running at the University, but with only a single plugin.
This blueprint specifies the design required to include such a software component in NAV, and most of is derived from the good documentation of the Perl version.
authorizefunction. If it doesn't, MailIn core attempts to authorize the payload according to global rules.
nav.eventAPI, one or more events should be generated and posted to the event queue.
A MailIn plugin consists of a Python module, which should provide three functions:
| ||yes||Must return a true value if the payload can be processed by this plugin.|
| ||no||Must return a true value if the payload is authorized to generate an event, according to plugin-internal rules/configuration. If this function is not supplied by the plugin, the MailIn core must use a global authorize function to perform authorization according to globally configured rules.|
| ||yes||Process the payload, generate and post a single or multiple events. Return a true value if successful.|
The plugin must expect the
payload object to be a message object from Python's standard email library.
“nav.mailin.plugins.*”will result in the loading of all modules in the
Example configuration file:
[mailin] # What plugins to load plugins = nav.mailin.plugins.* # Global authorization check (header regexp pattern) # check to see that uit.no is in the Received headers authorization = ^Received:.*uit\.no # Plugin specific options [nav.mailin.plugins.whatsup] plugin_specific_value=foo
The following Python / NAV libraries should be used for various aspects of the program:
| ||Parsing email payloads into Python objects that will be passed around internally|
| ||Any logging should be performed using named loggers from Python's logging library|
| ||Creating and posting events to NAV's event queue|
As of this writing, there is no API to create custom event type and alert type hierarchies in the NAV database. This will be added as a separate blueprint in Launchpad.