/usr/share/doc/mailutils-doc/mailutils.html/mu-pop.html is in mailutils-doc 1:2.99.99-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301, USA
Copyright (C) 1999-2004, 2008-2012, 2014-2015 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover, and no Back-Cover texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: mu pop</title>
<meta name="description" content="GNU Mailutils Manual: mu pop">
<meta name="keywords" content="GNU Mailutils Manual: mu pop">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="mu.html#mu" rel="up" title="mu">
<link href="mu-imap.html#mu-imap" rel="next" title="mu imap">
<link href="mu-logger.html#mu-logger" rel="prev" title="mu logger">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<a name="mu-pop"></a>
<div class="header">
<p>
Next: <a href="mu-imap.html#mu-imap" accesskey="n" rel="next">mu imap</a>, Previous: <a href="mu-logger.html#mu-logger" accesskey="p" rel="prev">mu logger</a>, Up: <a href="mu.html#mu" accesskey="u" rel="up">mu</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="mu-pop-1"></a>
<h4 class="subsection">2.17.13 mu pop</h4>
<p>The <code>mu pop</code> command invokes an interactive POP3 client shell.
It reads commands from the standard input, executes them and displays
the results on the standard output. If the standard input is
connected to a terminal, the readline and history facilities are
enabled (provided that Mailutils is configured with GNU Readline).
</p>
<p>The <code>mu pop</code> commands form two major groups. POP3 protocol
commands interact with the remote POP3 server and display responses
obtained from it. These commands are named after their POP3
equivalents. Another group, <em>internal commands</em>, are used to
configure the shell itself.
</p>
<a name="POP-protocol-commands"></a>
<h4 class="subsubheading">POP protocol commands</h4>
<dl compact="compact">
<dt>connect [-tls] <var>hostname</var> [<var>port</var>]</dt>
<dd><p>Open connection to <var>hostname</var>. If the <samp>-tls</samp> option is
given, TLS encryption (also known as POPS protocol) will be used. If
<var>port</var> argument is not given, the command uses port 110 for a
plain POP connection or 995 for POPS (if <samp>-tls</samp> is given).
</p>
</dd>
<dt>stls</dt>
<dd><p>Start TLS negotiation. This command is valid only after successful
unencrypted connection has been initiated (using <code>connect</code>
without <samp>-tls</samp> argument).
</p>
</dd>
<dt>user <var>name</var></dt>
<dd><p>Send user name to the server. The <code>pass</code> command must follow.
</p>
</dd>
<dt>pass [<var>password</var>]</dt>
<dd><p>Send password. This command is valid only after <code>user</code>. If
the <var>password</var> argument is omitted, the shell will ask you to
enter it. While entering, both echoing and history recording will be
disabled. Use this to avoid compromising your password.
</p>
</dd>
<dt>apop <var>user</var> [<var>password</var>]</dt>
<dd><p>Authenticate with APOP. If the <var>password</var> argument is omitted,
you will be asked to supply it. While entering, both echoing and
history recording will be disabled.
</p>
</dd>
<dt>capa [-reread] [<var>name</var>...]</dt>
<dd><p>List server capabilities. Any number of arguments is accepted. If given, the shell will display only the named capabilities, otherwise it displays entire list. By default <code>capa</code> reuses the response of its previous invocation (if there was any), instead of resending the ‘<samp>CAPA</samp>’ command to the server. To force it do so, use the <samp>-reread</samp> option.
</p>
</dd>
<dt>noop</dt>
<dd><p>Send a ‘<samp>NOOP</samp>’ (<em>no operation</em>) command to the server.
</p>
</dd>
<dt>stat</dt>
<dd><p>Get the mailbox size and number of messages in it.
</p>
</dd>
<dt>uidl [<var>number</var>]</dt>
<dd><p>Shows unique message identifiers. Without arguments, shows
identifiers for each message in the mailbox. If <var>number</var> is
given, the command returns the UIDL of that particular message only.
</p>
</dd>
<dt>list [<var>number</var>]</dt>
<dd><p>Lists messages. See above for the meaning of <var>number</var>. Each line
of the produced listing contains describes a single message and
contains at least the message number and size in bytes. Depending on
the POP3 server implementation, additional fields may be present. For
example, Mailutils <code>pop3d</code> can also output number of lines in
the message in the additional third field.
</p>
</dd>
<dt>retr <var>number</var></dt>
<dd><p>Retrieve a message.
</p>
</dd>
<dt>top <var>msgno</var> [<var>number</var>]</dt>
<dd><p>Display message headers and first <var>number</var> (default 5) of lines of its body.
</p>
</dd>
<dt>dele <var>number</var></dt>
<dd><p>Mark message for deletion.
</p>
</dd>
<dt>rset</dt>
<dd><p>Remove deletion marks.
</p>
</dd>
<dt>quit</dt>
<dd><p>Quit pop3 session.
</p>
</dd>
<dt>disconnect</dt>
<dd><p>Close existing connection.
</p></dd>
</dl>
<a name="Internal-commands"></a>
<h4 class="subsubheading">Internal commands</h4>
<dl compact="compact">
<dt>verbose [on|off|mask|unmask] [secure [payload]]</dt>
<dd><p>Control output verbosity. Without arguments the <code>verbose</code>
command shows current settings.
</p>
<p>The argument ‘<samp>off</samp>’ (the default) turns off all additional output.
The ‘<samp>verbose on</samp>’ command enables POP3 protocol tracing output.
Additional arguments can be used to provide more verbosity. The
‘<samp>secure</samp>’ argument enables display of user passwords in the trace
output and the ‘<samp>payload</samp>’ argument enables showing payload data
(e.g. response body sent in the reply to ‘<samp>RETR</samp>’ command, etc.)
Thus, the full diagnostics output is obtained by
</p>
<div class="example">
<pre class="example">verbose on secure payload
</pre></div>
<p>The ‘<samp>mask</samp>’ and ‘<samp>unmask</samp>’ arguments allow to disable and
enable such additional verbosity. For example, supposing the command
above is in action, the following command will suppress the display of
user passwords in the traces:
</p>
<div class="example">
<pre class="example">verbose mask secure
</pre></div>
<p>Similarly, <code>verbose unmask secure</code> will turn it back again.
</p>
</dd>
<dt>prompt <var>string</var></dt>
<dd><p>Set command prompt. The argument can contain <em>variable
references</em> in any of the following forms:
</p>
<div class="example">
<pre class="example">$<var>name</var>
${<var>name</var>}
</pre></div>
<p>where <var>name</var> is the variable name. Such references are expanded
to the actual value of the variable at the time of expansion. The
following variables are defined:
</p>
<table>
<thead><tr><th width="40%">Variable</th><th width="60%">Expansion</th></tr></thead>
<tr><td width="40%">user</td><td width="60%">Login name of the authenticated POP3 user. If the session is not authenticated yet, expands to ‘<samp>[nouser]</samp>’.</td></tr>
<tr><td width="40%">host</td><td width="60%">Name of the remote host, or ‘<samp>[nohost]</samp>’ if no
connection is established.</td></tr>
<tr><td width="40%">program-name</td><td width="60%">Name of the program, as typed on the command
line to invoke it.</td></tr>
<tr><td width="40%">canonical-program-name</td><td width="60%">‘<samp>mu</samp>’</td></tr>
<tr><td width="40%">package</td><td width="60%">‘<samp>Mailutils</samp>’</td></tr>
<tr><td width="40%">version</td><td width="60%">Mailutils version number (2.99.99)</td></tr>
<tr><td width="40%">status</td><td width="60%">Session status. One of: ‘<samp>disconnected</samp>’,
‘<samp>connected</samp>’ or ‘<samp>logged in</samp>’.</td></tr>
</table>
<p>For example:
</p>
<div class="example">
<pre class="example">prompt "[${user}@$host "
</pre></div>
<p>Notice the use of quotes to include the space character in the prompt.
</p>
</dd>
<dt>exit</dt>
<dd><p>Exit the program.
</p>
</dd>
<dt>help [<var>command</var>]</dt>
<dt>? [<var>command</var>]</dt>
<dd><p>Without arguments displays a list of commands with possible arguments
and short descriptions.
</p>
<p>With one argument, displays a terse description for the given <var>command</var>.
</p>
</dd>
<dt>history</dt>
<dd><p>Shows command history.
</p></dd>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="mu-imap.html#mu-imap" accesskey="n" rel="next">mu imap</a>, Previous: <a href="mu-logger.html#mu-logger" accesskey="p" rel="prev">mu logger</a>, Up: <a href="mu.html#mu" accesskey="u" rel="up">mu</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|