MAN page from RedHat Other mailx-8.1.1-0.2.i386.rpm

MAIL

Section: User Commands (1)
Index
BSD mandoc
BSD 4

NAME

mail - send and receive mail

SYNOPSIS

mail[-iInv][-s subject][-c cc-addr][-b bcc-addr]to-addr...
mail[-iInNv -f][name]
mail[-iInNv [-u user]]

INTRODUCTION

Mailis an intelligent mail processing system, which hasa command syntax reminiscent ofed1with lines replaced by messages.

-v: Verbose mode.The details ofdelivery are displayed on the user's terminal.
-i: Ignore tty interrupt signals.This isparticularly useful when usingmailon noisy phone lines.
-I: Forces mail to run in interactive mode even wheninput isn't a terminal.In particular, the`~'specialcharacter when sending mail is only active in interactive mode.
-n: Inhibits reading/etc/mail.rcupon startup.
-N: Inhibits the initial display of message headerswhen reading mail or editing a mail folder.
-s: Specify subject on command line(only the first argument after the-sflag is used as a subject; be careful to quote subjectscontaining spaces.)
-c: Send carbon copies tolistof users.
-b: Send blind carbon copies tolist List should be a comma-separated list of names.
-f: Read in the contents of yourmbox(or the specified file)for processing; when youquit mailwrites undeleted messages back to this file.
-u: Is equivalent to:
mail -f /var/spool/mail/user

Sending mail

To send a message to one or more people,mailcan be invoked with arguments which are the names of people towhom the mail will be sent.You are then expected to type inyour message, followedby an`control-D'at the beginning of a line.The section belowReplying to or originating mail describes some features ofmailavailable to help you compose your letter.

Reading mail

In normal usagemailis given no arguments and checks your mail out of thepost office, thenprints out a one line header of each message found.The current message is initially the first message (numbered 1)and can be printed using theprintcommand (which can be abbreviated`p') .You can move among the messages much as you move between lines ined1,with the commands`+'and`-'moving backwards and forwards, andsimple numbers.

Disposing of mail.

After examining a message you candelete`d')the message orreply`r')to it.Deletion causes themailprogram to forget about the message.This is not irreversible; the message can beundeleted`u')by giving its number, or themailsession can be aborted by giving theexit`x')command.Deleted messages will, however, usually disappear never to be seen again.

Specifying messages

Commands such asprintanddeletecan be given a list of message numbers as arguments to applyto a number of messages at once.Thus``delete 1 2''deletes messages 1 and 2, while``delete 1-5''deletes messages 1 through 5.The special name`*'addresses all messages, and`$'addressesthe last message; thus the commandtopwhich prints the first few lines of a message could be used in``top *''to print the first few lines of all messages.

Replying to or originating mail.

You can use thereplycommand toset up a response to a message, sending it back to theperson who it was from.Text you then type in, up to an end-of-file,defines the contents of the message.While you are composing a message,mailtreats lines beginning with the character`~'specially.For instance, typing`~m'(alone on a line) will place a copyof the current message into the response right shifting it by a tabstop(seeindentprefixvariable, below).Other escapes will set up subject fields, add and delete recipientsto the message and allow you to escape to an editor to revise themessage or to a shell to run some commands.(These optionsare given in the summary below.)

Ending a mail processing session.

You can end amailsession with thequit`q')command.Messages which have been examined go to yourmboxfile unless they have been deleted in which case they are discarded.Unexamined messages go back to the post office.(See the-foption above).

Personal and systemwide distribution lists.

It is also possible to create a personal distribution lists so that,for instance, you can send mail to``cohorts''and have it goto a group of people.Such lists can be defined by placing a line like

alias cohorts bill ozalp jkf mark kridleAATTucbcory

in the file.mailrcin your home directory.The current list of such aliases can be displayed with thealiascommand inmail System wide distribution lists can be created by editing/etc/aliases seealiases(5)andsendmail(8);these are kept in a different syntax.In mail you send, personal aliases will be expanded in mail sentto others so that they will be able toreplyto the recipients.System widealiasesare not expanded when the mail is sent,but any reply returned to the machine will have the system widealias expanded as all mail goes throughsendmail.

Network mail (ARPA, UUCP, Berknet)

Seemailaddr(7)for a description of network addresses.

Mailhas a number of options which can be set in the.mailrcfile to alter its behavior; thus``set askcc''enables theaskccfeature.(These options are summarized below.)

SUMMARY

(Adapted from the `Mail Reference Manual')

Each command is typed on a line by itself, and may take argumentsfollowing the command word.The command need not be typed in itsentirety - the first command which matches the typed prefix is used.For commands which take message lists as arguments, if no messagelist is given, then the next message forward which satisfies thecommand's requirements is used.If there are no messages forward ofthe current message, the search proceeds backwards, and if there are nogood messages at all,mailtypes``applicable messages''andaborts the command.

-: Print out the preceding message.If given a numericargumentn goes to then 'thprevious message and prints it.
?: Prints a brief summary of commands.
!: Executes the shell(seesh(1)andcsh(1))command which follows.
Print: (P)Likeprintbut also prints out ignored header fields.See alsoprint ignoreandretain
Reply: (R)Reply to originator.Does not reply to otherrecipients of the original message.
Type: (T)Identical to thePrintcommand.
alias: (a)With no arguments, prints out all currently-defined aliases.With oneargument, prints out that alias.With more than one argument, createsa new alias or changes an old one.
alternates: (alt)Thealternatescommand is useful if you have accounts on several machines.It can be used to informmailthat the listed addresses are really you.When youreplyto messages,mailwill not send a copy of the message to any of the addresseslisted on thealternateslist.If thealternatescommand is given with no argument, the current set of alternatenames is displayed.
chdir: (c)Changes the user's working directory to that specified, if given.Ifno directory is given, then changes to the user's login directory.
copy: (co)Thecopycommand does the same thing thatsavedoes, except that it does not mark the messages itis used on for deletion when you quit.
delete: (d)Takes a list of messages as argument and marks them all as deleted.Deleted messages will not be saved inmbox nor will they be available for most other commands.
dp: (alsodt Deletes the current message and prints the next message.If there is no next message,mailsays``at EOF''
edit: (e)Takes a list of messages and points the text editor at each one inturn.On return from the editor, the message is read back in.
exit: ( exorx Effects an immediate return to the Shell withoutmodifying the user's system mailbox, hismboxfile, or his edit file in-f
file: (fi)The same asfolder
folders: List the names of the folders in your folder directory.
folder: (fo)Thefoldercommand switches to a new mail file or folder.With noarguments, it tells you which file you are currently reading.If you give it an argument, it will write out changes (suchas deletions) you have made in the current file and read inthe new file.Some special conventions are recognized forthe name.# means the previous file, % means your systemmailbox, %user means user's system mailbox, & meansyourmboxfile, and+folder means a file in your folderdirectory.
from: (f)Takes a list of messages and prints their message headers.
headers: (h)Lists the current range of headers, which is an 18-message group.Ifa`+'argument is given, then the next 18-message group is printed, and ifa`-'argument is given, the previous 18-message group is printed.
help: A synonym for?
hold: ( ho alsopreserve Takes a message list and marks eachmessage therein to be saved in theuser's system mailbox instead of inmbox Does not override thedeletecommand.
ignore: Add the list of header fields named to theignored list Header fields in the ignore list are not printedon your terminal when you print a message.Thiscommand is very handy for suppression of certain machine-generatedheader fields.TheTypeandPrintcommands can be used to print a message in its entirety, includingignored fields.Ifignoreis executed with no arguments, it lists the current set ofignored fields.
mail: (m)Takes as argument login names and distribution group names and sendsmail to those people.
mbox: Indicate that a list of messages be sent tomboxin your home directory when you quit.This is the defaultaction for messages if you donothave theholdoption set.
next: (n)like+orCR Goes to the next message in sequence and types it.With an argument list, types the next matching message.
preserve: (pre)A synonym forhold
print: (p)Takes a message list and types out each message on the user's terminal.
quit: (q)Terminates the session, saving all undeleted, unsaved messages inthe user'smboxfile in his login directory, preserving all messages marked withholdorpreserveor never referencedin his system mailbox, and removing all other messages from his systemmailbox.If new mail has arrived during the session, the message``You have new mail''is given.If given while editing amailbox file with the-fflag, then the edit file is rewritten.A return to the Shell iseffected, unless the rewrite of edit file fails, in which case the usercan escape with theexitcommand.
reply: (r)Takes a message list and sends mail to the sender and allrecipients of the specified message.The default message must not be deleted.
respond: A synonym forreply
retain: Add the list of header fields named to theretained listOnly the header fields in the retain listare shown on your terminal when you print a message.All other header fields are suppressed.TheTypeandPrintcommands can be used to print a message in its entirety.Ifretainis executed with no arguments, it lists the current set ofretained fields.
save: (s)Takes a message list and a filename and appends each message inturn to the end of the file.The filename in quotes, followed by the linecount and character count is echoed on the user's terminal.
set: (se)With no arguments, prints all variable values.Otherwise, setsoption.Arguments are of the formoption=value(no space before or after =) oroption Quotation marks may be placed around any part of the assignment statement toquote blanks or tabs, i.e.``set indentprefix="->"''
saveignore: Saveignoreis tosavewhatignoreis toprintandtype Header fields thus marked are filtered out whensaving a message bysaveor when automatically saving tombox
saveretain: Saveretainis tosavewhatretainis toprintandtype Header fields thus marked are the only ones savedwith a message when saving bysaveor when automatically saving tombox Saveretainoverridessaveignore
shell: (sh)Invokes an interactive version of the shell.
size: Takes a message list and prints out the size in characters of eachmessage.
source: Thesourcecommand readscommands from a file.
top: Takes a message list and prints the top few lines of each.The number oflines printed is controlled by the variabletoplinesand defaults to five.
type: (t)A synonym forprint
unalias: Takes a list of names defined byaliascommands and discards the remembered groups of users.The group namesno longer have any significance.
undelete: (u)Takes a message list and marks each message asnotbeing deleted.
unread: (U)Takes a message list and marks each message asnothaving been read.
unset: Takes a list of option names and discards their remembered values;the inverse ofset
visual: (v)Takes a message list and invokes the display editor on each message.
write: (w)Similar tosave except thatonlythe message body(without)the header) is saved.Extremely useful for such tasks as sending and receiving sourceprogram text over the message system.
xit: (x)A synonym forexit
z: Mailpresents message headers in windowfuls as described under theheaderscommand.You can movemail 'sattention forward to the next window with thezcommand.Also, you can move to the previous window by usingz-

Tilde/Escapes

Here is a summary of the tilde escapes,which are used when composing messages to performspecial functions.Tilde escapes are only recognized at the beginningof lines.The name``tilde escape''is somewhat of a misnomer since the actual escape character can be setby the optionescape

~! command: Execute the indicated shell command, then return to the message.
~b name ...: Add the given names to the list of carbon copy recipients but do not makethe names visible in the Cc: line ("blind" carbon copy).
~c name ...: Add the given names to the list of carbon copy recipients.
~d: Read the file``dead.letter''from your home directory into the message.
~e: Invoke the text editor on the message collected so far.After theediting session is finished, you may continue appending text to themessage.
~f messages: Read the named messages into the message being sent.If no messages are specified, read in the current message.Message headers currently being ignored (by theignoreorretaincommand) are not included.
~F messages: Identical to~f except all message headers are included.
~h: Edit the message header fields by typing each one in turn and allowingthe user to append text to the end or modify the field by using thecurrent terminal erase and kill characters.
~m messages: Read the named messages into the message being sent, indented by atab or by the value ofindentprefix If no messages are specified,read the current message.Message headers currently being ignored (by theignoreorretaincommand) are not included.
~M messages: Identical to~m except all message headers are included.
~p: Print out the message collected so far, prefaced by the message headerfields.
~q: Abort the message being sent, copying the message to``dead.letter''in your home directory ifsaveis set.
~r filename: Read the named file into the message.
~s string: Cause the named string to become the current subject field.
~t name ...: Add the given names to the direct recipient list.
~v: Invoke an alternate editor (defined by theVISUALoption) on themessage collected so far.Usually, the alternate editor will be ascreen editor.After you quit the editor, you may resume appendingtext to the end of your message.
~w filename: Write the message onto the named file.
~| command: Pipe the message through the command as a filter.If the command givesno output or terminates abnormally, retain the original text of themessage.The commandfmt(1)is often used ascommandto rejustify the message.
~: mail-command: Execute the given mail command.Not all commands, however, are allowed.
~~ string: Insert the string of text in the message prefaced by a single ~.Ifyou have changed the escape character, then you should doublethat character in order to send it.

Mail Options

Options are controlled viasetandunsetcommands.Options may be either binary, in which case it is onlysignificant to see whether they are set or not; or string, in whichcase the actual value is of interest.The binary options include the following:

append: Causes messages saved inmboxto be appended to the end rather than prepended.This should always be set (perhaps in/etc/mail.rc )
ask, asksub: Causesmailto prompt you for the subject of each message you send.Ifyou respond with simply a newline, no subject field will be sent.
askcc: Causes you to be prompted for additional carbon copy recipients at theend of each message.Responding with a newline indicates yoursatisfaction with the current list.
askbcc: Causes you to be prompted for additional blind carbon copy recipients at theend of each message.Responding with a newline indicates yoursatisfaction with the current list.
autoprint: Causes thedeletecommand to behave likedp- thus, after deleting a message, the next one will be typedautomatically.
debug: Setting the binary optiondebugis the same as specifying-don the command line and causesmailto output all sorts of information useful for debuggingmail
dot: The binary optiondotcausesmailto interpret a period alone on a line as the terminatorof a message you are sending.
hold: This option is used to hold messages in the system mailboxby default.
ignore: Causes interrupt signals from your terminal to be ignored and echoed as@'s.
ignoreeof: An option related todotisignoreeofwhich makesmailrefuse to accept a control-d as the end of a message.Ignoreeofalso applies tomailcommand mode.
metoo: Usually, when a group is expanded that contains the sender, the senderis removed from the expansion.Setting this option causes the senderto be included in the group.
noheader: Setting the optionnoheaderis the same as giving the-Nflag on the command line.
nosave: Normally, when you abort a message with twoRUBOUT(erase or delete)mailcopies the partial letter to the file``dead.letter''in your home directory.Setting the binary optionnosaveprevents this.
Replyall: Reverses the sense ofreplyandReplycommands.
quiet: Suppresses the printing of the version when first invoked.
searchheaders: If this option is set, then a message-list specifier in the form ``/x:y''will expand to all messages containing the substring ``y'' in the headerfield ``x''. The string search is case insensitive.
verbose: Setting the optionverboseis the same as using the-vflag on the command line.When mail runs in verbose mode,the actual delivery of messages is displayed on the user'sterminal.

Option String Values

EDITOR: Pathname of the text editor to use in theeditcommand and~eescape.If not defined, then a default editor is used.
LISTER: Pathname of the directory lister to use in thefolderscommand.Default is/bin/ls
PAGER: Pathname of the program to use in themorecommand or whencrtvariable is set.The default paginatormore(1)is used if this option is not defined.
SHELL: Pathname of the shell to use in the!command and the~!escape.A default shell is used if this option isnot defined.
VISUAL: Pathname of the text editor to use in thevisualcommand and~vescape.
crt: The valued optioncrtis used as a threshold to determine how long a message mustbe beforePAGERis used to read it.Ifcrtis set without a value,then the height of the terminal screen stored in the systemis used to compute the threshold (seestty(1)).
escape: If defined, the first character of this option gives the character touse in the place of ~ to denote escapes.
folder: The name of the directory to use for storing folders ofmessages.If this name begins with a `/',mailconsiders it to be an absolute pathname; otherwise, thefolder directory is found relative to your home directory.
MBOX: The name of themboxfile.It can be the name of a folder.The default is``mbox''in the user's home directory.
record: If defined, gives the pathname of the file used to record all outgoingmail.If not defined, then outgoing mail is not so saved.
indentprefix: String used by the ``~m'' tilde escape for indenting messages, in place ofthe normal tab character (^I).Be sure to quote the value if it containsspaces or tabs.
toplines: If defined, gives the number of lines of a message to be printed outwith thetopcommand; normally, the first five lines are printed.