folders Command

Purpose

Lists all folders and messages in mail directory.

Syntax

folders [ +Folder ] [ Message ] [ -all ] [ -pack | -nopack ] [ -fast | -nofast ] [ -recurse | -norecurse ] [ -print | -noprint ] [ -header | -noheader ] [ -total | -nototal ] [ -push | -pop ] [ -list | -nolist ]

Description

The folders command lists all folders and messages in your mail directory. This command is equivalent to the folder command specified with the -all flag.

Flags

Item Description
-all Displays a line of information about each folder in your mail directory.
-fast Displays only the names of the folders.
+Folder Specifies the folder information to display.
-header Displays column headings for the folder information. This flag is the default.
-help Lists the command syntax, available switches (toggles), and version information.
Note: For Message Handler (MH), the name of this flag must be fully spelled out.
-list Displays the current folder followed by the contents of the folder stack.
Message Sets the specified message as the current message. Unless you specify the +Folder flag, the command sets the specified message for the current folder. Use the following references to specify a message:
Number
Number of the message.
cur or . (period)
Current message. This is the default.
first
First message in a folder.
last
Last message in a folder.
next
Message following the current message.
new
The new message that is created.
prev
Message preceding the current message.
-nofast Displays information about each folder. This flag is the default.
-noheader Suppresses column headings for the folder information.
-nolist Suppresses the display of the folder-stack contents. This flag is the default.
-nopack Prevents renumbering of the messages in the folder. This flag is the default.
-noprint Prevents display of folder information. If the -push, -pop, or -list flag is specified, the -noprint flag is the default.
-norecurse Displays information about the folders in your mail directory. Information about subfolders is not displayed. This flag is the default.
-nototal Prevents display all messages and folders in your mail directory structure.
-pack Renumbers the messages in the folders. Renumbering eliminates gaps in message numbering after messages have been deleted.
-pop Removes the folder from the top of the folder stack and makes it the current folder.
-print Displays the number of messages in each folder, the current message for each folder, and the current folder. If the -push, -pop, or -list flag is specified, the -noprint flag is the default; otherwise, the -print flag is the default.
-push Moves the current folder to the top of the folder stack and sets the specified folder as the current folder. If no folder is specified, the -push flag swaps the current folder for the folder on top of the folder stack.
-recurse Displays information about all folders and subfolders in your mail directory structure.
-total Displays all messages and folders in your mail directory structure. The -total flag does not display information for subfolders unless you specify the -recurse flag. The -total flag is the default.

Profile Entries

The following entries are entered in the UserMhDirectory/.mh_profile file:

Item Description
Current-Folder: Sets the default current folder.
Folder-Protect: Sets the protection level for the new folder directories.
Folder-Stack: Specifies the folder stack.
lsproc: Specifies the program used to list the contents of a folder.
Path: Specifies the user's MH directory.

Examples

  1. To display information about all folders, enter: 
    folders
    The system responds with a message similar to the following: 
    Folder  # of messages (range); cur msg  (other files)
inbox+ has 80 messages (1-82); cur= 7; (others).
test has 5 messages (1-6);   cur=  5; (others).
 
   Total= 85 messages in 2 folders.
    In this example, there are 2 folders containing a total of 85 messages. The current folder is inbox, indicated by the + (plus sign) following it.
  2. To list only the names of all folders, enter:

    folders    -fast

    The system responds with a message similar to the following: 
    inbox
test
  3. To renumber the messages in all folders, enter:

    folders    -pack

    The system responds with a message similar to the following: 
    inbox+ has 80 messages (1-80); cur= 7; (others).
test has 5 messages (1-5);  cur= 5; (others).
    In this example, the messages in the inbox folder and in the test folder have been renumbered to eliminate gaps in message numbering after messages were deleted.

Files

Item Description
$HOME/.mh_profile Contains the MH user profile.
/usr/bin/folders Contains the folders command.