Feature EMAIL-GATEWAY

Description and Priority

Yaktrack should allow for basic viewing of issues, querying of issues, requesting of blank templates, and filing of issues via an email gateway. The gateway mechanic will be such that the subject of the email message will be the command line for the email gateway, with the body of the message being the text of the issue to file (if appropriate). The email gateway will be implemented in the form of an email "pipe" in which the text of an email message is forwarded directly to a shell script (via a mechanism such as the .forward or aliases mechanism under Unix)

Stimulus/Response Sequences

EMAIL-GATEWAY.UC.CAT

Description

The email user should be able to list reports via the command cat [template-name] [issue-id] [issue-id...] in the "Subject:" line of an email message.

Requires

An installed email gateway with an installed repository.

All feature CAT requirements

Ensures

Feedback to the user in a return mail message

Frequency of Use

Low. Most network users would prefer to use the web interface.

Normal Course

Table 4-19. Normal Course of Action

Actor ActionsSystem Actions
Emails the gateway with the subject line cat [template-name] [message-id]Executes the use-case CAT.UC on the given command line
 Returns feedback to the user in a return email message

EMAIL-GATEWAY.UC.QUERY

Description

The email user should be able to query reports via the command query [template-name] [match-expression] in the "Subject:" line of an email message.

Requires

An installed email gateway with an installed repository.

All feature QUERY requirements

Ensures

Feedback to the user in a return mail message

Frequency of Use

Low. Most network users would prefer to use the web interface.

Normal Course

Table 4-20. Normal Course of Action

Actor ActionsSystem Actions
Emails the gateway with the subject line query template-name match-expressionExecutes the use-case QUERY.UC on the given command line
 Returns feedback to the user in a return email message

EMAIL-GATEWAY.UC.REQUEST-BLANK-TEMPLATE

Description

The email user should be able to retrieve a blank "template" for an issue by the command request-blank-template template-name in the "Subject:" line of an email message.

Requires

An installed email gateway with an installed repository.

Ensures

A blank issue, with default attributes filled in, for a given template.

Frequency of Use

Low. Most network users would prefer to use the web interface.

Normal Course

Table 4-21. Normal Course of Action

Actor ActionsSystem Actions
Emails the gateway with the subject line request-blank-template template-nameRetrieves the template from the repository
 Fills in default values for attributes, etc as per the SUBMIT feature
 Returns the blank template to the user if it existed; if not, list available templates

EMAIL-GATEWAY.UC.FILE

Description

The email user should be able to file a new report or replace an old report by the emailing the gateway with the command line file template-name in the "Subject:" line of an email message, and the text of the issue in the body of the message.

Requires

An installed email gateway with an installed repository.

All the requirements from the FILE.UC use case

Ensures

Feedback to the user in a return mail message

Frequency of Use

Low. Most network users would prefer to use the web interface.

Normal Course

Table 4-22. Normal Course of Action

Actor ActionsSystem Actions
Emails the gateway with the subject line file template-name and the body of the message containing the text to be filedWrites the body of the message into a file in a temporary directory
 Executes the FILE.UC use case on the newly written file
 Returns feedback to the user in a return email message

Functional Requirements

EMAIL-GATEWAY.FR1. The system should allow for an email gateway that can understand RFC822 mail messages piped to it through standard input

EMAIL-GATEWAY.FR2. The system should allow for CAT.UC functionality by piping the command line from the mail message's "Subject: " line into the CAT command

EMAIL-GATEWAY.FR3. The system should allow for QUERY.UC functionality by piping the command line from the mail message's "Subject: " line into the QUERY command

EMAIL-GATEWAY.FR4. The system should recognize the request-blank-template template-name command in the "Subject: " line of an email message

EMAIL-GATEWAY.FR5. The system should load the template from the repository, fill out default values as per the SUBMIT.UC.NOEDITOR use case, and return the blank issue in an email message to the sender.

EMAIL-GATEWAY.FR6. The system should write the body of a "file" message into a new file in a temporary directory

EMAIL-GATEWAY.FR7. The system should act on a new "file" request by executing the FILE.UC use case on the newly-generated file with the template given in the "file" subject line