Mail NodeBrain Module

Permission is granted to copy, distribute and/or modify this document under the terms of either the MIT License (Expat) or NodeBrain License. See the Licenses section at the end of this document for details.

Short Table Of Contents

Mail NodeBrain Module
1 Concepts
2 Tutorial
3 Commands
- 3.1 Define
4 Triggers
Licenses
Index

Next: Tutorial, Previous: Top, Up: Top

1 Concepts

The mail module accepts SMTP mail messages and stores them in a message queue for handling by the Peer module. See the Peer Module for information on message queues.

1.0.1 Disclaimer

This module will not send mail. We recommend using a servant script to send mail.

Use of this module is not recommended if a standard mail server (e.g., sendmail) is available, which is normally the case. The unusual situation where this module may be helpful is when all of the following are true.

You need to collect events from a sensor tool that is able to generate plain text email when conditions of interest are detected, but not capable of delivering alerts via a more convenient method.
You don't want the email delivered from the sensor product to a mail server over the network in plain text.
The sensor tool runs on a server without a standard mail server, and for some reason you don't want to install one.
You are able to install NodeBrain on the server hosting the sensor tool.

When all these conditions are true, you can configure this module to accept mail at the local host and configure the sensor tool to send email alerts to the local host. Ports other than 25 may be used if supported by your sensor tool. You can process the message queue files locally or use the Peer module for authenticated and encrypted delivery to a remote instance of NodeBrain for processing.

If any of the conditions above are not true, there is probably a better way to collect events from the sensor product.

Next: Commands, Previous: Concepts, Up: Top

2 Tutorial

Next: Triggers, Previous: Tutorial, Up: Top

3 Commands

This section describes commands used with the Mail module.

3.1 Define

Syntax
mailDefineCmd ::= define s< term s< node [s< mailReaderDef] •
mailReaderDef ::= mail.server( "socketSpec " , " qDirectoryPath " );
socketSpec ::= [hostname | ipaddress ] : port
qDirectoryPath ::= path to message queue directory

The server will only accept mail to usernames that have been declared as identities. See DECLARE IDENTITY command in the NodeBrain Language Reference.

Next: Licenses, Previous: Commands, Up: Top

4 Triggers

The Mail module does not implement any triggers.

Next: Index, Previous: Triggers, Up: Top

Licenses

NodeBrain is free software; you can modify and/or redistribute it, including this document, under the terms of either the MIT License (Expat) or the NodeBrain License.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NodeBrain License

Permission to use and redistribute with or without fee, in source and binary forms, with or without modification, is granted free of charge to any person obtaining a copy of this software and included documentation, provided that the above copyright notice, this permission notice, and the following disclaimer are retained with source files and reproduced in documention included with source and binary distributions.

Unless required by applicable law or agreed to in writing, this software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

Previous: Licenses, Up: Top