~ubuntu-dev/ubuntu/lucid/mutt/lucid-201002110857 : revision 1.1.11

13

14

15

<para>

16

<quote>All mail clients suck. This one just sucks less.</quote> -me, circa 1995

16

<quote>All mail clients suck. This one just sucks less.</quote> — me, circa 1995

17

</para>

18

</abstract>

19

</bookinfo>

82

</sect1>

83

84

85

<title>Software Distribution Sites</title>

85

<title>Getting Mutt</title>

86

87

<para>

88

Mutt releases can be downloaded from

91

<ulink url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>.

92

</para>

93

94

<para>

95

For nightly tarballs and version control access, please refer to the

96

<ulink url="http://dev.mutt.org/">Mutt development site</ulink>.

97

</para>

98

94

99

</sect1>

95

100

96

101

97

<title>Mutt online resources</title>

102

<title>Mutt Online Resources</title>

98

103

99

104

100

105

102

107

<term>Bug Tracking System</term>

103

108

104

109

<para>

105

The official mutt bug tracking system can be found at

106

110

The official Mutt bug tracking system can be found at

111

107

112

</para>

108

113

</listitem>

109

114

</varlistentry>

156

161

157

162

<para>

158

163

Since translations of Mutt into other languages are highly appreciated,

159

the mutt developers always look for skilled translators that help

164

the Mutt developers always look for skilled translators that help

160

165

improve and continue to maintain stale translations.

161

166

</para>

162

167

169

174

</sect1>

170

175

171

176

172

<title>Typograhical conventions</title>

177

<title>Typograhical Conventions</title>

173

178

174

179

<para>

175

180

This section lists typographical conventions followed throughout this

188

193

<row><entry><literal><PageUp></literal></entry><entry>named keys</entry></row>

189

194

<row><entry><literal><create-alias></literal></entry><entry>named Mutt function</entry></row>

190

195

<row><entry><literal>&circ;G</literal></entry><entry>Control+G key combination</entry></row>

191

<row><entry><literal>&dollar;mail&lowbar;check</literal></entry><entry>Mutt configuration option</entry></row>

196

<row><entry>&dollar;mail&lowbar;check</entry><entry>Mutt configuration option</entry></row>

197

<row><entry><literal>&dollar;HOME</literal></entry><entry>environment variable</entry></row>

192

198

</tbody>

193

199

</tgroup>

194

200

</table>

214

220

<title>Copyright</title>

215

221

216

222

<para>

217

223

218

224

<email>me@mutt.org</email> and others.

219

225

</para>

220

226

259

265

</para>

260

266

261

267

<para>

262

The first thing you need to do is invoke mutt, simply by typing <literal>mutt</literal>

268

The first thing you need to do is invoke Mutt, simply by typing <literal>mutt</literal>

263

269

at the command line. There are various command-line options, see

264

either the mutt man page or the <link linkend="commandline">reference</link>.

270

either the Mutt man page or the <link linkend="commandline">reference</link>.

265

271

</para>

266

272

267

273

268

<title>Core concepts</title>

274

<title>Core Concepts</title>

269

275

270

276

<para>

271

277

Mutt is a text-based application which interacts with users through

286

292

</para>

287

293

288

294

<para>

295

Mutt is configured through variables which, if the user wants to

296

permanently use a non-default value, are written to configuration

297

files. Mutt supports a rich config file syntax to make even complex

298

configuration files readable and commentable.

299

</para>

300

301

<para>

289

302

Because Mutt allows for customizing almost all key bindings, there are

290

303

so-called <quote>functions</quote> which can be executed manually (using the

291

304

command line) or in macros. Macros allow the user to bind a sequence of

315

328

per-folder basis and much more.

316

329

</para>

317

330

331

<para>

332

Besides an interactive mode, Mutt can also be used as a command-line

333

tool only send messages. It also supports a

334

<literal>mailx(1)</literal>-compatible interface, see <xref

335

linkend="tab-commandline-options"/> for a complete list of command-line

336

options.

337

</para>

338

339

</sect1>

340

341

342

<title>Screens and Menus</title>

343

344

345

<title>Index</title>

346

347

<para>

348

The index is the screen that you usually see first when you start

349

Mutt. It gives an overview over your emails in the currently opened

350

mailbox. By default, this is your system mailbox. The information you

351

see in the index is a list of emails, each with its number on the left,

352

its flags (new email, important email, email that has been forwarded or

353

replied to, tagged email, ...), the date when email was sent, its

354

sender, the email size, and the subject. Additionally, the index also

355

shows thread hierarchies: when you reply to an email, and the other

356

person replies back, you can see the other's person email in a

357

"sub-tree" below. This is especially useful for personal email between

358

a group of people or when you've subscribed to mailing lists.

359

</para>

360

361

</sect2>

362

363

364

<title>Pager</title>

365

366

<para>

367

The pager is responsible for showing the email content. On the top of

368

the pager you have an overview over the most important email headers

369

like the sender, the recipient, the subject, and much more

370

information. How much information you actually see depends on your

371

configuration, which we'll describe below.

372

</para>

373

374

<para>

375

Below the headers, you see the email body which usually contains the

376

message. If the email contains any attachments, you will see more

377

information about them below the email body, or, if the attachments are

378

text files, you can view them directly in the pager.

379

</para>

380

381

<para>

382

To give the user a good overview, it is possible to configure Mutt to

383

show different things in the pager with different colors. Virtually

384

everything that can be described with a regular expression can be

385

colored, e.g. URLs, email addresses or smileys.

386

</para>

387

388

</sect2>

389

390

391

<title>File Browser</title>

392

393

<para>

394

The file browser is the interface to the local or remote file

395

system. When selecting a mailbox to open, the browser allows custom

396

sorting of items, limiting the items shown by a regular expression and a

397

freely adjustable format of what to display in which way. It also allows

398

for easy navigation through the file system when selecting file(s) to

399

attach to a message, select multiple files to attach and many more.

400

</para>

401

402

</sect2>

403

404

405

406

407

<para>

408

The help screen is meant to offer a quick help to the user. It lists the

409

current configuration of key bindings and their associated commands

410

including a short description, and currently unbound functions that

411

still need to be associated with a key binding (or alternatively, they

412

can be called via the Mutt command prompt).

413

</para>

414

415

</sect2>

416

417

418

<title>Compose Menu</title>

419

420

<para>

421

The compose menu features a split screen containing the information

422

which really matter before actually sending a message by mail: who gets

423

the message as what (recipients and who gets what kind of

424

copy). Additionally, users may set security options like deciding

425

whether to sign, encrypt or sign and encrypt a message with/for what

426

keys. Also, it's used to attach messages, to re-edit any attachment

427

including the message itself.

428

</para>

429

430

</sect2>

431

432

433

<title>Alias Menu</title>

434

435

<para>

436

The alias menu is used to help users finding the recipients of

437

messages. For users who need to contact many people, there's no need to

438

remember addresses or names completely because it allows for searching,

439

too. The alias mechanism and thus the alias menu also features grouping

440

several addresses by a shorter nickname, the actual alias, so that users

441

don't have to select each single recipient manually.

442

</para>

443

444

</sect2>

445

446

447

<title>Attachment Menu</title>

448

449

<para>

450

As will be later discussed in detail, Mutt features a good and stable

451

MIME implementation, that is, it supports sending and receiving messages

452

of arbitrary MIME types. The attachment menu displays a message's

453

structure in detail: what content parts are attached to which parent

454

part (which gives a true tree structure), which type is of what type and

455

what size. Single parts may saved, deleted or modified to offer great

456

and easy access to message's internals.

457

</para>

458

459

</sect2>

460

318

461

</sect1>

319

462

320

463

321

464

<title>Moving Around in Menus</title>

322

465

323

466

<para>

324

The most important navigation keys common to all menus are shown in

325

<xref linkend="tab-keys-nav"/>.

467

The most important navigation keys common to line- or entry-based menus

468

are shown in <xref linkend="tab-keys-nav-line"/> and in

469

<xref linkend="tab-keys-nav-page"/> for page-based menus.

326

470

</para>

327

471

328

329

<title>Most common navigation keys</title>

472

473

<title>Most common navigation keys in entry-based menus</title>

330

474

331

475

<thead>

332

476

<row><entry>Key</entry><entry>Function</entry><entry>Description</entry></row>

344

488

</tgroup>

345

489

</table>

346

490

491

492

<title>Most common navigation keys in page-based menus</title>

493

494

<thead>

495

<row><entry>Key</entry><entry>Function</entry><entry>Description</entry></row>

496

</thead>

497

<tbody>

498

<row><entry>J or <Return></entry><entry><literal><next-line></literal></entry><entry>scroll down one line</entry></row>

499

<row><entry><Backspace></entry><entry><literal><previous-line></literal></entry><entry>sroll up one line</entry></row>

500

501

<row><entry>- or <PageUp></entry><entry><literal><previous-page></literal></entry><entry>move the previous page</entry></row>

502

503

<row><entry><End></entry><entry><literal><bottom></literal></entry><entry>move to the bottom</entry></row>

504

</tbody>

505

</tgroup>

506

</table>

507

347

508

</sect1>

348

509

349

510

395

556

396

557

<para>

397

558

You can remap the <emphasis>editor</emphasis> functions using the

398

559

399

560

the <Delete> key delete the character in front of

400

561

the cursor rather than under, you could use:

401

562

</para>

416

577

using <link linkend="history-file">&dollar;history&lowbar;file</link>.

417

578

You may cycle through them at an editor prompt by using the

418

579

<literal><history-up></literal> and/or

419

<literal><history-down></literal> commands.

580

<literal><history-down></literal> commands. But notice that Mutt

581

does not remember the currently entered text, it only cycles through

582

history and wraps around at the end or beginning.

420

583

</para>

421

584

422

585

<para>

425

588

</para>

426

589

427

590

428

<listitem><para>muttrc commands</para></listitem>

591

<listitem><para><literal>.muttrc</literal> commands</para></listitem>

429

592

<listitem><para>addresses and aliases</para></listitem>

430

593

<listitem><para>shell commands</para></listitem>

431

594

<listitem><para>filenames</para></listitem>

434

597

</itemizedlist>

435

598

436

599

<para>

437

Mutt automatically filters out repeated items from the history. It

600

Mutt automatically filters out consecutively repeated items from the history. It

438

601

also mimics the behavior of some shells by ignoring items starting

439

602

with a space. The latter feature can be useful in macros to not clobber

440

603

the history's valuable entries with unwanted entries.

445

608

</sect1>

446

609

447

610

448

<title>Reading Mail - The Index and Pager</title>

611

<title>Reading Mail</title>

449

612

450

613

<para>

451

614

Similar to many other mail clients, there are two modes in which mail is

452

read in Mutt. The first is the index of messages in the mailbox, which is

453

called the <quote>index</quote> in Mutt. The second mode is the display of the

615

read in Mutt. The first is a list of messages in the mailbox, which is

616

called the <quote>index</quote> menu in Mutt. The second mode is the display of the

454

617

message contents. This is called the <quote>pager.</quote>

455

618

</para>

456

619

569

732

<title>The Pager</title>

570

733

571

734

<para>

572

By default, Mutt uses its builtin pager to display the contents of messages.

573

The pager is very similar to the Unix program <emphasis>less</emphasis> though not nearly as

574

featureful.

735

By default, Mutt uses its builtin pager to display the contents of

736

messages (an external pager such as <literal>less(1)</literal> can be

737

configured, see <link linkend="pager">&dollar;pager</link> variable).

738

The pager is very similar to the Unix program <literal>less(1)</literal>

739

though not nearly as featureful.

575

740

</para>

576

741

577

742

607

772

Also, the internal pager supports a couple other advanced features. For

608

773

one, it will accept and translate the <quote>standard</quote> nroff sequences for

609

774

bold and underline. These sequences are a series of either the letter,

610

backspace (&circ;H), the letter again for bold or the letter, backspace,

775

backspace (<quote>&circ;H</quote>), the letter again for bold or the letter, backspace,

611

776

<quote>&lowbar;</quote> for denoting underline. Mutt will attempt to display these

612

777

in bold and underline respectively if your terminal supports them. If

613

778

not, you can use the bold and underline <link linkend="color">color</link>

614

objects to specify a color or mono attribute for them.

779

objects to specify a <command>color</command> or mono attribute for them.

615

780

</para>

616

781

617

782

<para>

686

851

Note that the search commands in the pager take regular expressions,

687

852

which are not quite the same as the more

688

853

complex <link linkend="patterns">patterns</link> used by the search

689

command in the index. This is because the pager only performs simple

690

text search, whereas the index provides boolean filtering on several

691

aspects of messages.

854

command in the index. This is because patterns are used to select messages by

855

criteria whereas the pager already displays a selected message.

692

856

</para>

693

857

</note>

694

858

698

862

<title>Threaded Mode</title>

699

863

700

864

<para>

701

When the mailbox is <link linkend="sort">sorted</link> by <emphasis>threads</emphasis>, there are

702

a few additional functions available in the <emphasis>index</emphasis> and <emphasis>pager</emphasis> modes

703

as shown in <xref linkend="tab-key-threads"/>.

865

So-called <quote>threads</quote> provide a hierarchy of messages where

866

replies are linked to their parent message(s). This organizational form

867

is extremely useful in mailing lists where different parts of the

868

discussion diverge. Mutt displays threads as a tree structure.

869

</para>

870

871

<para>

872

In Mutt, when a mailbox is <link linkend="sort">sorted</link>

873

by <emphasis>threads</emphasis>, there are a few additional functions

874

available in the <emphasis>index</emphasis>

875

and <emphasis>pager</emphasis> modes as shown in

876

<xref linkend="tab-key-threads"/>.

704

877

</para>

705

878

706

879

728

901

</tgroup>

729

902

</table>

730

903

731

<note>

732

904

<para>

733

905

Collapsing a thread displays only the first message

734

906

in the thread and hides the others. This is useful when threads

735

907

contain so many messages that you can only see a handful of threads on

736

908

the screen. See &percnt;M in <link linkend="index-format">&dollar;index&lowbar;format</link>.

737

For example, you could use "&percnt;?M?(&num;&percnt;03M)&(&percnt;4l)?" in <link linkend="index-format">&dollar;index&lowbar;format</link> to optionally

738

display the number of hidden messages if the thread is collapsed.

909

For example, you could use <quote>&percnt;?M?(&num;&percnt;03M)&(&percnt;4l)?</quote> in <link linkend="index-format">&dollar;index&lowbar;format</link> to optionally

910

display the number of hidden messages if the thread is

911

collapsed. The <literal>&percnt;?<char>?<if-part>&<else-part>?</literal>

912

syntax is explained in detail in

913

739

914

</para>

740

</note>

741

915

742

916

<para>

743

See also: <link linkend="strict-threads">&dollar;strict&lowbar;threads</link>.

917

Technically, every reply should contain a list of its parent messages in

918

the thread tree, but not all do. In these cases, Mutt groups them by

919

subject which can be controlled using the

920

744

921

</para>

745

922

746

923

</sect2>

762

939

763

940

<para>

764

941

Creates a new alias based upon the current message (or prompts for a

765

new one). Once editing is complete, an <link linkend="alias">alias</link>

942

new one). Once editing is complete, an <link linkend="alias"><command>alias</command></link>

766

943

command is added to the file specified by

767

944

the <link linkend="alias-file">&dollar;alias&lowbar;file</link> variable

768

945

for future use

771

948

<note>

772

949

<para>

773

950

Mutt does not read the <link linkend="alias-file">&dollar;alias&lowbar;file</link>

774

upon startup so you must explicitly <link linkend="source">source</link> the file.

951

upon startup so you must explicitly <link linkend="source"><command>source</command></link> the file.

775

952

</para>

776

953

</note>

777

954

</listitem>

879

1056

880

1057

<para>

881

1058

Reply to the current or tagged message(s) by extracting any addresses which

882

match the regular expressions given by the <link linkend="lists">lists or subscribe</link>

1059

match the regular expressions given by the <link linkend="lists"><command>lists</command> or <command>subscribe</command></link>

883

1060

commands, but also honor any <literal>Mail-Followup-To</literal> header(s) if the

884

1061

885

1062

configuration variable is set. Using this when replying to messages posted

1005

1182

<emphasis>Bouncing</emphasis> a message sends the message as-is to the recipient you

1006

1183

specify. <emphasis>Forwarding</emphasis> a message allows you to add comments or

1007

1184

modify the message you are forwarding. These items are discussed

1008

in greater detail in the next chapter <quote><link linkend="forwarding-mail">Forwarding

1185

in greater detail in the next section <quote><link linkend="forwarding-mail">Forwarding

1009

1186

and Bouncing Mail</link>.</quote>

1010

1187

</para>

1011

1188

1012

1189

<para>

1013

1190

Mutt will then enter the <emphasis>compose</emphasis> menu and prompt you for the

1014

recipients to place on the <quote>To:</quote> header field. Next, it will ask

1191

recipients to place on the <quote>To:</quote> header field when you hit <literal>m</literal> to start a new message. Next, it will ask

1015

1192

you for the <quote>Subject:</quote> field for the message, providing a default if

1016

you are replying to or forwarding a message. See also

1193

you are replying to or forwarding a message. You again

1194

have the chance to adjust recipients, subject, and security settings

1195

right before actually sending the message. See also

1017

1196

1018

1197

1019

1198

1020

1199

1021

1200

1022

1201

and <link linkend="include">&dollar;include</link>

1023

for changing how Mutt asks these questions.

1024

</para>

1025

1026

<para>

1027

Mutt will then automatically start your <link linkend="editor">&dollar;editor</link>

1028

on the message body. If the <link linkend="edit-headers">&dollar;edit&lowbar;headers</link>

1029

variable is set, the headers will be at the top of the message in your editor.

1030

Any messages you are replying to will be added in sort order to the message,

1202

for changing how and if Mutt asks these questions.

1203

</para>

1204

1205

<para>

1206

When replying, Mutt fills these fields with proper values depending on

1207

the reply type. The types of replying supported are:

1208

</para>

1209

1210

1211

1212

<term>Simple reply</term>

1213

1214

<para>

1215

Reply to the author directly.

1216

</para>

1217

</listitem>

1218

</varlistentry>

1219

1220

<term>Group reply</term>

1221

1222

<para>

1223

Reply to the author as well to all recipients except you; this consults

1224

1225

</para>

1226

</listitem>

1227

</varlistentry>

1228

1229

<term>List reply</term>

1230

1231

<para>

1232

Reply to all mailing list addresses found, either specified via

1233

configuration or auto-detected. See <xref linkend="lists"/> for

1234

details.

1235

</para>

1236

</listitem>

1237

</varlistentry>

1238

</variablelist>

1239

1240

<para>

1241

After getting recipients for new messages, forwards or replies, Mutt

1242

will then automatically start your <link

1243

linkend="editor">&dollar;editor</link> on the message body. If the <link

1244

linkend="edit-headers">&dollar;edit&lowbar;headers</link> variable is

1245

set, the headers will be at the top of the message in your editor. Any

1246

messages you are replying to will be added in sort order to the message,

1031

1247

with appropriate <link linkend="attribution">&dollar;attribution</link>,

1032

1248

1033

1034

When forwarding a message, if the <link linkend="mime-forward">&dollar;mime&lowbar;forward</link>

1035

variable is unset, a copy of the forwarded message will be included. If

1036

you have specified a <link linkend="signature">&dollar;signature</link>, it

1037

will be appended to the message.

1249

<link

1250

linkend="post-indent-string">&dollar;post&lowbar;indent&lowbar;string</link>.

1251

When forwarding a message, if the <link

1252

linkend="mime-forward">&dollar;mime&lowbar;forward</link> variable is

1253

unset, a copy of the forwarded message will be included. If you have

1254

specified a <link linkend="signature">&dollar;signature</link>, it will

1255

be appended to the message.

1038

1256

</para>

1039

1257

1040

1258

<para>

1095

1313

</sect2>

1096

1314

1097

1315

1098

<title>Editing the message header</title>

1316

<title>Editing the Message Header</title>

1099

1317

1100

1318

<para>

1101

1319

When editing the header because of <link linkend="edit-headers">&dollar;edit&lowbar;headers</link>

1102

1320

being set, there are a several pseudo headers available which

1103

will not be included in sent messages.

1321

will not be included in sent messages but trigger special Mutt behavior.

1104

1322

</para>

1105

1323

1106

1324

1107

<title>Fcc: pseudo header</title>

1325

<title>Fcc: Pseudo Header</title>

1108

1326

1109

1327

<para>

1110

1328

If you specify

1329

</para>

1111

1330

1331

<para>

1112

1332

<literal>Fcc:</literal> <emphasis>filename</emphasis>

1333

</para>

1113

1334

1335

<para>

1114

1336

as a header, Mutt will pick up <emphasis>filename</emphasis>

1115

1337

just as if you had used the <literal><edit-fcc></literal> function in the <emphasis>compose</emphasis> menu.

1338

It can later be changed from the compose menu.

1116

1339

</para>

1117

1340

1118

1341

</sect3>

1119

1342

1120

1343

1121

<title>Attach: pseudo header</title>

1344

<title>Attach: Pseudo Header</title>

1122

1345

1123

1346

<para>

1124

1347

You can also attach files to your message by specifying

1125

1126

<literal>Attach:</literal> <emphasis>filename</emphasis> [ <emphasis>description</emphasis> ]

1127

1348

</para>

1349

1350

<para>

1351

<literal>Attach:</literal> <emphasis>filename</emphasis>

1352

[ <emphasis>description</emphasis> ]

1353

</para>

1354

1355

<para>

1128

1356

where <emphasis>filename</emphasis> is the file to attach and <emphasis>description</emphasis> is an

1129

optional string to use as the description of the attached file.

1357

optional string to use as the description of the attached file. Spaces

1358

in filenames have to be escaped using backslash (<quote>\</quote>).

1359

The file can be removed as well as more added from the compose menu.

1130

1360

</para>

1131

1361

1132

1362

</sect3>

1133

1363

1134

1364

1135

<title>Pgp: pseudo header</title>

1365

<title>Pgp: Pseudo Header</title>

1136

1366

1137

1367

<para>

1138

1368

If you want to use PGP, you can specify

1147

1377

<quote>E</quote> selects encryption, <quote>S</quote> selects signing and

1148

1378

<quote>S<id></quote> selects signing with the given key, setting

1149

1379

1150

permanently.

1380

permanently. The selection can later be changed in the compose menu.

1151

1381

</para>

1152

1382

1153

1383

</sect3>

1154

1384

1155

1385

1156

<title>In-Reply-To: header</title>

1386

<title>In-Reply-To: Header</title>

1157

1387

1158

1388

<para>

1159

1389

When replying to messages, the <emphasis>In-Reply-To:</emphasis> header contains the

1160

Message-Id of the message(s) you reply to. If you remove its value, Mutt will not generate a

1390

Message-Id of the message(s) you reply to. If you remove or modify its value, Mutt will not generate a

1161

1391

<emphasis>References:</emphasis> field, which allows you to create a new message thread, for example

1162

1392

to create a new message to a mailing list without having to enter the mailing list's address.

1163

1393

</para>

1167

1397

</sect2>

1168

1398

1169

1399

1170

<title>Sending cryptographically signed/encrypted messages</title>

1400

<title>Sending Cryptographically Signed/Encrypted Messages</title>

1171

1401

1172

1402

<para>

1173

If you have told mutt to PGP or S/MIME encrypt a message, it will guide you

1403

If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you

1174

1404

through a key selection process when you try to send the message.

1175

1405

Mutt will not ask you any questions about keys which have a

1176

1406

certified user ID matching one of the message recipients' mail

1181

1411

1182

1412

<para>

1183

1413

In these cases, you are dropped into a menu with a list of keys from

1184

which you can select one. When you quit this menu, or mutt can't

1414

which you can select one. When you quit this menu, or Mutt can't

1185

1415

find any matching keys, you are prompted for a user ID. You can, as

1186

usually, abort this prompt using <literal>&circ;G</literal>. When you do so, mutt will

1416

usually, abort this prompt using <literal>&circ;G</literal>. When you do so, Mutt will

1187

1417

return to the compose screen.

1188

1418

</para>

1189

1419

1199

1429

</para>

1200

1430

1201

1431

<para>

1202

The flags sequence (&percnt;f) will expand to one of the flags in

1432

The flags sequence (<quote>&percnt;f</quote>) will expand to one of the flags in

1203

1433

<xref linkend="tab-pgp-menuflags"/>.

1204

1434

</para>

1205

1435

1219

1449

</table>

1220

1450

1221

1451

<para>

1222

The capabilities field (&percnt;c) expands to a two-character sequence

1452

The capabilities field (<quote>&percnt;c</quote>) expands to a two-character sequence

1223

1453

representing a key's capabilities. The first character gives

1224

1454

the key's encryption capabilities: A minus sign (<quote>-</quote>) means

1225

1455

that the key cannot be used for encryption. A dot (<quote>.</quote>) means that

1236

1466

</para>

1237

1467

1238

1468

<para>

1239

Finally, the validity field (&percnt;t) indicates how well-certified a user-id

1469

Finally, the validity field (<quote>&percnt;t</quote>) indicates how well-certified a user-id

1240

1470

is. A question mark (<quote>?</quote>) indicates undefined validity, a minus

1241

1471

character (<quote>-</quote>) marks an untrusted association, a space character

1242

1472

means a partially trusted association, and a plus character (<quote>+</quote>)

1245

1475

1246

1476

</sect2>

1247

1477

1248

1249

<title>Sending anonymous messages via mixmaster</title>

1250

1251

<para>

1252

You may also have compiled mutt to co-operate with Mixmaster, an

1253

anonymous remailer. Mixmaster permits you to send your messages

1254

anonymously using a chain of remailers. Mixmaster support in mutt is for

1255

mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.

1256

It does not support earlier versions or the later so-called version 3 betas,

1257

of which the latest appears to be called 2.9b23.

1258

</para>

1259

1260

<para>

1261

To use it, you'll have to obey certain restrictions. Most

1262

important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell

1263

Mutt to use mixmaster, you have to select a remailer chain, using

1264

the mix function on the compose menu.

1265

</para>

1266

1267

<para>

1268

The chain selection screen is divided into two parts. In the

1269

(larger) upper part, you get a list of remailers you may use. In

1270

the lower part, you see the currently selected chain of remailers.

1271

</para>

1272

1273

<para>

1274

You can navigate in the chain using the <literal><chain-prev></literal> and

1275

<literal><chain-next></literal> functions, which are by default bound to the left

1276

and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi

1277

keyboard bindings). To insert a remailer at the current chain

1278

position, use the <literal><insert></literal> function. To append a remailer behind

1279

the current chain position, use <literal><select-entry></literal> or <literal><append></literal>.

1280

You can also delete entries from the chain, using the corresponding

1281

function. Finally, to abandon your changes, leave the menu, or

1282

<literal><accept></literal> them pressing (by default) the <literal>Return</literal> key.

1283

</para>

1284

1285

<para>

1286

Note that different remailers do have different capabilities,

1287

indicated in the &percnt;c entry of the remailer menu lines (see

1288

1289

the <quote>middleman</quote> capability, indicated by a capital <quote>M</quote>: This

1290

means that the remailer in question cannot be used as the final

1291

element of a chain, but will only forward messages to other

1292

mixmaster remailers. For details on the other capabilities, please

1293

have a look at the mixmaster documentation.

1294

</para>

1295

1296

</sect2>

1297

1298

1478

1299

<title>Sending format=flowed messages</title>

1479

<title>Sending Format=Flowed Messages</title>

1300

1480

1301

1481

1302

1482

<title>Concept</title>

1311

1491

</para>

1312

1492

1313

1493

<para>

1314

While for text-mode clients like mutt it's the best way to assume only a

1494

While for text-mode clients like Mutt it's the best way to assume only a

1315

1495

standard 80x25 character cell terminal, it may be desired to let the

1316

1496

receiver decide completely how to view a message.

1317

1497

</para>

1319

1499

</sect3>

1320

1500

1321

1501

1322

<title>Mutt support</title>

1502

<title>Mutt Support</title>

1323

1503

1324

1504

<para>

1325

1505

Mutt only supports setting the required <literal>format=flowed</literal>

1331

1511

1332

1512

<para>

1333

1513

After editing the initial message text and before entering

1334

the compose menu, mutt properly space-stuffes the message.

1514

the compose menu, Mutt properly space-stuffes the message.

1335

1515

<emphasis>Space-stuffing</emphasis> is required by RfC3676 defining

1336

1516

<literal>format=flowed</literal> and means to prepend a space to:

1337

1517

</para>

1362

1542

</sect3>

1363

1543

1364

1544

1365

<title>Editor considerations</title>

1545

<title>Editor Considerations</title>

1366

1546

1367

1547

<para>

1368

As mutt provides no additional features to compose <literal>f=f</literal>

1548

As Mutt provides no additional features to compose <literal>f=f</literal>

1369

1549

messages, it's completely up to the user and his editor to produce

1370

1550

proper messages. Please consider your editor's documentation if you

1371

1551

intend to send <literal>f=f</literal> messages.

1411

1591

attachment, depending on the value of the <link linkend="mime-forward">&dollar;mime&lowbar;forward</link> variable. Decoding of attachments,

1412

1592

like in the pager, can be controlled by the <link linkend="forward-decode">&dollar;forward&lowbar;decode</link> and <link linkend="mime-forward-decode">&dollar;mime&lowbar;forward&lowbar;decode</link> variables,

1413

1593

respectively. The desired forwarding format may depend on the content,

1414

therefore <emphasis>&dollar;mime&lowbar;forward</emphasis> is a quadoption which, for

1594

therefore <link linkend="mime-forward">&dollar;mime&lowbar;forward</link> is a quadoption which, for

1415

1595

example, can be set to <quote>ask-no</quote>.

1416

1596

</para>

1417

1597

1468

1648

<title>Configuration</title>

1469

1649

1470

1650

1471

<title>Location of initialization files</title>

1651

<title>Location of Initialization Files</title>

1472

1652

1473

1653

<para>

1474

1654

While the default configuration (or <quote>preferences</quote>) make Mutt

1479

1659

<literal>/usr/local/share/mutt/Muttrc</literal> or <literal>/etc/Muttrc</literal>. Mutt

1480

1660

will next look for a file named <literal>.muttrc</literal> in your home

1481

1661

directory. If this file does not exist and your home directory has

1482

a subdirectory named <literal>.mutt</literal>, mutt try to load a file named

1662

a subdirectory named <literal>.mutt</literal>, Mutt tries to load a file named

1483

1663

<literal>.mutt/muttrc</literal>.

1484

1664

</para>

1485

1665

1488

1668

</para>

1489

1669

1490

1670

<para>

1491

In addition, mutt supports version specific configuration files that are

1671

In addition, Mutt supports version specific configuration files that are

1492

1672

parsed instead of the default files as explained above. For instance, if

1493

1673

your system has a <literal>Muttrc-0.88</literal> file in the system configuration

1494

directory, and you are running version 0.88 of mutt, this file will be

1674

directory, and you are running version 0.88 of Mutt, this file will be

1495

1675

sourced instead of the <literal>Muttrc</literal> file. The same is true of the user

1496

1676

configuration file, if you have a file <literal>.muttrc-0.88.6</literal> in your home

1497

directory, when you run mutt version 0.88.6, it will source this file

1677

directory, when you run Mutt version 0.88.6, it will source this file

1498

1678

instead of the default <literal>.muttrc</literal> file. The version number is the

1499

1679

same which is visible using the <quote>-v</quote> <link linkend="commandline">command line</link> switch or using the <literal>show-version</literal> key (default:

1500

1680

V) from the index menu.

1508

1688

<para>

1509

1689

An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands.

1510

1690

When multiple commands are used, they must be separated by a semicolon

1511

(;).

1691

(<quote>;</quote>).

1512

1692

</para>

1513

1693

1514

1694

1522

1702

The hash mark, or pound sign

1523

1703

(<quote>&num;</quote>), is used as a <quote>comment</quote> character. You can use it to

1524

1704

annotate your initialization file. All text after the comment character

1525

to the end of the line is ignored. For example,

1705

to the end of the line is ignored.

1526

1706

</para>

1527

1707

1528

1708

1533

1713

</example>

1534

1714

1535

1715

<para>

1536

Single quotes (') and double quotes (") can be used to quote strings

1716

Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>) can be used to quote strings

1537

1717

which contain spaces or other special characters. The difference between

1538

1718

the two types of quotes is similar to that of many popular shell programs,

1539

1719

namely that a single quote is used to specify a literal string (one that is

1540

1720

not interpreted for shell variables or quoting with a backslash [see

1541

1721

next paragraph]), while double quotes indicate a string for which

1542

1722

should be evaluated. For example, backticks are evaluated inside of double

1543

quotes, but <emphasis role="bold">not</emphasis> for single quotes.

1723

quotes, but <emphasis>not</emphasis> for single quotes.

1544

1724

</para>

1545

1725

1546

1726

<para>

1547

\ quotes the next character, just as in shells such as bash and zsh.

1727

<quote>\</quote> quotes the next character, just as in shells such as bash and zsh.

1548

1728

For example, if want to put quotes <quote>"</quote> inside of a string, you can use

1549

1729

<quote>\</quote> to force the next character to be a literal instead of interpreted

1550

1730

character.

1564

1744

</para>

1565

1745

1566

1746

<para>

1567

A \ at the end of a line can be used to split commands over

1568

multiple lines, provided that the split points don't appear in the

1569

middle of command names.

1747

A <quote>\</quote> at the end of a line can be used to split commands over

1748

multiple lines as it <quote>escapes</quote> the line end, provided that the split points don't appear in the

1749

middle of command names. Lines are first concatenated before

1750

interpretation so that a multi-line can be commented by commenting out

1751

the first line only.

1570

1752

</para>

1571

1753

1754

1755

<title>Splitting long configuration commands over several lines</title>

1756

1757

set status_format="some very \

1758

long value split \

1759

over several lines"

1760

</screen>

1761

</example>

1762

1572

1763

<para>

1573

1764

It is also possible to substitute the output of a Unix command in an

1574

1765

initialization file. This is accomplished by enclosing the command in

1575

backticks (``). For example,

1766

backticks (``). In <xref linkend="ex-rc-backtick"/>, the output of the

1767

Unix command <quote>uname -a</quote> will be substituted before the

1768

line is parsed.

1769

Since initialization files are line oriented, only

1770

the first line of output from the Unix command will be substituted.

1576

1771

</para>

1577

1772

1578

1773

1583

1778

</example>

1584

1779

1585

1780

<para>

1586

The output of the Unix command <quote>uname -a</quote> will be substituted before the

1587

line is parsed.

1588

</para>

1589

1590

<note>

1591

<para>

1592

Since initialization files are line oriented, only

1593

the first line of output from the Unix command will be substituted.

1594

</para>

1595

</note>

1596

1597

<para>

1598

Both environment variables and mutt variables can be accessed by

1781

Both environment variables and Mutt variables can be accessed by

1599

1782

prepending <quote>&dollar;</quote> to the name of the variable. For example,

1600

1783

</para>

1601

1784

1607

1790

</example>

1608

1791

1609

1792

<para>

1610

will cause mutt to save outgoing messages to a folder named

1611

<quote>sent_on_kremvax</quote> if the environment variable HOSTNAME is set to

1793

will cause Mutt to save outgoing messages to a folder named

1794

<quote>sent_on_kremvax</quote> if the environment variable <literal>&dollar;HOSTNAME</literal> is set to

1612

1795

<quote>kremvax.</quote> (See <link linkend="record">&dollar;record</link> for

1613

1796

details.)

1614

1797

</para>

1621

1804

</para>

1622

1805

1623

1806

<para>

1624

The commands understood by mutt are explained in the next paragraphs.

1807

The commands understood by Mutt are explained in the next paragraphs.

1625

1808

For a complete list, see the <link linkend="commands">command reference</link>.

1626

1809

</para>

1627

1810

1632

1815

If a configuration file is not encoded in the same character set the

1633

1816

1634

1817

variable should be used: all lines starting with the next are recoded

1635

from &dollar;config&lowbar;charset to &dollar;charset.

1818

from <link linkend="config-charset">&dollar;config&lowbar;charset</link>

1819

to <link linkend="charset">&dollar;charset</link>.

1636

1820

</para>

1637

1821

1638

1822

<para>

1643

1827

1644

1828

1645

1829

<listitem><para>These variables should be set early in a configuration

1646

file with &dollar;charset preceding &dollar;config&lowbar;charset so Mutt

1647

know what character set to convert to.</para></listitem>

1830

file with <link linkend="charset">&dollar;charset</link> preceding

1831

1832

knows what character set to convert to.</para></listitem>

1648

1833

1649

<listitem><para>If &dollar;config&lowbar;charset is set, it should be set

1834

<listitem><para>If <link linkend="config-charset">&dollar;config&lowbar;charset</link> is set, it should be set

1650

1835

in each configuration file because the value is global and <emphasis>not</emphasis>

1651

1836

per configuration file.</para></listitem>

1652

1837

1661

1846

</sect1>

1662

1847

1663

1848

1664

<title>Address groups</title>

1849

<title>Address Groups</title>

1665

1850

1666

1851

<para>Usage:</para>

1667

1852

1681

1866

1682

1867

</arg>

1683

1868

</group>

1684

</cmdsynopsis>

1685

1869

1686

1687

1870

<command>ungroup</command>

1688

1871

1689

1872

<option>-group</option>

1705

1888

</cmdsynopsis>

1706

1889

1707

1890

<para>

1708

<literal>group</literal> is used to directly add either addresses or

1891

<command>group</command> is used to directly add either addresses or

1709

1892

regular expressions to the specified group or groups. The different

1710

categories of arguments to the <literal>group</literal> command can be

1893

categories of arguments to the <command>group</command> command can be

1711

1894

in any order. The flags <literal>-rx</literal> and

1712

1895

<literal>-addr</literal> specify what the following strings (that cannot

1713

1896

begin with a hyphen) should be interpreted as: either a regular

1716

1899

1717

1900

<para>

1718

1901

These address groups can also be created implicitly by the

1719

1902

1720

1903

1721

1904

1722

1905

optional <literal>-group</literal> option.

1723

1906

</para>

1724

1907

1729

1912

</para>

1730

1913

1731

1914

<para>

1732

<literal>ungroup</literal> is used to remove addresses or regular

1915

<command>ungroup</command> is used to remove addresses or regular

1733

1916

expressions from the specified group or groups. The syntax is similar to

1734

the <literal>group</literal> command, however the special character

1917

the <command>group</command> command, however the special character

1735

1918

<literal>*</literal> can be used to empty a group of all of its

1736

1919

contents.

1737

1920

</para>

1739

1922

</sect1>

1740

1923

1741

1924

1742

<title>Defining/Using aliases</title>

1925

<title>Defining/Using Aliases</title>

1743

1926

1744

1927

<para>Usage:</para>

1745

1928

1758

1941

1759

1942

<replaceable class="parameter">address</replaceable>

1760

1943

</arg>

1944

1945

<command>unalias</command>

1946

1947

<option>-group</option>

1948

1949

</arg>

1950

1951

1952

1953

</arg>

1954

1955

1956

</arg>

1957

</group>

1761

1958

</cmdsynopsis>

1762

1959

1763

1960

<para>

1769

1966

<note>

1770

1967

<para>

1771

1968

If you want to create an alias for more than

1772

one address, you <emphasis role="bold">must</emphasis> separate the addresses with a comma (<quote>,</quote>).

1969

one address, you <emphasis>must</emphasis> separate the addresses with a comma (<quote>,</quote>).

1773

1970

</para>

1774

1971

</note>

1775

1972

1776

1973

<para>

1777

1974

The optional <literal>-group</literal> argument to

1778

<literal>alias</literal> causes the aliased address(es) to be added to

1975

<command>alias</command> causes the aliased address(es) to be added to

1779

1976

the named <emphasis>group</emphasis>.

1780

1977

</para>

1781

1978

1783

1980

To remove an alias or aliases (<quote>*</quote> means all aliases):

1784

1981

</para>

1785

1982

1786

1787

<command>unalias</command>

1788

1789

<option>-group</option>

1790

1791

</arg>

1792

1793

1794

1795

</arg>

1796

1797

1798

</arg>

1799

</group>

1800

</cmdsynopsis>

1801

1802

1983

1803

1984

alias muttdude me@cs.hmc.edu (Michael Elkins)

1804

1985

alias theguys manny, moe, jack

1806

1987

1807

1988

<para>

1808

1989

Unlike other mailers, Mutt doesn't require aliases to be defined

1809

in a special file. The <literal>alias</literal> command can appear anywhere in

1810

a configuration file, as long as this file is <link linkend="source">sourced</link>. Consequently, you can have multiple alias files, or

1811

you can have all aliases defined in your muttrc.

1990

in a special file. The <command>alias</command> command can appear anywhere in

1991

a configuration file, as long as this file is <link linkend="source"><command>source</command>d</link>. Consequently, you can have multiple alias files, or

1992

you can have all aliases defined in your <literal>.muttrc</literal>.

1812

1993

</para>

1813

1994

1814

1995

<para>

1816

1997

function can use only one file, the one pointed to by the <link linkend="alias-file">&dollar;alias&lowbar;file</link> variable (which is

1817

1998

<literal>&tilde;/.muttrc</literal> by default). This file is not special either,

1818

1999

in the sense that Mutt will happily append aliases to any file, but in

1819

order for the new aliases to take effect you need to explicitly <link linkend="source">source</link> this file too.

1820

</para>

1821

1822

<para>

1823

For example:

2000

order for the new aliases to take effect you need to explicitly <link linkend="source"><command>source</command></link> this file too.

1824

2001

</para>

1825

2002

1826

2003

1833

2010

</example>

1834

2011

1835

2012

<para>

1836

To use aliases, you merely use the alias at any place in mutt where mutt

2013

To use aliases, you merely use the alias at any place in Mutt where Mutt

1837

2014

prompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>Cc:</emphasis> prompt. You can

1838

2015

also enter aliases in your editor at the appropriate headers if you have the

1839

2016

1842

2019

<para>

1843

2020

In addition, at the various address prompts, you can use the tab character

1844

2021

to expand a partial alias to the full alias. If there are multiple matches,

1845

mutt will bring up a menu with the matching aliases. In order to be

1846

presented with the full list of aliases, you must hit tab with out a partial

2022

Mutt will bring up a menu with the matching aliases. In order to be

2023

presented with the full list of aliases, you must hit tab without a partial

1847

2024

alias, such as at the beginning of the prompt or after a comma denoting

1848

2025

multiple addresses.

1849

2026

</para>

1857

2034

</sect1>

1858

2035

1859

2036

1860

<title>Changing the default key bindings</title>

2037

<title>Changing the Default Key Bindings</title>

1861

2038

1862

2039

<para>Usage:</para>

1863

2040

1896

2073

menus except for the pager and editor modes. If a key is not defined in

1897

2074

another menu, Mutt will look for a binding to use in this menu. This allows

1898

2075

you to bind a key to a certain function in multiple menus instead of having

1899

multiple bind statements to accomplish the same task.

2076

multiple <command>bind</command> statements to accomplish the same task.

1900

2077

</para>

1901

2078

</listitem>

1902

2079

</varlistentry>

1905

2082

1906

2083

<para>

1907

2084

The alias menu is the list of your personal aliases as defined in your

1908

muttrc. It is the mapping from a short alias name to the full email

2085

<literal>.muttrc</literal>. It is the mapping from a short alias name to the full email

1909

2086

address(es) of the recipient(s).

1910

2087

</para>

1911

2088

</listitem>

2067

2244

</sect1>

2068

2245

2069

2246

2070

<title>Defining aliases for character sets </title>

2247

<title>Defining Aliases for Character Sets</title>

2071

2248

2072

2249

<para>Usage:</para>

2073

2250

2079

2256

2080

2257

<replaceable class="parameter">charset</replaceable>

2081

2258

</arg>

2082

</cmdsynopsis>

2083

2259

2084

2085

<command>iconv-hook</command>

2260

<command>iconv-hook<anchor id="iconv-hook"/></command>

2086

2261

2087

2262

<replaceable class="parameter">charset</replaceable>

2088

2263

</arg>

2092

2267

</cmdsynopsis>

2093

2268

2094

2269

<para>

2095

The <literal>charset-hook</literal> command defines an alias for a character set.

2270

The <command>charset-hook</command> command defines an alias for a character set.

2096

2271

This is useful to properly display messages which are tagged with a

2097

character set name not known to mutt.

2272

character set name not known to Mutt.

2098

2273

</para>

2099

2274

2100

2275

<para>

2101

The <literal>iconv-hook</literal> command defines a system-specific name for a

2276

The <command>iconv-hook</command> command defines a system-specific name for a

2102

2277

character set. This is helpful when your systems character

2103

2278

conversion library insists on using strange, system-specific names

2104

2279

for character sets.

2107

2282

</sect1>

2108

2283

2109

2284

2110

<title>Setting variables based upon mailbox</title>

2285

<title>Setting Variables Based Upon Mailbox</title>

2111

2286

2112

2287

<para>Usage:</para>

2113

2288

2123

2298

2124

2299

<para>

2125

2300

It is often desirable to change settings based on which mailbox you are

2126

reading. The folder-hook command provides a method by which you can execute

2301

reading. The <command>folder-hook</command> command provides a method by which you can execute

2127

2302

any configuration command. <emphasis>regexp</emphasis> is a regular expression specifying

2128

2303

in which mailboxes to execute <emphasis>command</emphasis> before loading. If a mailbox

2129

matches multiple folder-hook's, they are executed in the order given in the

2130

muttrc.

2304

matches multiple <command>folder-hook</command>s, they are executed in the order given in the

2305

<literal>.muttrc</literal>.

2131

2306

</para>

2132

2307

2133

2308

<note>

2143

2318

Settings are <emphasis>not</emphasis> restored when you leave the mailbox.

2144

2319

For example, a command action to perform is to change the sorting method

2145

2320

based upon the mailbox being read:

2146

</para>

2147

</note>

2148

2321

2149

2322

2150

folder-hook mutt set sort=threads

2151

</screen>

2323

folder-hook mutt "set sort=threads"</screen>

2152

2324

2153

<para>

2154

2325

However, the sorting method is not restored to its previous value when

2155

2326

reading a different mailbox. To specify a <emphasis>default</emphasis> command, use the

2156

pattern <quote>.</quote> before other folder-hooks adjusting a value on a per-folder basis

2157

because folder-hooks are evaluated in the order given in the configuration file.

2327

pattern <quote>.</quote> before other <command>folder-hook</command>s adjusting a value on a per-folder basis

2328

because <command>folder-hook</command>s are evaluated in the order given in the

2329

configuration file.

2330

</para>

2331

</note>

2332

2333

<para>

2158

2334

The following example will set the <link linkend="sort">sort</link> variable

2159

2335

to <literal>date-sent</literal> for all folders but to <literal>threads</literal>

2160

2336

for all folders containing <quote>mutt</quote> in their name.

2163

2339

2164

2340

<title>Setting sort method based on mailbox name</title>

2165

2341

2166

folder-hook . set sort=date-sent

2167

folder-hook mutt set sort=threads

2342

folder-hook . "set sort=date-sent"

2343

folder-hook mutt "set sort=threads"

2168

2344

</screen>

2169

2345

</example>

2170

2346

2171

2347

</sect1>

2172

2348

2173

2349

2174

<title>Keyboard macros</title>

2350

<title>Keyboard Macros</title>

2175

2351

2176

2352

<para>Usage:</para>

2177

2353

2228

2404

2229

2405

<para>

2230

2406

Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,

2231

which is shown in the help screens.

2407

which is shown in the help screens if they contain a description.

2232

2408

</para>

2233

2409

2234

2410

<note>

2241

2417

</sect1>

2242

2418

2243

2419

2244

<title>Using color and mono video attributes</title>

2420

<title>Using Color and Mono Video Attributes</title>

2245

2421

2246

2422

<para>Usage:</para>

2247

2423

2256

2432

2257

2433

<replaceable class="parameter">background</replaceable>

2258

2434

</arg>

2259

</cmdsynopsis>

2260

2435

2261

2262

2436

<command>color</command>

2263

2437

2264

2438

2277

2451

2278

2452

<replaceable class="parameter">regexp</replaceable>

2279

2453

</arg>

2280

</cmdsynopsis>

2281

2454

2282

2283

2455

<command>color</command>

2284

2456

2285

2457

<option>index</option>

2293

2465

2294

2466

<replaceable class="parameter">pattern</replaceable>

2295

2467

</arg>

2296

</cmdsynopsis>

2297

2468

2298

2299

2469

<command>uncolor</command>

2470

2300

2471

2301

2472

<option>index</option>

2302

2473

</arg>

2474

2475

<option>header</option>

2476

</arg>

2477

2478

2479

</arg>

2480

</group>

2303

2481

2304

2482

2305

2483

2313

2491

<para>

2314

2492

If your terminal supports color, you can spice up Mutt by creating your own

2315

2493

color scheme. To define the color of an object (type of information), you

2316

must specify both a foreground color <emphasis role="bold">and</emphasis> a background color (it is not

2494

must specify both a foreground color <emphasis>and</emphasis> a background color (it is not

2317

2495

possible to only specify one or the other).

2318

2496

</para>

2319

2497

2337

2515

<listitem><para>message (informational messages)</para></listitem>

2338

2516

<listitem><para>normal</para></listitem>

2339

2517

<listitem><para>quoted (text matching <link linkend="quote-regexp">&dollar;quote&lowbar;regexp</link> in the body of a message)</para></listitem>

2340

<listitem><para>quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis> (higher levels of quoting)</para></listitem>

2518

<listitem><para>quoted1, quoted2, ..., quoted<emphasis>N</emphasis> (higher levels of quoting)</para></listitem>

2341

2519

<listitem><para>search (hiliting of words in the pager)</para></listitem>

2342

2520

<listitem><para>signature</para></listitem><listitem><para>status (mode lines used to display info about the mailbox or message)</para></listitem>

2343

2521

<listitem><para>tilde (the <quote>&tilde;</quote> used to pad blank lines in the pager)</para></listitem>

2372

2550

If your terminal supports it, the special keyword <emphasis>default</emphasis> can be

2373

2551

used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.

2374

2552

If Mutt is linked against the <emphasis>S-Lang</emphasis> library, you also need to set

2375

the <emphasis>COLORFGBG</emphasis> environment variable to the default colors of your

2553

the <literal>&dollar;COLORFGBG</literal> environment variable to the default colors of your

2376

2554

terminal for this to work; for example (for Bourne-like shells):

2377

2555

</para>

2378

2556

2391

2569

2392

2570

<note>

2393

2571

<para>

2394

The uncolor command can be applied to the index object only. It

2395

removes entries from the list. You <emphasis role="bold">must</emphasis> specify the same pattern

2396

specified in the color command for it to be removed. The pattern <quote>*</quote> is

2397

a special token which means to clear the color index list of all entries.

2572

The <command>uncolor</command> command can be applied to the index, header and body objects only. It

2573

removes entries from the list. You <emphasis>must</emphasis> specify the same pattern

2574

specified in the <command>color</command> command for it to be removed. The pattern <quote>*</quote> is

2575

a special token which means to clear the color list of all entries.

2398

2576

</para>

2399

2577

</note>

2400

2578

2401

2579

<para>

2402

2580

Mutt also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>color1</emphasis>, …,

2403

<emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">N</emphasis> being the number of colors supported

2581

<emphasis>color</emphasis><emphasis>N-1</emphasis> (<emphasis>N</emphasis> being the number of colors supported

2404

2582

by your terminal). This is useful when you remap the colors for your

2405

2583

display (for example by changing the color associated with <emphasis>color2</emphasis>

2406

2584

for your xterm), since color names may then lose their normal meaning.

2407

2585

</para>

2408

2586

2587

2409

2588

<para>

2410

2589

If your terminal does not support color, it is still possible change the video

2411

attributes through the use of the <quote>mono</quote> command:

2590

attributes through the use of the <quote>mono</quote> command. Usage:

2412

2591

</para>

2413

2592

2414

2415

<para>Usage:</para>

2416

2417

2593

2418

2594

2419

2595

2422

2598

2423

2599

<replaceable class="parameter">attribute</replaceable>

2424

2600

</arg>

2425

</cmdsynopsis>

2426

2601

2427

2428

2602

2429

2603

2430

2604

2440

2614

2441

2615

<replaceable class="parameter">regexp</replaceable>

2442

2616

</arg>

2443

</cmdsynopsis>

2444

2617

2445

2446

2618

2447

2619

2448

2620

<option>index</option>

2453

2625

2454

2626

<replaceable class="parameter">pattern</replaceable>

2455

2627

</arg>

2456

</cmdsynopsis>

2457

2628

2458

2459

2629

<command>unmono</command>

2630

2460

2631

2461

2632

<option>index</option>

2462

2633

</arg>

2634

2635

<option>header</option>

2636

</arg>

2637

2638

2639

</arg>

2640

</group>

2463

2641

2464

2642

2465

2643

2471

2649

</cmdsynopsis>

2472

2650

2473

2651

<para>

2474

For <emphasis>object</emphasis>, see the color command. <emphasis>attribute</emphasis>

2652

For <emphasis>object</emphasis>, see the <command>color</command> command. <emphasis>attribute</emphasis>

2475

2653

can be one of the following:

2476

2654

</para>

2477

2655

2485

2663

2486

2664

</sect1>

2487

2665

2488

2489

<title>Message header display</title>

2666

2667

<title>Message Header Display</title>

2668

2669

2670

<title>Selecting Headers</title>

2490

2671

2491

2672

<para>Usage:</para>

2492

2673

2498

2679

2499

2680

<replaceable class="parameter">pattern</replaceable>

2500

2681

</arg>

2501

</cmdsynopsis>

2502

2682

2503

2504

2683

<command>unignore</command>

2505

2684

2506

2685

2534

2713

<quote>unignore *</quote> will remove all tokens from the ignore list.

2535

2714

</para>

2536

2715

2537

<para>

2538

For example:

2539

</para>

2540

2541

2716

2542

2717

<title>Header weeding</title>

2543

2718

2549

2724

</screen>

2550

2725

</example>

2551

2726

2552

2727

</sect2>

2728

2729

2730

<title>Ordering Displayed Headers</title>

2731

2553

2732

<para>Usage:</para>

2554

2733

2555

2734

2560

2739

2561

2740

<replaceable class="parameter">header</replaceable>

2562

2741

</arg>

2563

</cmdsynopsis>

2564

2742

2565

2566

2743

<command>unhdr&lowbar;order</command>

2567

2744

2568

2745

2575

2752

</cmdsynopsis>

2576

2753

2577

2754

<para>

2578

With the <literal>hdr&lowbar;order</literal> command you can specify an order in

2579

which mutt will attempt to present these headers to you when viewing messages.

2755

With the <command>hdr&lowbar;order</command> command you can specify an order in

2756

which Mutt will attempt to present these headers to you when viewing messages.

2580

2757

</para>

2581

2758

2582

2759

<para>

2583

<quote>unhdr&lowbar;order *</quote> will clear all previous headers from the order list,

2760

<quote><command>unhdr&lowbar;order</command> *</quote> will clear all previous headers from the order list,

2584

2761

thus removing the header order effects set by the system-wide startup file.

2585

2762

</para>

2586

2763

2591

2768

</screen>

2592

2769

</example>

2593

2770

2771

</sect2>

2594

2772

</sect1>

2595

2773

2596

2774

2597

<title>Alternative addresses</title>

2775

<title>Alternative Addresses</title>

2598

2776

2599

2777

<para>Usage:</para>

2600

2778

2610

2788

2611

2789

<replaceable>regexp</replaceable>

2612

2790

</arg>

2613

</cmdsynopsis>

2614

2791

2615

2616

2792

<command>unalternates</command>

2617

2793

2618

2794

<option>-group</option>

2629

2805

</cmdsynopsis>

2630

2806

2631

2807

<para>

2632

With various functions, mutt will treat messages differently,

2808

With various functions, Mutt will treat messages differently,

2633

2809

depending on whether you sent them or whether you received them from

2634

2810

someone else. For instance, when replying to a message that you

2635

sent to a different party, mutt will automatically suggest to send

2636

the response to the original message's recipients -- responding to

2811

sent to a different party, Mutt will automatically suggest to send

2812

the response to the original message's recipients — responding to

2637

2813

yourself won't make much sense in many cases. (See <link linkend="reply-to">&dollar;reply&lowbar;to</link>.)

2638

2814

</para>

2639

2815

2640

2816

<para>

2641

2817

Many users receive e-mail under a number of different addresses. To

2642

fully use mutt's features here, the program must be able to

2818

fully use Mutt's features here, the program must be able to

2643

2819

recognize what e-mail addresses you receive mail under. That's the

2644

purpose of the <literal>alternates</literal> command: It takes a list of regular

2820

purpose of the <command>alternates</command> command: It takes a list of regular

2645

2821

expressions, each of which can identify an address under which you

2646

2822

receive e-mail.

2647

2823

</para>

2657

2833

</screen>

2658

2834

2659

2835

<para>

2660

mutt will consider <quote><literal>some-user@example</literal></quote> as

2836

Mutt will consider <quote><literal>some-user@example</literal></quote> as

2661

2837

being your address, too which may not be desired. As a solution, in such

2662

2838

cases addresses should be specified as:

2663

2839

</para>

2672

2848

</para>

2673

2849

2674

2850

<para>

2675

The <literal>unalternates</literal> command can be used to write exceptions to

2676

<literal>alternates</literal> patterns. If an address matches something in an

2677

<literal>alternates</literal> command, but you nonetheless do not think it is

2678

from you, you can list a more precise pattern under an <literal>unalternates</literal>

2851

The <command>unalternates</command> command can be used to write exceptions to

2852

<command>alternates</command> patterns. If an address matches something in an

2853

<command>alternates</command> command, but you nonetheless do not think it is

2854

from you, you can list a more precise pattern under an <command>unalternates</command>

2679

2855

command.

2680

2856

</para>

2681

2857

2682

2858

<para>

2683

To remove a regular expression from the <literal>alternates</literal> list, use the

2684

<literal>unalternates</literal> command with exactly the same <emphasis>regexp</emphasis>.

2685

Likewise, if the <emphasis>regexp</emphasis> for an <literal>alternates</literal> command matches

2686

an entry on the <literal>unalternates</literal> list, that <literal>unalternates</literal>

2687

entry will be removed. If the <emphasis>regexp</emphasis> for <literal>unalternates</literal>

2688

is <quote>*</quote>, <emphasis>all entries</emphasis> on <literal>alternates</literal> will be removed.

2859

To remove a regular expression from the <command>alternates</command> list, use the

2860

<command>unalternates</command> command with exactly the same <emphasis>regexp</emphasis>.

2861

Likewise, if the <emphasis>regexp</emphasis> for an <command>alternates</command> command matches

2862

an entry on the <command>unalternates</command> list, that <command>unalternates</command>

2863

entry will be removed. If the <emphasis>regexp</emphasis> for <command>unalternates</command>

2864

is <quote>*</quote>, <emphasis>all entries</emphasis> on <command>alternates</command> will be removed.

2689

2865

</para>

2690

2866

2691

2867

</sect1>

2692

2868

2693

2869

2694

<title>Mailing lists</title>

2870

<title>Mailing Lists</title>

2695

2871

2696

2872

2697

2873

<para>Usage:</para>

2708

2884

2709

2885

<replaceable class="parameter">regexp</replaceable>

2710

2886

</arg>

2711

</cmdsynopsis>

2712

2887

2713

2714

2888

<command>unlists</command>

2715

2889

2716

2890

<option>-group</option>

2724

2898

<replaceable class="parameter">regexp</replaceable>

2725

2899

</arg>

2726

2900

</group>

2727

</cmdsynopsis>

2728

2901

2729

2730

2902

<command>subscribe</command>

2731

2903

2732

2904

<option>-group</option>

2738

2910

2739

2911

<replaceable class="parameter">regexp</replaceable>

2740

2912

</arg>

2741

</cmdsynopsis>

2742

2913

2743

2744

2914

<command>unsubscribe</command>

2745

2915

2746

2916

<option>-group</option>

2759

2929

<para>

2760

2930

Mutt has a few nice features for <link linkend="using-lists">handling mailing lists</link>. In order to take advantage of them, you must

2761

2931

specify which addresses belong to mailing lists, and which mailing

2762

lists you are subscribed to. Once you have done this, the <link linkend="list-reply"><literal><list-reply></literal></link> function will work for all known lists.

2763

Additionally, when you send a message to a subscribed list, mutt will

2932

lists you are subscribed to. Mutt also has limited support for

2933

auto-detecting mailing lists: it supports parsing

2934

<literal>mailto:</literal> links in the common

2935

<literal>List-Post:</literal> header which has the same effect as

2936

specifying the list address via the <command>lists</command> command

2937

(except the group feature). Once you have done this, the

2938

2939

function will work for all known lists.

2940

Additionally, when you send a message to a subscribed list, Mutt will

2764

2941

add a Mail-Followup-To header to tell other users' mail user agents

2765

2942

not to send copies of replies to your personal address.

2766

2943

</para>

2772

2949

receiving personal CCs of list messages. Also note that the generation

2773

2950

of the Mail-Followup-To header is controlled by the

2774

2951

2775

configuration variable.

2952

configuration variable since it's common practice on some mailing lists

2953

to send Cc upons replies (which is more a group- than a list-reply).

2776

2954

</para>

2777

2955

</note>

2778

2956

2779

2957

<para>

2780

2958

More precisely, Mutt maintains lists of patterns for the addresses

2781

2959

of known and subscribed mailing lists. Every subscribed mailing

2782

list is known. To mark a mailing list as known, use the <quote>lists</quote>

2783

command. To mark it as subscribed, use <quote>subscribe</quote>.

2960

list is known. To mark a mailing list as known, use the <command>list</command>

2961

command. To mark it as subscribed, use <command>subscribe</command>.

2784

2962

</para>

2785

2963

2786

2964

<para>

2787

You can use regular expressions with both commands. To mark all

2788

messages sent to a specific bug report's address on mutt's bug

2965

You can use regular expressions with both commands. To mark all

2966

messages sent to a specific bug report's address on Debian's bug

2789

2967

tracking system as list mail, for instance, you could say

2790

<quote>subscribe [0-9]*@bugs.guug.de</quote>. Often, it's sufficient to just

2791

give a portion of the list's e-mail address.

2968

</para>

2969

2970

2971

subscribe [0-9]*.*@bugs.debian.org</screen>

2972

2973

<para>

2974

as it's often, it's sufficient to just give a portion of the list's e-mail address.

2792

2975

</para>

2793

2976

2794

2977

<para>

2795

2978

Specify as much of the address as you need to to remove ambiguity. For

2796

2979

example, if you've subscribed to the Mutt mailing list, you will receive mail

2797

addressed to <emphasis>mutt-users@mutt.org</emphasis>. So, to tell Mutt

2798

that this is a mailing list, you could add <quote>lists mutt-users@</quote> to your

2799

initialization file. To tell mutt that you are subscribed to it,

2800

add <quote>subscribe mutt-users</quote> to your initialization file instead.

2980

addressed to <literal>mutt-users@mutt.org</literal>. So, to tell Mutt

2981

that this is a mailing list, you could add <literal>lists mutt-users@</literal> to your

2982

initialization file. To tell Mutt that you are subscribed to it,

2983

add <literal><command>subscribe</command> mutt-users</literal> to your initialization file instead.

2801

2984

If you also happen to get mail from someone whose address is

2802

<emphasis>mutt-users@example.com</emphasis>, you could use

2803

<quote>lists ^mutt-users@mutt\\.org$</quote>

2804

or <quote>subscribe ^mutt-users@mutt\\.org$</quote> to

2985

<literal>mutt-users@example.com</literal>, you could use

2986

<literal><command>lists</command> ^mutt-users@mutt\\.org$</literal>

2987

or <literal><command>subscribe</command> ^mutt-users@mutt\\.org$</literal> to

2805

2988

match only mail from the actual list.

2806

2989

</para>

2807

2990

2818

3001

2819

3002

<para>

2820

3003

To remove a mailing list from the list of subscribed mailing lists,

2821

but keep it on the list of known mailing lists, use <quote>unsubscribe</quote>.

3004

but keep it on the list of known mailing lists, use <command>unsubscribe</command>.

2822

3005

</para>

2823

3006

2824

3007

</sect1>

2825

3008

2826

3009

2827

<title>Using Multiple spool mailboxes</title>

3010

<title>Using Multiple Spool Mailboxes</title>

2828

3011

2829

3012

<para>Usage:</para>

2830

3013

2855

3038

</sect1>

2856

3039

2857

3040

2858

<title>Monitoring incoming mail</title>

3041

<title>Monitoring Incoming Mail</title>

2859

3042

2860

3043

<para>Usage:</para>

2861

3044

2867

3050

2868

3051

<replaceable class="parameter">mailbox</replaceable>

2869

3052

</arg>

2870

</cmdsynopsis>

2871

3053

2872

2873

3054

<command>unmailboxes</command>

2874

3055

2875

3056

2910

3091

2911

3092

<note>

2912

3093

<para>

2913

The folders in the <literal>mailboxes</literal> command are resolved when

3094

The folders in the <command>mailboxes</command> command are resolved when

2914

3095

the command is executed, so if these names contain <link linkend="shortcuts">shortcut characters</link> (such as <quote>=</quote> and <quote>!</quote>), any variable

2915

3096

definition that affects these characters (like <link linkend="folder">&dollar;folder</link> and <link linkend="spoolfile">&dollar;spoolfile</link>)

2916

should be set before the <literal>mailboxes</literal> command. If

3097

should be set before the <command>mailboxes</command> command. If

2917

3098

none of these shorcuts are used, a local path should be absolute as

2918

otherwise mutt tries to find it relative to the directory

2919

from where mutt was started which may not always be desired.

3099

otherwise Mutt tries to find it relative to the directory

3100

from where Mutt was started which may not always be desired.

2920

3101

</para>

2921

3102

</note>

2922

3103

2936

3117

unreliable, the

2937

3118

2938

3119

option can be used to make Mutt track and consult file sizes for new

2939

mail detection instead.

3120

mail detection instead which won't work for size-neutral changes.

2940

3121

</para>

2941

3122

2942

3123

</sect1>

2943

3124

2944

3125

2945

<title>User defined headers</title>

3126

<title>User-Defined Headers</title>

2946

3127

2947

3128

<para>Usage:</para>

2948

3129

2951

3132

2952

3133

<replaceable class="parameter">string</replaceable>

2953

3134

</arg>

2954

</cmdsynopsis>

2955

3135

2956

2957

3136

<command>unmy&lowbar;hdr</command>

2958

3137

2959

3138

2966

3145

</cmdsynopsis>

2967

3146

2968

3147

<para>

2969

The <literal>my&lowbar;hdr</literal> command allows you to create your own header

2970

fields which will be added to every message you send.

3148

The <command>my&lowbar;hdr</command> command allows you to create your own header

3149

fields which will be added to every message you send and appear in the

3150

editor if <link linkend="edit-headers">&dollar;edit&lowbar;headers</link> is set.

2971

3151

</para>

2972

3152

2973

3153

<para>

2974

3154

For example, if you would like to add an <quote>Organization:</quote> header field to

2975

all of your outgoing messages, you can put the command

3155

all of your outgoing messages, you can put the command something like

3156

shown in <xref linkend="ex-my-hdr"/> in your <literal>.muttrc</literal>.

2976

3157

</para>

2977

3158

2978

3159

2982

3163

</screen>

2983

3164

</example>

2984

3165

2985

<para>

2986

in your <literal>.muttrc</literal>.

2987

</para>

2988

2989

3166

<note>

2990

3167

<para>

2991

3168

Space characters are <emphasis>not</emphasis> allowed between the keyword and

3002

3179

</para>

3003

3180

3004

3181

<para>

3005

To remove user defined header fields, use the <literal>unmy&lowbar;hdr</literal>

3182

To remove user defined header fields, use the <command>unmy&lowbar;hdr</command>

3006

3183

command. You may specify an asterisk (<quote>*</quote>) to remove all header

3007

3184

fields, or the fields to remove. For example, to remove all <quote>To</quote> and

3008

3185

<quote>Cc</quote> header fields, you could use:

3015

3192

</sect1>

3016

3193

3017

3194

3018

<title>Specify default save mailbox</title>

3195

<title>Specify Default Save Mailbox</title>

3019

3196

3020

3197

<para>Usage:</para>

3021

3198

3042

3219

<emphasis>mailbox</emphasis> after it was expanded.

3043

3220

</para>

3044

3221

3045

<para>

3046

Examples:

3047

</para>

3048

3049

3222

3050

<title>Using %-expandos in <literal>save-hook</literal></title>

3223

<title>Using %-expandos in <command>save-hook</command></title>

3051

3224

3052

3225

# default: save all to ~/Mail/<author name>

3053

3226

save-hook . ~/Mail/%F

3061

3234

</example>

3062

3235

3063

3236

<para>

3064

Also see the <link linkend="fcc-save-hook">fcc-save-hook</link> command.

3237

Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.

3065

3238

</para>

3066

3239

3067

3240

</sect1>

3068

3241

3069

3242

3070

<title>Specify default Fcc: mailbox when composing</title>

3243

<title>Specify Default Fcc: Mailbox When Composing</title>

3071

3244

3072

3245

<para>Usage:</para>

3073

3246

3099

3272

See <xref linkend="pattern-hook"/> for information on the exact format of <emphasis>pattern</emphasis>.

3100

3273

</para>

3101

3274

3102

<para>

3103

Example: <literal>fcc-hook [@.]aol\\.com&dollar; +spammers</literal>

3104

</para>

3275

<screen>fcc-hook [@.]aol\\.com&dollar; +spammers</screen>

3105

3276

3106

3277

<para>

3107

The above will save a copy of all messages going to the aol.com domain to

3108

the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook">fcc-save-hook</link> command.

3278

...will save a copy of all messages going to the aol.com domain to

3279

the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.

3109

3280

</para>

3110

3281

3111

3282

</sect1>

3112

3283

3113

3284

3114

<title>Specify default save filename and default Fcc: mailbox at once</title>

3285

<title>Specify Default Save Filename and Default Fcc: Mailbox at Once</title>

3115

3286

3116

3287

<para>Usage:</para>

3117

3288

3126

3297

</cmdsynopsis>

3127

3298

3128

3299

<para>

3129

This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook">fcc-hook</link>

3130

and a <link linkend="save-hook">save-hook</link> with its arguments,

3300

This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook"><command>fcc-hook</command></link>

3301

and a <link linkend="save-hook"><command>save-hook</command></link> with its arguments,

3131

3302

including &percnt;-expansion on <emphasis>mailbox</emphasis> according

3132

3303

to <link linkend="index-format">&dollar;index&lowbar;format</link>.

3133

3304

</para>

3135

3306

</sect1>

3136

3307

3137

3308

3138

<title>Change settings based upon message recipients</title>

3309

<title>Change Settings Based Upon Message Recipients</title>

3139

3310

3140

3311

3141

3312

3150

3321

3151

3322

<replaceable class="parameter">command</replaceable>

3152

3323

</arg>

3153

</cmdsynopsis>

3154

3324

3155

3156

3325

3157

3326

3158

3327

<replaceable class="parameter">[!]pattern</replaceable>

3160

3329

3161

3330

<replaceable class="parameter">command</replaceable>

3162

3331

</arg>

3163

</cmdsynopsis>

3164

3332

3165

3166

3333

3167

3334

3168

3335

<replaceable class="parameter">[!]pattern</replaceable>

3180

3347

</para>

3181

3348

3182

3349

<para>

3183

<literal>reply-hook</literal> is matched against the message you are <emphasis>replying to</emphasis>,

3184

instead of the message you are <emphasis>sending</emphasis>. <literal>send-hook</literal> is

3350

<command>reply-hook</command> is matched against the message you are <emphasis>replying to</emphasis>,

3351

instead of the message you are <emphasis>sending</emphasis>. <command>send-hook</command> is

3185

3352

matched against all messages, both <emphasis>new</emphasis>

3186

3353

and <emphasis>replies</emphasis>.

3187

3354

</para>

3188

3355

3189

3356

<note>

3190

3357

<para>

3191

<literal>reply-hook</literal>s are matched <emphasis role="bold">before</emphasis> the <literal>send-hook</literal>, <emphasis role="bold">regardless</emphasis>

3358

<command>reply-hook</command>s are matched <emphasis>before</emphasis> the <command>send-hook</command>, <emphasis>regardless</emphasis>

3192

3359

of the order specified in the user's configuration file.

3193

3360

</para>

3194

3361

</note>

3195

3362

3196

3363

<para>

3197

<literal>send2-hook</literal> is matched every time a message is changed, either

3364

<command>send2-hook</command> is matched every time a message is changed, either

3198

3365

by editing it, or by using the compose menu to change its recipients

3199

or subject. <literal>send2-hook</literal> is executed after <literal>send-hook</literal>, and

3366

or subject. <command>send2-hook</command> is executed after <command>send-hook</command>, and

3200

3367

can, e.g., be used to set parameters such as the <link linkend="sendmail">&dollar;sendmail</link> variable depending on the message's sender

3201

3368

address.

3202

3369

</para>

3203

3370

3204

3371

<para>

3205

For each type of <literal>send-hook</literal> or <literal>reply-hook</literal>, when multiple matches

3206

occur, commands are executed in the order they are specified in the muttrc

3372

For each type of <command>send-hook</command> or <command>reply-hook</command>, when multiple matches

3373

occur, commands are executed in the order they are specified in the <literal>.muttrc</literal>

3207

3374

(for that type of hook).

3208

3375

</para>

3209

3376

3210

3377

<para>

3211

Example: <literal>send-hook mutt "set mime&lowbar;forward signature=''"</literal>

3378

Example: <literal><command>send-hook</command> mutt "<command>set</command> mime&lowbar;forward signature=''"</literal>

3212

3379

</para>

3213

3380

3214

3381

<para>

3220

3387

3221

3388

<note>

3222

3389

<para>

3223

send-hook's are only executed once after getting the initial

3224

list of recipients. Adding a recipient after replying or editing the

3225

message will not cause any send-hook to be executed. Also note that

3226

<literal>my&lowbar;hdr</literal> commands which modify recipient headers, or the message's

3227

subject, don't have any effect on the current message when executed

3228

from a send-hook.

3390

<command>send-hook</command>'s are only executed once after getting the

3391

initial list of recipients. Adding a recipient after replying or

3392

editing the message will not cause any <command>send-hook</command> to be executed,

3393

similarily if <link linkend="autoedit">&dollar;autoedit</link> is set

3394

(as then the initial list of recipients is empty). Also note that <link

3395

linkend="my-hdr"><command>my&lowbar;hdr</command></link> commands which

3396

modify recipient headers, or the message's subject, don't have any

3397

effect on the current message when executed from a

3398

<command>send-hook</command>.

3229

3399

</para>

3230

3400

</note>

3231

3401

3232

3402

</sect1>

3233

3403

3234

3404

3235

<title>Change settings before formatting a message</title>

3405

<title>Change Settings Before Formatting a Message</title>

3236

3406

3237

3407

<para>Usage:</para>

3238

3408

3251

3421

before viewing or formatting a message based upon information about the message.

3252

3422

<emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be

3253

3423

displayed. When multiple matches occur, commands are executed in the order

3254

they are specified in the muttrc.

3424

they are specified in the <literal>.muttrc</literal>.

3255

3425

</para>

3256

3426

3257

3427

<para>

3271

3441

</sect1>

3272

3442

3273

3443

3274

<title>Choosing the cryptographic key of the recipient</title>

3444

<title>Choosing the Cryptographic Key of the Recipient</title>

3275

3445

3276

3446

<para>Usage:</para>

3277

3447

3290

3460

key with a given e-mail address automatically, either because the

3291

3461

recipient's public key can't be deduced from the destination address,

3292

3462

or because, for some reasons, you need to override the key Mutt would

3293

normally use. The <literal>crypt-hook</literal> command provides a

3463

normally use. The <command>crypt-hook</command> command provides a

3294

3464

method by which you can specify the ID of the public key to be used

3295

3465

when encrypting messages to a certain recipient.

3296

3466

</para>

3304

3474

</sect1>

3305

3475

3306

3476

3307

<title>Adding key sequences to the keyboard buffer</title>

3477

<title>Adding Key Sequences to the Keyboard Buffer</title>

3308

3478

3309

3479

<para>Usage:</para>

3310

3480

3320

3490

contain control characters, key names and function names like the sequence

3321

3491

string in the <link linkend="macro">macro</link> command. You may use it to

3322

3492

automatically run a sequence of commands at startup, or when entering

3323

certain folders. For example, the following command will automatically

3324

collapse all threads when entering a folder:

3493

certain folders. For example, <xref linkend="ex-folder-hook-push"/>

3494

shows how to automatically collapse all threads when entering a folder.

3325

3495

</para>

3326

3496

3327

3497

3328

<title>Embedding <literal>push</literal> in <literal>folder-hook</literal></title>

3498

<title>Embedding <command>push</command> in <command>folder-hook</command></title>

3329

3499

3330

3500

folder-hook . 'push <collapse-all>'

3331

3501

</screen>

3334

3504

</sect1>

3335

3505

3336

3506

3337

<title>Executing functions</title>

3507

<title>Executing Functions</title>

3338

3508

3339

3509

<para>Usage:</para>

3340

3510

3351

3521

<para>

3352

3522

This command can be used to execute any function. Functions are

3353

3523

listed in the <link linkend="functions">function reference</link>.

3354

<quote>exec function</quote> is equivalent to <quote>push <function></quote>.

3524

<quote><command>exec</command><literal>function</literal></quote> is equivalent to

3525

<quote><literal>push <function></literal></quote>.

3355

3526

</para>

3356

3527

3357

3528

</sect1>

3369

3540

3370

3541

<replaceable class="parameter">value</replaceable>

3371

3542

</arg>

3372

</cmdsynopsis>

3373

3543

3374

3375

3544

<command>unscore</command>

3376

3545

3377

3546

3384

3553

</cmdsynopsis>

3385

3554

3386

3555

<para>

3387

The <literal>score</literal> commands adds <emphasis>value</emphasis> to a message's score if <emphasis>pattern</emphasis>

3556

The <command>score</command> commands adds <emphasis>value</emphasis> to a message's score if <emphasis>pattern</emphasis>

3388

3557

matches it. <emphasis>pattern</emphasis> is a string in the format described in the <link linkend="patterns">patterns</link> section (note: For efficiency reasons, patterns

3389

3558

which scan information not available in the index, such as <literal>&tilde;b</literal>,

3390

3559

<literal>&tilde;B</literal> or <literal>&tilde;h</literal>, may not be used). <emphasis>value</emphasis> is a

3391

3560

positive or negative integer. A message's final score is the sum total of all

3392

matching <literal>score</literal> entries. However, you may optionally prefix <emphasis>value</emphasis> with

3393

an equal sign (=) to cause evaluation to stop at a particular entry if there is

3561

matching <command>score</command> entries. However, you may optionally prefix <emphasis>value</emphasis> with

3562

an equal sign (<quote>=</quote>) to cause evaluation to stop at a particular entry if there is

3394

3563

a match. Negative final scores are rounded up to 0.

3395

3564

</para>

3396

3565

3397

3566

<para>

3398

The <literal>unscore</literal> command removes score entries from the list. You <emphasis role="bold">must</emphasis>

3399

specify the same pattern specified in the <literal>score</literal> command for it to be

3567

The <command>unscore</command> command removes score entries from the list. You <emphasis>must</emphasis>

3568

specify the same pattern specified in the <command>score</command> command for it to be

3400

3569

removed. The pattern <quote>*</quote> is a special token which means to clear the list

3401

3570

of all score entries.

3402

3571

</para>

3404

3573

</sect1>

3405

3574

3406

3575

3407

<title>Spam detection</title>

3576

<title>Spam Detection</title>

3408

3577

3409

3578

<para>Usage:</para>

3410

3579

3416

3585

3417

3586

<replaceable class="parameter">format</replaceable>

3418

3587

</arg>

3419

</cmdsynopsis>

3420

3588

3421

3422

3589

<command>nospam</command>

3423

3590

3424

3591

3432

3599

3433

3600

<para>

3434

3601

Mutt has generalized support for external spam-scoring filters.

3435

By defining your spam patterns with the <literal>spam</literal> and <literal>nospam</literal>

3602

By defining your spam patterns with the <command>spam</command> and <literal>nospam</literal>

3436

3603

commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>sort</emphasis> your

3437

3604

mail based on its spam attributes, as determined by the external

3438

3605

filter. You also can display the spam attributes in your index

3442

3609

3443

3610

<para>

3444

3611

Your first step is to define your external filter's spam patterns using

3445

the <literal>spam</literal> command. <emphasis>pattern</emphasis> should be a regular expression

3612

the <command>spam</command> command. <emphasis>pattern</emphasis> should be a regular expression

3446

3613

that matches a header in a mail message. If any message in the mailbox

3447

3614

matches this regular expression, it will receive a <quote>spam tag</quote> or

3448

<quote>spam attribute</quote> (unless it also matches a <literal>nospam</literal> pattern -- see

3615

<quote>spam attribute</quote> (unless it also matches a <command>nospam</command> pattern — see

3449

3616

below.) The appearance of this attribute is entirely up to you, and is

3450

3617

governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static

3451

3618

text, but it also can include back-references from the <emphasis>pattern</emphasis>

3455

3622

</para>

3456

3623

3457

3624

<para>

3625

To match spam tags, mutt needs the corresponding header information

3626

which is always the case for local and POP folders but not for IMAP in

3627

the default configuration. Depending on the spam header to be analyzed,

3628

3629

to be adjusted.

3630

</para>

3631

3632

<para>

3458

3633

If you're using multiple spam filters, a message can have more than

3459

one spam-related header. You can define <literal>spam</literal> patterns for each

3634

one spam-related header. You can define <command>spam</command> patterns for each

3460

3635

filter you use. If a message matches two or more of these patterns, and

3461

the &dollar;spam&lowbar;separator variable is set to a string, then the

3636

the <link linkend="spam-separator">&dollar;spam&lowbar;separator</link> variable is set to a string, then the

3462

3637

message's spam tag will consist of all the <emphasis>format</emphasis> strings joined

3463

together, with the value of &dollar;spam&lowbar;separator separating

3638

together, with the value of <link linkend="spam-separator">&dollar;spam&lowbar;separator</link> separating

3464

3639

them.

3465

3640

</para>

3466

3641

3467

3642

<para>

3468

For example, suppose I use DCC, SpamAssassin, and PureMessage. I might

3469

define these spam settings:

3643

For example, suppose one uses DCC, SpamAssassin, and PureMessage, then

3644

the configuration might look like in <xref linkend="ex-spam"/>.

3470

3645

</para>

3471

3646

3472

3647

3480

3655

</example>

3481

3656

3482

3657

<para>

3483

If I then received a message that DCC registered with <quote>many</quote> hits

3658

If then a message is received that DCC registered with <quote>many</quote> hits

3484

3659

under the <quote>Fuz2</quote> checksum, and that PureMessage registered with a

3485

3660

97&percnt; probability of being spam, that message's spam tag would read

3486

3661

<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before <quote>=many</quote> in a

3487

DCC report indicate the checksum used -- in this case, <quote>Fuz2</quote>.)

3662

DCC report indicate the checksum used — in this case, <quote>Fuz2</quote>.)

3488

3663

</para>

3489

3664

3490

3665

<para>

3491

If the &dollar;spam&lowbar;separator variable is unset, then each

3666

If the <link linkend="spam-separator">&dollar;spam&lowbar;separator</link> variable is unset, then each

3492

3667

spam pattern match supersedes the previous one. Instead of getting

3493

3668

joined <emphasis>format</emphasis> strings, you'll get only the last one to match.

3494

3669

</para>

3495

3670

3496

3671

<para>

3497

3672

The spam tag is what will be displayed in the index when you use

3498

<literal>&percnt;H</literal> in the <literal>&dollar;index&lowbar;format</literal> variable. It's also the

3673

<literal>&percnt;H</literal> in the <link linkend="index-format">&dollar;index&lowbar;format</link> variable. It's also the

3499

3674

string that the <literal>&tilde;H</literal> pattern-matching expression matches against for

3500

3675

<literal><search></literal> and <literal><limit></literal> functions. And it's what sorting by spam

3501

3676

attribute will use as a sort key.

3504

3679

<para>

3505

3680

That's a pretty complicated example, and most people's actual

3506

3681

environments will have only one spam filter. The simpler your

3507

configuration, the more effective mutt can be, especially when it comes

3682

configuration, the more effective Mutt can be, especially when it comes

3508

3683

to sorting.

3509

3684

</para>

3510

3685

3511

3686

<para>

3512

Generally, when you sort by spam tag, mutt will sort <emphasis>lexically</emphasis> --

3687

Generally, when you sort by spam tag, Mutt will sort <emphasis>lexically</emphasis> —

3513

3688

that is, by ordering strings alphanumerically. However, if a spam tag

3514

begins with a number, mutt will sort numerically first, and lexically

3689

begins with a number, Mutt will sort numerically first, and lexically

3515

3690

only when two numbers are equal in value. (This is like UNIX's

3516

<literal>sort -n</literal>.) A message with no spam attributes at all -- that is, one

3517

that didn't match <emphasis>any</emphasis> of your <literal>spam</literal> patterns -- is sorted at

3691

<literal>sort -n</literal>.) A message with no spam attributes at all — that is, one

3692

that didn't match <emphasis>any</emphasis> of your <command>spam</command> patterns — is sorted at

3518

3693

lowest priority. Numbers are sorted next, beginning with 0 and ranging

3519

3694

upward. Finally, non-numeric strings are sorted, with <quote>a</quote> taking lower

3520

3695

priority than <quote>z</quote>. Clearly, in general, sorting by spam tags is most

3521

3696

effective when you can coerce your filter to give you a raw number. But

3522

in case you can't, mutt can still do something useful.

3697

in case you can't, Mutt can still do something useful.

3523

3698

</para>

3524

3699

3525

3700

<para>

3526

The <literal>nospam</literal> command can be used to write exceptions to <literal>spam</literal>

3527

patterns. If a header pattern matches something in a <literal>spam</literal> command,

3701

The <command>nospam</command> command can be used to write exceptions to <command>spam</command>

3702

patterns. If a header pattern matches something in a <command>spam</command> command,

3528

3703

but you nonetheless do not want it to receive a spam tag, you can list a

3529

more precise pattern under a <literal>nospam</literal> command.

3704

more precise pattern under a <command>nospam</command> command.

3530

3705

</para>

3531

3706

3532

3707

<para>

3533

If the <emphasis>pattern</emphasis> given to <literal>nospam</literal> is exactly the same as the

3534

<emphasis>pattern</emphasis> on an existing <literal>spam</literal> list entry, the effect will be to

3708

If the <emphasis>pattern</emphasis> given to <command>nospam</command> is exactly the same as the

3709

<emphasis>pattern</emphasis> on an existing <command>spam</command> list entry, the effect will be to

3535

3710

remove the entry from the spam list, instead of adding an exception.

3536

Likewise, if the <emphasis>pattern</emphasis> for a <literal>spam</literal> command matches an entry

3537

on the <literal>nospam</literal> list, that <literal>nospam</literal> entry will be removed. If the

3538

<emphasis>pattern</emphasis> for <literal>nospam</literal> is <quote>*</quote>, <emphasis>all entries on both lists</emphasis>

3539

will be removed. This might be the default action if you use <literal>spam</literal>

3540

and <literal>nospam</literal> in conjunction with a <literal>folder-hook</literal>.

3711

Likewise, if the <emphasis>pattern</emphasis> for a <command>spam</command> command matches an entry

3712

on the <command>nospam</command> list, that nospam entry will be removed. If the

3713

<emphasis>pattern</emphasis> for <command>nospam</command> is <quote>*</quote>, <emphasis>all entries on both lists</emphasis>

3714

will be removed. This might be the default action if you use <command>spam</command>

3715

and <command>nospam</command> in conjunction with a <command>folder-hook</command>.

3541

3716

</para>

3542

3717

3543

3718

<para>

3544

You can have as many <literal>spam</literal> or <literal>nospam</literal> commands as you like.

3545

You can even do your own primitive spam detection within mutt -- for

3719

You can have as many <command>spam</command> or <command>nospam</command> commands as you like.

3720

You can even do your own primitive <command>spam</command> detection within Mutt — for

3546

3721

example, if you consider all mail from <literal>MAILER-DAEMON</literal> to be spam,

3547

you can use a <literal>spam</literal> command like this:

3722

you can use a <command>spam</command> command like this:

3548

3723

</para>

3549

3724

3550

3725

3556

3731

3557

3732

<title>Setting and Querying Variables</title>

3558

3733

3734

3735

<title>Variable Types</title>

3736

3737

<para>

3738

Mutt supports these types of configuration variables:

3739

</para>

3740

3741

3742

3743

<term>boolean</term>

3744

3745

<para>

3746

A boolean expression, either <quote>yes</quote> or <quote>no</quote>.

3747

</para>

3748

</listitem>

3749

</varlistentry>

3750

3751

<term>number</term>

3752

3753

<para>

3754

A signed integer number in the range -32768 to 32767.

3755

</para>

3756

</listitem>

3757

</varlistentry>

3758

3759

<term>string</term>

3760

3761

<para>

3762

Arbitrary text.

3763

</para>

3764

</listitem>

3765

</varlistentry>

3766

3767

3768

3769

<para>

3770

A specialized string for representing paths including support for

3771

mailbox shortcuts (see <xref linkend="shortcuts"/>) as well as tilde

3772

(<quote>&tilde;</quote>) for a user's home directory and more.

3773

</para>

3774

</listitem>

3775

</varlistentry>

3776

3777

<term>quadoption</term>

3778

3779

<para>

3780

Like a boolean but triggers a prompt when set to <quote>ask-yes</quote>

3781

or <quote>ask-no</quote> with <quote>yes</quote> and <quote>no</quote>

3782

preselected respectively.

3783

</para>

3784

</listitem>

3785

</varlistentry>

3786

3787

<term>sort order</term>

3788

3789

<para>

3790

A specialized string allowing only particular words as values depending

3791

on the variable.

3792

</para>

3793

</listitem>

3794

</varlistentry>

3795

3796

<term>regular expression</term>

3797

3798

<para>

3799

A regular expression, see <xref linkend="regexp"/> for an introduction.

3800

</para>

3801

</listitem>

3802

</varlistentry>

3803

3804

<term>folder magic</term>

3805

3806

<para>

3807

Specifies the type of folder to use: <emphasis>mbox</emphasis>,

3808

3809

or <emphasis>maildir</emphasis>.

3810

Currently only used to determine the type for newly created folders.

3811

</para>

3812

</listitem>

3813

</varlistentry>

3814

3815

<term>e-mail address</term>

3816

3817

<para>

3818

An e-mail address either with or without

3819

realname. The older <quote><literal>user@example.org (Joe User)</literal></quote>

3820

form is supported but strongly deprecated.

3821

</para>

3822

</listitem>

3823

</varlistentry>

3824

3825

<term>user-defined</term>

3826

3827

<para>

3828

Arbitrary text, see <xref linkend="set-myvar"/> for details.

3829

</para>

3830

</listitem>

3831

</varlistentry>

3832

</variablelist>

3833

3834

</sect2>

3835

3559

3836

3560

3837

<title>Commands</title>

3561

3838

3579

3856

<replaceable class="parameter">variable=value</replaceable>

3580

3857

</arg>

3581

3858

</group>

3582

3583

</cmdsynopsis>

3859

3584

3860

3585

3586

3861

<command>toggle</command>

3587

3862

3588

3863

<replaceable class="parameter">variable</replaceable>

3590

3865

3591

3866

<replaceable class="parameter">variable</replaceable>

3592

3867

</arg>

3593

</cmdsynopsis>

3594

3868

3595

3596

3869

<command>unset</command>

3597

3870

3598

3871

<replaceable class="parameter">variable</replaceable>

3600

3873

3601

3874

<replaceable class="parameter">variable</replaceable>

3602

3875

</arg>

3603

</cmdsynopsis>

3604

3876

3605

3606

3877

<command>reset</command>

3607

3878

3608

3879

<replaceable class="parameter">variable</replaceable>

3630

3901

</para>

3631

3902

3632

3903

<para>

3633

Prefixing a variable with <quote>no</quote> will unset it. Example: <literal>set noaskbcc</literal>.

3904

Prefixing a variable with <quote>no</quote> will unset it. Example: <literal><command>set</command> noaskbcc</literal>.

3634

3905

</para>

3635

3906

3636

3907

<para>

3637

3908

For <emphasis>boolean</emphasis> variables, you may optionally prefix the variable name with

3638

3909

<literal>inv</literal> to toggle the value (on or off). This is useful when writing

3639

macros. Example: <literal>set invsmart&lowbar;wrap</literal>.

3910

macros. Example: <literal><command>set</command> invsmart&lowbar;wrap</literal>.

3640

3911

</para>

3641

3912

3642

3913

<para>

3643

The <literal>toggle</literal> command automatically prepends the <literal>inv</literal> prefix to all

3914

The <command>toggle</command> command automatically prepends the <literal>inv</literal> prefix to all

3644

3915

specified variables.

3645

3916

</para>

3646

3917

3647

3918

<para>

3648

The <literal>unset</literal> command automatically prepends the <literal>no</literal> prefix to all

3919

The <command>unset</command> command automatically prepends the <literal>no</literal> prefix to all

3649

3920

specified variables.

3650

3921

</para>

3651

3922

3665

3936

</para>

3666

3937

3667

3938

<para>

3668

The <literal>reset</literal> command resets all given variables to the compile time

3939

The <command>reset</command> command resets all given variables to the compile time

3669

3940

defaults (hopefully mentioned in this manual). If you use the command

3670

<literal>set</literal> and prefix the variable with <quote>&</quote> this has the same

3671

behavior as the reset command.

3941

<command>set</command> and prefix the variable with <quote>&</quote> this has the same

3942

behavior as the <command>reset</command> command.

3672

3943

</para>

3673

3944

3674

3945

<para>

3675

With the <literal>reset</literal> command there exists the special variable <quote>all</quote>,

3946

With the <command>reset</command> command there exists the special variable <quote>all</quote>,

3676

3947

which allows you to reset all variables to their system defaults.

3677

3948

</para>

3678

3949

3679

3950

</sect2>

3680

3951

3681

3952

3682

<title>User-defined variables</title>

3953

<title>User-Defined Variables</title>

3683

3954

3684

3955

3685

3956

<title>Introduction</title>

3686

3957

3687

3958

<para>

3688

3959

Along with the variables listed in the

3689

3960

3690

3961

supports user-defined variables with names starting

3691

3962

with <literal>my&lowbar;</literal> as in, for

3692

3963

example, <literal>my&lowbar;cfgdir</literal>.

3693

3964

</para>

3694

3965

3695

3966

<para>

3696

The <literal>set</literal> command either creates a

3967

The <command>set</command> command either creates a

3697

3968

custom <literal>my&lowbar;</literal> variable or changes its

3698

value if it does exist already. The <literal>unset</literal> and <literal>reset</literal>

3969

value if it does exist already. The <command>unset</command> and <command>reset</command>

3699

3970

commands remove the variable entirely.

3700

3971

</para>

3701

3972

3714

3985

3715

3986

<para>

3716

3987

The following example defines and uses the variable <literal>my&lowbar;cfgdir</literal>

3717

to abbreviate the calls of the <link linkend="source">source</link> command:

3988

to abbreviate the calls of the <link linkend="source"><command>source</command></link> command:

3718

3989

</para>

3719

3990

3720

3991

3749

4020

</example>

3750

4021

3751

4022

<para>

3752

Since mutt expands such values already when parsing the configuration

4023

Since Mutt expands such values already when parsing the configuration

3753

4024

file(s), the value of <literal>&dollar;my&lowbar;delete</literal> in the

3754

last example would be the value of <literal>&dollar;delete</literal> exactly

4025

last example would be the value of <link linkend="delete">&dollar;delete</link> exactly

3755

4026

as it was at that point during parsing the configuration file. If

3756

another statement would change the value for <literal>&dollar;delete</literal>

4027

another statement would change the value for <link linkend="delete">&dollar;delete</link>

3757

4028

later in the same or another file, it would have no effect on

3758

4029

<literal>&dollar;my&lowbar;delete</literal>. However, the expansion can

3759

4030

be deferred to runtime, as shown in the next example, when escaping the

3774

4045

<para>

3775

4046

Note that there is a space

3776

4047

between <literal><enter-command></literal> and

3777

the <literal>set</literal> configuration command, preventing mutt from

3778

recording the macro's commands into its history.

4048

the <command>set</command> configuration command, preventing Mutt from

4049

recording the <command>macro</command>'s commands into its history.

3779

4050

</para>

3780

4051

3781

4052

</sect3>

3785

4056

</sect1>

3786

4057

3787

4058

3788

<title>Reading initialization commands from another file</title>

4059

<title>Reading Initialization Commands From Another File</title>

3789

4060

3790

4061

<para>Usage:</para>

3791

4062

3809

4080

</para>

3810

4081

3811

4082

<para>

3812

If the filename ends with a vertical bar (|), then <emphasis>filename</emphasis> is

4083

If the filename ends with a vertical bar (<quote>|</quote>), then <emphasis>filename</emphasis> is

3813

4084

considered to be an executable program from which to read input (eg.

3814

<literal>source &tilde;/bin/myscript|</literal>).

4085

<literal><command>source</command> &tilde;/bin/myscript|</literal>).

3815

4086

</para>

3816

4087

3817

4088

</sect1>

3818

4089

3819

4090

3820

<title>Removing hooks</title>

4091

<title>Removing Hooks</title>

3821

4092

3822

4093

<para>Usage:</para>

3823

4094

3837

4108

This command permits you to flush hooks you have previously defined.

3838

4109

You can either remove all hooks by giving the <quote>*</quote> character as an

3839

4110

argument, or you can remove all hooks of a specific type by saying

3840

something like <literal>unhook send-hook</literal>.

4111

something like <literal><command>unhook</command> send-hook</literal>.

3841

4112

</para>

3842

4113

3843

4114

</sect1>

3850

4121

3851

4122

<para>

3852

4123

Format strings are a general concept you'll find in several locations

3853

through the mutt configuration, especially in the

4124

through the Mutt configuration, especially in the

3854

4125

3855

4126

3856

4127

3857

and other <quote>*_format</quote> variables. These can be very straightforward,

4128

and other related variables. These can be very straightforward,

3858

4129

and it's quite possible you already know how to use them.

3859

4130

</para>

3860

4131

3871

4142

<para>

3872

4143

Some of the modifiers are borrowed right out of C (though you might

3873

4144

know them from Perl, Python, shell, or another language). These are

3874

the [-]m.n modifiers, as in <literal>%-12.12s</literal>. As with

4145

the <literal>[-]m.n</literal> modifiers, as in <literal>%-12.12s</literal>. As with

3875

4146

such programming languages, these modifiers allow you to specify the

3876

4147

minimum and maximum size of the resulting string, as well as its

3877

4148

justification. If the <quote>-</quote> sign follows the percent, the string will

3878

4149

be left-justified instead of right-justified. If there's a number

3879

4150

immediately following that, it's the minimum amount of space the

3880

formatted string will occupy -- if it's naturally smaller than that, it

4151

formatted string will occupy — if it's naturally smaller than that, it

3881

4152

will be padded out with spaces. If a decimal point and another number

3882

follow, that's the maximum space allowable -- the string will not be

4153

follow, that's the maximum space allowable — the string will not be

3883

4154

permitted to exceed that width, no matter its natural size. Each of

3884

4155

these three elements is optional, so that all these are legal format

3885

strings:

3886

3887

3888

3889

4156

strings: <literal>%-12s</literal>, <literal>%4c</literal>,

4157

<literal>%.15F</literal> and <literal>%-12.15L</literal>.

3890

4158

</para>

3891

4159

3892

4160

<para>

3894

4162

symbol (<literal>=</literal>) as a numeric prefix (like the minus

3895

4163

above), it will force the string to be centered within its minimum

3896

4164

space range. For example, <literal>%=14y</literal> will reserve 14

3897

characters for the %y expansion -- that's the X-Label: header, in

3898

<literal>&dollar;index&lowbar;format</literal>. If the expansion

4165

characters for the %y expansion — that's the X-Label: header, in

4166

3899

4167

results in a string less than 14 characters, it will be centered in a

3900

14-character space. If the X-Label for a message were "test", that

3901

expansion would look like <quote> test </quote>.

4168

14-character space. If the X-Label for a message were <quote>test</quote>, that

4169

expansion would look like <quote>     test     </quote>.

3902

4170

</para>

3903

4171

3904

4172

<para>

3911

4179

3912

4180

</sect2>

3913

4181

4182

4183

<title>Conditionals</title>

4184

4185

<para>

4186

Depending on the format string variable, some of its sequences can be

4187

used to optionally print a string if their value is nonzero. For

4188

example, you may only want to see the number of flagged messages if such

4189

messages exist, since zero is not particularly meaningful. To optionally

4190

print a string based upon one of the above sequences, the following

4191

construct is used:

4192

</para>

4193

4194

4195

&percnt;?<sequence_char>?<optional_string>?</screen>

4196

4197

<para>

4198

where <emphasis>sequence_char</emphasis> is an expando, and

4199

<emphasis>optional_string</emphasis> is the string you would like printed if

4200

<emphasis>sequence_char</emphasis> is nonzero.

4201

<emphasis>optional_string</emphasis> may contain other

4202

sequences as well as normal text, but you may not nest optional

4203

strings.

4204

</para>

4205

4206

<para>

4207

Here is an example illustrating how to optionally print the number of

4208

new messages in a mailbox in

4209

4210

</para>

4211

4212

4213

&percnt;?n?&percnt;n new messages.?</screen>

4214

4215

<para>

4216

You can also switch between two strings using the following construct:

4217

</para>

4218

4219

4220

&percnt;?<sequence_char>?<if_string>&<else_string>?</screen>

4221

4222

<para>

4223

If the value of <emphasis>sequence_char</emphasis> is

4224

non-zero, <emphasis>if_string</emphasis> will be expanded,

4225

otherwise <emphasis>else_string</emphasis> will be expanded.

4226

</para>

4227

4228

</sect2>

4229

3914

4230

3915

4231

<title>Filters</title>

3916

4232

3936

4252

</example>

3937

4253

3938

4254

<para>

3939

will make mutt expand <literal>&percnt;r</literal>,

4255

will make Mutt expand <literal>&percnt;r</literal>,

3940

4256

<literal>&percnt;f</literal> and <literal>&percnt;L</literal>

3941

4257

before calling the script. The example also shows that arguments can be

3942

4258

quoted: the script will receive the expanded string between the single quotes

3946

4262

<para>

3947

4263

A practical example is the <literal>mutt&lowbar;xtitle</literal>

3948

4264

script installed in the <literal>samples</literal>

3949

subdirectory of the mutt documentation: it can be used as filter for

3950

<literal>&dollar;status&lowbar;format</literal> to set the current

4265

subdirectory of the Mutt documentation: it can be used as filter for

4266

3951

4267

terminal's title, if supported.

3952

4268

</para>

3953

4269

3954

4270

</sect2>

3955

4271

4272

4273

<title>Padding</title>

4274

4275

<para>

4276

In most format strings, Mutt supports different types of padding using

4277

special &percnt;-expandos:

4278

</para>

4279

4280

4281

4282

4283

4284

<para>

4285

When this occurs, Mutt will fill the rest of the

4286

line with the character <literal>X</literal>. For

4287

example, filling the rest of the line with dashes is

4288

done by setting:

4289

</para>

4290

4291

set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>

4292

</listitem>

4293

</varlistentry>

4294

4295

<term>

4296

4297

</term>

4298

4299

<para>

4300

Since the previous expando stops at the end of line, there must be a way

4301

to fill the gap between two items via the <literal>&percnt;>X</literal>

4302

expando: it puts as many characters <literal>X</literal> in between two

4303

items so that the rest of the line will be right-justified. For example,

4304

to not put the version string and hostname the above example on the left

4305

but on the right and fill the gap with spaces, one might use (note the

4306

space after <literal>&percnt;></literal>):

4307

</para>

4308

4309

set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>

4310

</listitem>

4311

</varlistentry>

4312

4313

4314

</term>

4315

4316

<para>

4317

Normal right-justification will print everything to the left of the

4318

<literal>%></literal>, displaying padding and whatever lies to the

4319

right only if there's room. By contrast, <quote>soft-fill</quote> gives

4320

priority to the right-hand side, guaranteeing space to display it and

4321

showing padding only if there's still room. If necessary, soft-fill will

4322

eat text leftwards to make room for rightward text. For example, to

4323

right-justify the subject making sure as much as possible of it fits on

4324

screen, one might use (note two spaces after <literal>&percnt;*

4325

</literal>: the second ensures there's a space between the truncated

4326

right-hand side and the subject):

4327

</para>

4328

4329

set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"</screen>

4330

</listitem>

4331

</varlistentry>

4332

</variablelist>

4333

4334

</sect2>

4335

3956

4336

</sect1>

3957

4337

3958

4338

</chapter>

3978

4358

3979

4359

<note>

3980

4360

<para>

3981

Note that <quote>\</quote>

4361

3982

4362

must be quoted if used for a regular expression in an initialization

3983

4363

command: <quote>\\</quote>.

3984

4364

</para>

3992

4372

3993

4373

<note>

3994

4374

<para>

3995

Note that the regular expression can be enclosed/delimited by either "

4375

The regular expression can be enclosed/delimited by either "

3996

4376

or ' which is useful if the regular expression includes a white-space

3997

4377

character. See <xref linkend="muttrc-syntax"/>

3998

4378

for more information on " and ' delimiter processing. To match a

4016

4396

<para>

4017

4397

A list of characters enclosed by <quote>[</quote> and <quote>]</quote> matches any

4018

4398

single character in that list; if the first character of the list

4019

is a caret <quote>&circ;</quote> then it matches any character <emphasis role="bold">not</emphasis> in the

4020

list. For example, the regular expression <emphasis role="bold">[0123456789]</emphasis>

4399

is a caret <quote>&circ;</quote> then it matches any character <emphasis>not</emphasis> in the

4400

list. For example, the regular expression <emphasis>[0123456789]</emphasis>

4021

4401

matches any single digit. A range of ASCII characters may be specified

4022

4402

by giving the first and last characters, separated by a hyphen

4023

4403

<quote>-</quote>. Most metacharacters lose their special meaning inside

4066

4446

Note that the brackets in these

4067

4447

class names are part of the symbolic names, and must be included

4068

4448

in addition to the brackets delimiting the bracket list. For

4069

example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to

4070

<emphasis role="bold">[0-9]</emphasis>.

4449

example, <emphasis>[[:digit:]]</emphasis> is equivalent to

4450

<emphasis>[0-9]</emphasis>.

4071

4451

</para>

4072

4452

</note>

4073

4453

4087

4467

<para>

4088

4468

A collating symbol is a multi-character collating element enclosed in

4089

4469

<quote>[.</quote> and <quote>.]</quote>. For example, if <quote>ch</quote> is a collating

4090

element, then <emphasis role="bold">[[.ch.]]</emphasis> is a regexp that matches

4091

this collating element, while <emphasis role="bold">[ch]</emphasis> is a regexp that

4470

element, then <emphasis>[[.ch.]]</emphasis> is a regexp that matches

4471

this collating element, while <emphasis>[ch]</emphasis> is a regexp that

4092

4472

matches either <quote>c</quote> or <quote>h</quote>.

4093

4473

</para>

4094

4474

</listitem>

4101

4481

characters that are equivalent. The name is enclosed in <quote>[=</quote>

4102

4482

and <quote>=]</quote>. For example, the name <quote>e</quote> might be used to

4103

4483

represent all of <quote>è</quote> <quote>é</quote> and <quote>e</quote>. In this case,

4104

<emphasis role="bold">[[=e=]]</emphasis> is a regexp that matches any of

4484

<emphasis>[[=e=]]</emphasis> is a regexp that matches any of

4105

4485

<quote>è</quote>, <quote>é</quote> and <quote>e</quote>.

4106

4486

</para>

4107

4487

</listitem>

4151

4531

4152

4532

<note>

4153

4533

<para>

4154

If you compile Mutt with the GNU <emphasis>rx</emphasis> package, the

4534

If you compile Mutt with the included regular expression engine, the

4155

4535

following operators may also be used in regular expressions as described in <xref linkend="regex-gnu-ext"/>.

4156

4536

</para>

4157

4537

</note>

4185

4565

4186

4566

<title>Patterns: Searching, Limiting and Tagging</title>

4187

4567

4568

4569

<title>Pattern Modifier</title>

4570

4188

4571

<para>

4189

4572

Many of Mutt's commands allow you to specify a pattern to match

4190

4573

(<literal>limit</literal>, <literal>tag-pattern</literal>,

4228

4611

<row><entry>~n [<emphasis>MIN</emphasis>]-[<emphasis>MAX</emphasis>]</entry><entry>messages with a score in the range <emphasis>MIN</emphasis> to <emphasis>MAX</emphasis> *)</entry></row>

4229

4612

<row><entry>~N</entry><entry>new messages</entry></row>

4230

4613

<row><entry>~O</entry><entry>old messages</entry></row>

4231

<row><entry>~p</entry><entry>messages addressed to you (consults alternates)</entry></row>

4232

<row><entry>~P</entry><entry>messages from you (consults alternates)</entry></row>

4614

<row><entry>~p</entry><entry>messages addressed to you (consults <command>alternates</command>)</entry></row>

4615

<row><entry>~P</entry><entry>messages from you (consults <command>alternates</command>)</entry></row>

4233

4616

<row><entry>~Q</entry><entry>messages which have been replied to</entry></row>

4234

4617

<row><entry>~r [<emphasis>MIN</emphasis>]-[<emphasis>MAX</emphasis>]</entry><entry>messages with <quote>date-received</quote> in a Date range</entry></row>

4235

4618

<row><entry>~R</entry><entry>read messages</entry></row>

4241

4624

<row><entry>~U</entry><entry>unread messages</entry></row>

4242

4625

<row><entry>~v</entry><entry>messages part of a collapsed thread.</entry></row>

4243

4626

<row><entry>~V</entry><entry>cryptographically verified messages</entry></row>

4244

<row><entry>~x <emphasis>EXPR</emphasis></entry><entry>messages which contain <emphasis>EXPR</emphasis> in the <quote>References</quote> field</entry></row>

4627

<row><entry>~x <emphasis>EXPR</emphasis></entry><entry>messages which contain <emphasis>EXPR</emphasis> in the <quote>References</quote> or <quote>In-Reply-To</quote> field</entry></row>

4245

4628

<row><entry>~X [<emphasis>MIN</emphasis>]-[<emphasis>MAX</emphasis>]</entry><entry>messages with <emphasis>MIN</emphasis> to <emphasis>MAX</emphasis> attachments *)</entry></row>

4246

4629

<row><entry>~y <emphasis>EXPR</emphasis></entry><entry>messages which contain <emphasis>EXPR</emphasis> in the <quote>X-Label</quote> field</entry></row>

4247

<row><entry>~z [<emphasis>MIN</emphasis>]-[<emphasis>MAX</emphasis>]</entry><entry>messages with a size in the range <emphasis>MIN</emphasis> to <emphasis>MAX</emphasis> *)</entry></row>

4630

<row><entry>~z [<emphasis>MIN</emphasis>]-[<emphasis>MAX</emphasis>]</entry><entry>messages with a size in the range <emphasis>MIN</emphasis> to <emphasis>MAX</emphasis> *) **)</entry></row>

4248

4631

<row><entry>~=</entry><entry>duplicated messages (see <link linkend="duplicate-threads">&dollar;duplicate&lowbar;threads</link>)</entry></row>

4249

4632

<row><entry>~$</entry><entry>unreferenced messages (requires threaded view)</entry></row>

4250

4633

<row><entry>~(<emphasis>PATTERN</emphasis>)</entry><entry>messages in threads

4256

4639

4257

4640

<para>

4258

4641

Where <emphasis>EXPR</emphasis> is a

4259

4260

made when using regular expressions inside of patterns. Specifically,

4642

4643

</para>

4644

4645

<para>

4646

*) The forms <quote><[<emphasis>MAX</emphasis>]</quote>, <quote>>[<emphasis>MIN</emphasis>]</quote>,

4647

4648

are allowed, too.

4649

</para>

4650

4651

<para>

4652

**) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to specify kilobyte and megabyte respectively.

4653

</para>

4654

4655

<para>

4656

Special attention has to be

4657

payed when using regular expressions inside of patterns. Specifically,

4261

4658

Mutt's parser for these patterns will strip one level of backslash (<quote>\</quote>),

4262

4659

which is normally used for quoting. If it is your intention to use a

4263

4660

backslash in the regular expression, you will need to use two backslashes

4264

instead (<quote>\\</quote>). You can force mutt to treat <emphasis>EXPR</emphasis> as a simple string

4661

instead (<quote>\\</quote>). You can force Mutt to treat <emphasis>EXPR</emphasis> as a simple string

4265

4662

instead of a regular expression by using = instead of &tilde; in the

4266

4663

pattern name. For example, <literal>=b *.*</literal> will find all messages that contain

4267

4664

the literal string <quote>*.*</quote>. Simple string matches are less powerful than

4268

4665

regular expressions but can be considerably faster. This is especially

4269

4666

true for IMAP folders, because string matches can be performed on the

4270

4667

server instead of by fetching every message. IMAP treats <literal>=h</literal> specially:

4271

it must be of the form "header: substring" and will not partially

4668

it must be of the form <quote>header: substring</quote> and will not partially

4272

4669

match header names. The substring part may be omitted if you simply

4273

4670

wish to find messages containing a particular header without regard to

4274

4671

its value.

4275

4672

</para>

4276

4673

4277

4674

<para>

4278

*) The forms <quote><[<emphasis>MAX</emphasis>]</quote>, <quote>>[<emphasis>MIN</emphasis>]</quote>,

4279

4280

are allowed, too.

4281

</para>

4282

4283

4284

<title>Pattern Modifier</title>

4285

4286

<note>

4287

<para>

4288

Note that patterns matching 'lists' of addresses (notably c, C, p, P and t)

4675

Patterns matching lists of addresses (notably c, C, p, P and t)

4289

4676

match if there is at least one match in the whole list. If you want to

4290

4677

make sure that all elements of that list match, you need to prefix your

4291

4678

pattern with <quote>&circ;</quote>.

4292

4679

This example matches all mails which only has recipients from Germany.

4293

4680

</para>

4294

</note>

4295

4681

4682

4683

<title>Matching all addresses in address lists</title>

4296

4684

4297

4685

^~C \.de$

4298

4686

</screen>

4687

</example>

4299

4688

4300

4689

</sect2>

4301

4690

4302

4303

<title>Simple Patterns</title>

4691

4692

<title>Simple Searches</title>

4304

4693

4305

4694

<para>

4306

Mutt supports two versions of so called <quote>simple searches</quote> which are

4695

Mutt supports two versions of so called <quote>simple searches</quote>. These are

4307

4696

issued if the query entered for searching, limiting and similar

4308

operations does not seem to be a valid pattern (i.e. it does not contain

4697

operations does not seem to contain a valid pattern modifier (i.e. it does not contain

4309

4698

one of these characters: <quote>&tilde;</quote>, <quote>=</quote> or <quote>&percnt;</quote>). If the query is

4310

4699

supposed to contain one of these special characters, they must be escaped

4311

4700

by prepending a backslash (<quote>\</quote>).

4355

4744

</sect2>

4356

4745

4357

4746

4358

<title>Complex Patterns</title>

4747

<title>Nesting and Boolean Operators</title>

4359

4748

4360

4749

<para>

4361

4750

Logical AND is performed by specifying more than one criterion. For

4368

4757

4369

4758

<para>

4370

4759

would select messages which contain the word <quote>mutt</quote> in the list of

4371

recipients <emphasis role="bold">and</emphasis> that have the word <quote>elkins</quote> in the <quote>From</quote> header

4760

recipients <emphasis>and</emphasis> that have the word <quote>elkins</quote> in the <quote>From</quote> header

4372

4761

field.

4373

4762

</para>

4374

4763

4381

4770

4382

4771

4383

4772

<para>

4384

! -- logical NOT operator

4385

</para>

4386

</listitem>

4387

4388

4389

<para>

4390

| -- logical OR operator

4391

</para>

4392

</listitem>

4393

4394

4395

<para>

4396

() -- logical grouping operator

4773

! — logical NOT operator

4774

</para>

4775

</listitem>

4776

4777

4778

<para>

4779

| — logical OR operator

4780

</para>

4781

</listitem>

4782

4783

4784

<para>

4785

() — logical grouping operator

4397

4786

</para>

4398

4787

</listitem>

4399

4788

4426

4815

<note>

4427

4816

<para>

4428

4817

If a regular expression contains parenthesis, or a vertical bar

4429

("|"), you <emphasis role="bold">must</emphasis> enclose the expression in double or single quotes since

4818

("|"), you <emphasis>must</emphasis> enclose the expression in double or single quotes since

4430

4819

those characters are also used to separate different parts of Mutt's

4431

4820

pattern language. For example: <literal>~f "me@(mutt\.org|cs\.hmc\.edu)"</literal>

4432

</para>

4433

</note>

4434

4435

<para>

4436

4821

Without the quotes, the parenthesis wouldn't end.

4437

4822

This would be separated to two OR'd patterns: <emphasis>&tilde;f me@(mutt\.org</emphasis>

4438

4823

and <emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want.

4439

4824

</para>

4825

</note>

4440

4826

4441

4827

</sect2>

4442

4828

4447

4833

Mutt supports two types of dates, <emphasis>absolute</emphasis> and <emphasis>relative</emphasis>.

4448

4834

</para>

4449

4835

4836

4837

<title>Absolute Dates</title>

4838

4450

4839

<para>

4451

<emphasis role="bold">Absolute</emphasis>. Dates <emphasis role="bold">must</emphasis> be in DD/MM/YY format (month and year are

4840

Dates <emphasis>must</emphasis> be in DD/MM/YY format (month and year are

4452

4841

optional, defaulting to the current month and year). An example of a valid

4453

4842

range of dates is:

4454

4843

</para>

4466

4855

</para>

4467

4856

4468

4857

<para>

4469

<emphasis role="bold">Error Margins</emphasis>. You can add error margins to absolute dates.

4858

You can add error margins to absolute dates.

4470

4859

An error margin is a sign (+ or -), followed by a digit, followed by

4471

4860

one of the units in <xref linkend="tab-date-units"/>. As a special case, you can replace the

4472

4861

sign by a <quote>*</quote> character, which is equivalent to giving identical plus and minus error margins.

4496

4885

Limit to messages matching: ~d 15/1/2001*2w

4497

4886

</screen>

4498

4887

4888

</sect3>

4889

4890

4891

<title>Relative Dates</title>

4892

4499

4893

<para>

4500

<emphasis role="bold">Relative</emphasis>. This type of date is relative to the current date, and may

4894

This type of date is relative to the current date, and may

4501

4895

be specified as:

4502

4896

</para>

4503

4897

4505

4899

4506

4900

4507

4901

<para>

4508

><emphasis>offset</emphasis> (messages older than <emphasis>offset</emphasis> units)

4509

</para>

4510

</listitem>

4511

4512

4513

<para>

4514

<<emphasis>offset</emphasis> (messages newer than <emphasis>offset</emphasis> units)

4515

</para>

4516

</listitem>

4517

4518

4519

<para>

4520

=<emphasis>offset</emphasis> (messages exactly <emphasis>offset</emphasis> units old)

4902

><emphasis>offset</emphasis> for messages older than <emphasis>offset</emphasis> units

4903

</para>

4904

</listitem>

4905

4906

4907

<para>

4908

<<emphasis>offset</emphasis> for messages newer than <emphasis>offset</emphasis> units

4909

</para>

4910

</listitem>

4911

4912

4913

<para>

4914

=<emphasis>offset</emphasis> for messages exactly <emphasis>offset</emphasis> units old

4521

4915

</para>

4522

4916

</listitem>

4523

4917

4538

4932

<note>

4539

4933

<para>

4540

4934

All dates used when searching are relative to the

4541

<emphasis role="bold">local</emphasis> time zone, so unless you change the setting of your <link linkend="index-format">&dollar;index&lowbar;format</link> to include a

4542

<literal>&percnt;[...]</literal> format, these are <emphasis role="bold">not</emphasis> the dates shown

4935

<emphasis>local</emphasis> time zone, so unless you change the setting of your <link linkend="index-format">&dollar;index&lowbar;format</link> to include a

4936

<literal>&percnt;[...]</literal> format, these are <emphasis>not</emphasis> the dates shown

4543

4937

in the main index.

4544

4938

</para>

4545

4939

</note>

4546

4940

4941

</sect3>

4942

4547

4943

</sect2>

4548

4944

4549

4945

</sect1>

4566

4962

<para>

4567

4963

Once you have tagged the desired messages, you can use the

4568

4964

<quote>tag-prefix</quote> operator, which is the <quote>;</quote> (semicolon) key by default.

4569

When the <quote>tag-prefix</quote> operator is used, the <emphasis role="bold">next</emphasis> operation will

4965

When the <quote>tag-prefix</quote> operator is used, the <emphasis>next</emphasis> operation will

4570

4966

be applied to all tagged messages if that operation can be used in that

4571

4967

manner. If the <link linkend="auto-tag">&dollar;auto&lowbar;tag</link>

4572

4968

variable is set, the next operation applies to the tagged messages

4574

4970

</para>

4575

4971

4576

4972

<para>

4577

In <link linkend="macro">macros</link> or <link linkend="push">push</link> commands,

4578

you can use the <quote>tag-prefix-cond</quote> operator. If there are no tagged

4579

messages, mutt will "eat" the rest of the macro to abort it's execution.

4580

Mutt will stop "eating" the macro when it encounters the <quote>end-cond</quote>

4581

operator; after this operator the rest of the macro will be executed as

4973

In <link linkend="macro"><command>macro</command>s</link> or <link linkend="push"><command>push</command></link> commands,

4974

you can use the <literal><tag-prefix-cond></literal> operator. If there are no tagged

4975

messages, Mutt will <quote>eat</quote> the rest of the macro to abort it's execution.

4976

Mutt will stop <quote>eating</quote> the macro when it encounters the <literal><end-cond></literal>

4977

operator; after this operator the rest of the macro will be executed as

4582

4978

normal.

4583

4979

</para>

4584

4980

4594

4990

reading, or to whom you are sending mail. In the Mutt world, a <emphasis>hook</emphasis>

4595

4991

consists of a <link linkend="regexp">regular expression</link> or

4596

4992

4597

configuration option/command. See

4993

configuration option/command. See:

4598

4994

4599

4995

4600

4601

4602

<para>

4603

4604

</para>

4605

</listitem>

4606

4607

4608

<para>

4609

4610

</para>

4611

</listitem>

4612

4613

4614

<para>

4615

4616

</para>

4617

</listitem>

4618

4619

4620

<para>

4621

4622

</para>

4623

</listitem>

4624

4625

4626

<para>

4627

4628

</para>

4629

</listitem>

4630

4631

4632

<para>

4633

4634

</para>

4635

</listitem>

4636

4637

4638

<para>

4639

4996

4997

4998

<para>

4999

5000

</para>

5001

</listitem>

5002

5003

5004

<para>

5005

5006

</para>

5007

</listitem>

5008

5009

5010

<para>

5011

5012

</para>

5013

</listitem>

5014

5015

5016

<para>

5017

5018

</para>

5019

</listitem>

5020

5021

5022

<para>

5023

5024

</para>

5025

</listitem>

5026

5027

5028

<para>

5029

5030

</para>

5031

</listitem>

5032

5033

5034

<para>

5035

5036

</para>

5037

</listitem>

5038

5039

5040

<para>

5041

5042

</para>

5043

</listitem>

5044

5045

5046

<para>

5047

5048

</para>

5049

</listitem>

5050

5051

5052

<para>

5053

5054

</para>

5055

</listitem>

5056

5057

5058

<para>

5059

5060

</para>

5061

</listitem>

5062

5063

5064

<para>

5065

5066

</para>

5067

</listitem>

5068

5069

5070

<para>

5071

4640

5072

</para>

4641

5073

</listitem>

4642

5074

4648

5080

<note>

4649

5081

<para>

4650

5082

If a hook changes configuration settings, these changes remain

4651

effective until the end of the current mutt session. As this is generally

4652

not desired, a default hook needs to be added before all other hooks to

4653

restore configuration defaults. Here is an example with send-hook and the

4654

my&lowbar;hdr directive:

5083

effective until the end of the current Mutt session. As this is generally

5084

not desired, a <quote>default</quote> hook needs to be added before all

5085

other hooks of that type to restore configuration defaults.

4655

5086

</para>

4656

5087

</note>

4657

5088

4658

4659

<title>Combining <literal>send-hook</literal> and <literal>my&lowbar;hdr</literal></title>

5089

5090

<title>Specifying a <quote>default</quote> hook</title>

4660

5091

4661

5092

send-hook . 'unmy_hdr From:'

4662

5093

send-hook ~C'^b@b\.b$' my_hdr from: c@c.c

4663

5094

</screen>

4664

5095

</example>

4665

5096

5097

<para>

5098

In <xref linkend="ex-default-hook"/>, by default the value of

5099

5100

and <link linkend="realname">&dollar;realname</link>

5101

is not overridden. When sending messages either To: or Cc:

5102

to <literal><b@b.b></literal>, the From: header is changed to

5103

<literal><c@c.c></literal>.

5104

</para>

5105

4666

5106

4667

5107

<title>Message Matching in Hooks</title>

4668

5108

4669

5109

<para>

4670

Hooks that act upon messages (<literal>message-hook, reply-hook,

4671

send-hook, send2-hook, save-hook, fcc-hook</literal>) are evaluated in a

5110

Hooks that act upon messages (<command>message-hook</command>, <command>reply-hook</command>,

5111

<command>send-hook</command>, <command>send2-hook</command>, <command>save-hook</command>, <command>fcc-hook</command>) are evaluated in a

4672

5112

slightly different manner. For the other

4673

5113

types of hooks, a <link linkend="regexp">regular expression</link> is

4674

5114

sufficient. But in dealing with messages a finer grain of control is

4681

5121

language for matching messages in hook commands. This works in

4682

5122

exactly the same way as it would when <emphasis>limiting</emphasis> or

4683

5123

<emphasis>searching</emphasis> the mailbox, except that you are restricted to those

4684

operators which match information mutt extracts from the header of

5124

operators which match information Mutt extracts from the header of

4685

5125

the message (i.e., from, to, cc, date, subject, etc.).

4686

5126

</para>

4687

5127

4719

5159

4720

5160

<para>

4721

5161

Mutt supports connecting to external directory databases such as LDAP,

4722

ph/qi, bbdb, or NIS through a wrapper script which connects to mutt

5162

ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt

4723

5163

using a simple interface. Using the <link linkend="query-command">&dollar;query&lowbar;command</link> variable, you specify the wrapper

4724

5164

command to use. For example:

4725

5165

</para>

4748

5188

</screen>

4749

5189

4750

5190

<para>

4751

There are two mechanisms for accessing the query function of mutt. One

5191

There are two mechanisms for accessing the query function of Mutt. One

4752

5192

is to do a query from the index menu using the <literal><query></literal> function (default: Q).

4753

5193

This will prompt for a query, then bring up the query menu which will

4754

5194

list the matching responses. From the query menu, you can select

4761

5201

The other mechanism for accessing the query function is for address

4762

5202

completion, similar to the alias completion. In any prompt for address

4763

5203

entry, you can use the <literal><complete-query></literal> function (default: &circ;T) to run a

4764

query based on the current address you have typed. Like aliases, mutt

5204

query based on the current address you have typed. Like aliases, Mutt

4765

5205

will look for what you have typed back to the last space or comma. If

4766

there is a single response for that query, mutt will expand the address

4767

in place. If there are multiple responses, mutt will activate the query

5206

there is a single response for that query, Mutt will expand the address

5207

in place. If there are multiple responses, Mutt will activate the query

4768

5208

menu. At the query menu, you can select one or more addresses to be

4769

5209

added to the prompt.

4770

5210

</para>

4775

5215

<title>Mailbox Formats</title>

4776

5216

4777

5217

<para>

4778

Mutt supports reading and writing of four different mailbox formats:

5218

Mutt supports reading and writing of four different local mailbox formats:

4779

5219

mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there

4780

5220

is no need to use a flag for different mailbox types. When creating new

4781

mailboxes, Mutt uses the default specified with the <link linkend="mbox-type">&dollar;mbox&lowbar;type</link> variable.

5221

mailboxes, Mutt uses the default specified with the

5222

5223

short description of the formats follows.

4782

5224

</para>

4783

5225

4784

5226

<para>

4785

<emphasis role="bold">mbox</emphasis>. This is the most widely used mailbox format for UNIX. All

5227

<emphasis>mbox</emphasis>. This is a widely used mailbox format for UNIX. All

4786

5228

messages are stored in a single file. Each message has a line of the form:

4787

5229

</para>

4788

5230

4792

5234

4793

5235

<para>

4794

5236

to denote the start of a new message (this is often referred to as the

4795

<quote>From&lowbar;</quote> line).

4796

</para>

4797

4798

<para>

4799

<emphasis role="bold">MMDF</emphasis>. This is a variant of the <emphasis>mbox</emphasis> format. Each message is

4800

surrounded by lines containing <quote>&circ;A&circ;A&circ;A&circ;A</quote> (four control-A's).

4801

</para>

4802

4803

<para>

4804

<emphasis role="bold">MH</emphasis>. A radical departure from <emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox

5237

<quote>From&lowbar;</quote> line). The mbox format requires mailbox

5238

locking, is prone to mailbox corruption with concurrently writing

5239

clients or misinterpreted From&lowbar; lines. Depending on the

5240

environment, new mail detection can be unreliable. Mbox folders are fast

5241

to open and easy to archive.

5242

</para>

5243

5244

<para>

5245

<emphasis>MMDF</emphasis>. This is a variant of

5246

the <emphasis>mbox</emphasis> format. Each message is surrounded by

5247

lines containing <quote>&circ;A&circ;A&circ;A&circ;A</quote> (four

5248

control-A's). The same problems as for mbox apply (also with finding the

5249

right message separator as four control-A's may appear in message

5250

bodies).

5251

</para>

5252

5253

<para>

5254

<emphasis>MH</emphasis>. A radical departure from <emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox

4805

5255

consists of a directory and each message is stored in a separate file.

4806

5256

The filename indicates the message number (however, this is may not

4807

5257

correspond to the message number Mutt displays). Deleted messages are

4808

renamed with a comma (,) prepended to the filename. Mutt

5258

renamed with a comma (<quote>,</quote>) prepended to the filename. Mutt

4809

5259

detects this type of mailbox by looking for either <literal>.mh&lowbar;sequences</literal>

4810

or <literal>.xmhcache</literal> (needed to distinguish normal directories from MH

4811

mailboxes).

5260

or <literal>.xmhcache</literal> files (needed to distinguish normal directories from MH

5261

mailboxes). MH is more robust with concurrent clients writing the mailbox,

5262

but still may suffer from lost flags; message corruption is less likely

5263

to occur than with mbox/mmdf. It's usually slower to open compared to

5264

mbox/mmdf since many small files have to be read (Mutt provides

5265

<xref linkend="header-caching"/> to greatly speed this process up).

5266

Depending on the environment, MH is not very disk-space efficient.

4812

5267

</para>

4813

5268

4814

5269

<para>

4815

<emphasis role="bold">Maildir</emphasis>. The newest of the mailbox formats, used by the Qmail MTA (a

5270

<emphasis>Maildir</emphasis>. The newest of the mailbox formats, used by the Qmail MTA (a

4816

5271

replacement for sendmail). Similar to <emphasis>MH</emphasis>, except that it adds three

4817

5272

subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>cur</emphasis>. Filenames

4818

5273

for the messages are chosen in such a way they are unique, even when two

4819

5274

programs are writing the mailbox over NFS, which means that no file locking

4820

is needed.

5275

is needed and corruption is very unlikely. Maildir maybe

5276

slower to open without caching in Mutt, it too is not very

5277

disk-space efficient depending on the environment. Since no additional

5278

files are used for metadata (which is embedded in the message filenames)

5279

and Maildir is locking-free, it's easy to sync across different machines

5280

using file-level synchronization tools.

4821

5281

</para>

4822

5282

4823

5283

</sect1>

4828

5288

<para>

4829

5289

There are a number of built in shortcuts which refer to specific mailboxes.

4830

5290

These shortcuts can be used anywhere you are prompted for a file or mailbox

4831

path.

5291

path or in path-related configuration variables. Note that these only

5292

work at the beginning of a string.

4832

5293

</para>

4833

5294

4834

5295

4835

5296

4836

5297

4837

5298

<para>

4838

! -- refers to your <link linkend="spoolfile">&dollar;spoolfile</link> (incoming) mailbox

4839

</para>

4840

</listitem>

4841

4842

4843

<para>

4844

> -- refers to your <link linkend="mbox">&dollar;mbox</link> file

4845

</para>

4846

</listitem>

4847

4848

4849

<para>

4850

< -- refers to your <link linkend="record">&dollar;record</link> file

4851

</para>

4852

</listitem>

4853

4854

4855

<para>

4856

&circ; -- refers to the current mailbox

4857

</para>

4858

</listitem>

4859

4860

4861

<para>

4862

- or !! -- refers to the file you've last visited

4863

</para>

4864

</listitem>

4865

4866

4867

<para>

4868

&tilde; -- refers to your home directory

4869

</para>

4870

</listitem>

4871

4872

4873

<para>

4874

= or + -- refers to your <link linkend="folder">&dollar;folder</link> directory

4875

</para>

4876

</listitem>

4877

4878

4879

<para>

4880

@<emphasis>alias</emphasis> -- refers to the <link linkend="save-hook">default save folder</link> as determined by the address of the alias

5299

! — refers to your <link linkend="spoolfile">&dollar;spoolfile</link> (incoming) mailbox

5300

</para>

5301

</listitem>

5302

5303

5304

<para>

5305

> — refers to your <link linkend="mbox">&dollar;mbox</link> file

5306

</para>

5307

</listitem>

5308

5309

5310

<para>

5311

< — refers to your <link linkend="record">&dollar;record</link> file

5312

</para>

5313

</listitem>

5314

5315

5316

<para>

5317

&circ; — refers to the current mailbox

5318

</para>

5319

</listitem>

5320

5321

5322

<para>

5323

- or !! — refers to the file you've last visited

5324

</para>

5325

</listitem>

5326

5327

5328

<para>

5329

&tilde; — refers to your home directory

5330

</para>

5331

</listitem>

5332

5333

5334

<para>

5335

= or + — refers to your <link linkend="folder">&dollar;folder</link> directory

5336

</para>

5337

</listitem>

5338

5339

5340

<para>

5341

@<emphasis>alias</emphasis> — refers to the <link linkend="save-hook">default save folder</link> as determined by the address of the alias

4881

5342

</para>

4882

5343

</listitem>

4883

5344

4884

5345

</itemizedlist>

4885

5346

5347

<para>

5348

For example, to store a copy of outgoing messages in the folder they

5349

were composed in,

5350

a <link linkend="folder-hook"><command>folder-hook</command></link> can

5351

be used to set <link linkend="record">&dollar;record</link>:

5352

</para>

5353

5354

5355

folder-hook . 'set record=&circ;'</screen>

5356

4886

5357

</sect1>

4887

5358

4888

5359

4894

5365

know what addresses you consider to be mailing lists (technically

4895

5366

this does not have to be a mailing list, but that is what it is most

4896

5367

often used for), and what lists you are subscribed to. This is

4897

accomplished through the use of the <link linkend="lists">lists and subscribe</link> commands in your muttrc.

5368

accomplished through the use of the <link linkend="lists"><command>lists</command> and <command>subscribe</command></link> commands in your <literal>.muttrc</literal>.

4898

5369

</para>

4899

5370

4900

5371

<para>

4902

5373

things, the first of which is the ability to show the name of a list

4903

5374

through which you received a message (i.e., of a subscribed list) in

4904

5375

the <emphasis>index</emphasis> menu display. This is useful to distinguish between

4905

personal and list mail in the same mailbox. In the <link linkend="index-format">&dollar;index&lowbar;format</link> variable, the escape <quote>&percnt;L</quote>

4906

will return the string <quote>To <list></quote> when <quote>list</quote> appears in the

5376

personal and list mail in the same mailbox. In the <link linkend="index-format">&dollar;index&lowbar;format</link> variable, the expando <quote>&percnt;L</quote>

5377

will print the string <quote>To <list></quote> when <quote>list</quote> appears in the

4907

5378

<quote>To</quote> field, and <quote>Cc <list></quote> when it appears in the <quote>Cc</quote>

4908

field (otherwise it returns the name of the author).

5379

field (otherwise it prints the name of the author).

4909

5380

</para>

4910

5381

4911

5382

<para>

4922

5393

<para>

4923

5394

Mutt also supports the <literal>Mail-Followup-To</literal> header. When you send

4924

5395

a message to a list of recipients which includes one or several

4925

subscribed mailing lists, and if the <link linkend="followup-to">&dollar;followup&lowbar;to</link> option is set, mutt will generate

5396

subscribed mailing lists, and if the <link linkend="followup-to">&dollar;followup&lowbar;to</link> option is set, Mutt will generate

4926

5397

a Mail-Followup-To header which contains all the recipients to whom

4927

5398

you send this message, but not your address. This indicates that

4928

5399

group-replies or list-replies (also known as <quote>followups</quote>) to this

4933

5404

4934

5405

<para>

4935

5406

Conversely, when group-replying or list-replying to a message which

4936

has a <literal>Mail-Followup-To</literal> header, mutt will respect this header if

5407

has a <literal>Mail-Followup-To</literal> header, Mutt will respect this header if

4937

5408

the <link linkend="honor-followup-to">&dollar;honor&lowbar;followup&lowbar;to</link> configuration

4938

variable is set. Using list-reply will in this case also make sure

5409

variable is set. Using <link linkend="list-reply">list-reply</link> will in this case also make sure

4939

5410

that the reply goes to the mailing list, even if it's not specified

4940

5411

in the list of recipients in the <literal>Mail-Followup-To</literal>.

4941

5412

</para>

4967

5438

The <quote>X-Label:</quote> header field can be used to further identify mailing

4968

5439

lists or list subject matter (or just to annotate messages

4969

5440

individually). The <link linkend="index-format">&dollar;index&lowbar;format</link> variable's <quote>&percnt;y</quote> and

4970

<quote>&percnt;Y</quote> escapes can be used to expand <quote>X-Label:</quote> fields in the

5441

<quote>&percnt;Y</quote> expandos can be used to expand <quote>X-Label:</quote> fields in the

4971

5442

index, and Mutt's pattern-matcher can match regular expressions to

4972

5443

<quote>X-Label:</quote> fields with the <quote>&tilde;y</quote> selector. <quote>X-Label:</quote> is not a

4973

5444

standard message header field, but it can easily be inserted by procmail

4998

5469

When in the index menu and being idle (also see

4999

5470

5000

5471

for new mail in all folders which have been configured via the

5001

<literal>mailboxes</literal> command. The interval depends on the folder

5472

<command>mailboxes</command> command. The interval depends on the folder

5002

5473

type: for local/IMAP folders it consults

5003

5474

5004

5475

5009

5480

Outside the index menu the directory browser supports checking

5010

5481

for new mail using the <literal><check-new></literal> function which is

5011

5482

unbound by default. Pressing TAB will bring up a

5012

menu showing the files specified by the <literal>mailboxes</literal> command,

5483

menu showing the files specified by the <command>mailboxes</command> command,

5013

5484

and indicate which contain new messages. Mutt will automatically enter this

5014

5485

mode when invoked from the command line with the <literal>-y</literal> option.

5015

5486

</para>

5024

5495

<para>

5025

5496

For the index, by default Mutt displays the number of mailboxes with new

5026

5497

mail in the status bar, please refer to the

5027

5498

5028

5499

variable for details.

5029

5500

</para>

5030

5501

5037

5508

</sect1>

5038

5509

5039

5510

5040

<title>Editing threads</title>

5511

<title>Editing Threads</title>

5041

5512

5042

5513

<para>

5043

5514

Mutt has the ability to dynamically restructure threads that are broken

5044

5515

either by misconfigured software or bad behavior from some

5045

correspondents. This allows to clean your mailboxes formats) from these

5516

correspondents. This allows to clean your mailboxes from these

5046

5517

annoyances which make it hard to follow a discussion.

5047

5518

</para>

5048

5519

5049

5520

5050

<title>Linking threads</title>

5521

<title>Linking Threads</title>

5051

5522

5052

5523

<para>

5053

Some mailers tend to "forget" to correctly set the "In-Reply-To:" and

5054

"References:" headers when replying to a message. This results in broken

5524

Some mailers tend to <quote>forget</quote> to correctly set the <quote>In-Reply-To:</quote> and

5525

<quote>References:</quote> headers when replying to a message. This results in broken

5055

5526

discussions because Mutt has not enough information to guess the correct

5056

5527

threading.

5057

5528

You can fix this by tagging the reply, then moving to the parent message

5058

5529

and using the <literal><link-threads></literal> function (bound to & by default). The

5059

reply will then be connected to this "parent" message.

5530

reply will then be connected to this parent message.

5060

5531

</para>

5061

5532

5062

5533

<para>

5063

5534

You can also connect multiple children at once, tagging them and using the

5064

tag-prefix command (';') or the auto&lowbar;tag option.

5535

<literal><tag-prefix></literal> command (';') or the <link linkend="auto-tag">&dollar;auto&lowbar;tag</link> option.

5065

5536

</para>

5066

5537

5067

5538

</sect2>

5068

5539

5069

5540

5070

<title>Breaking threads</title>

5541

<title>Breaking Threads</title>

5071

5542

5072

5543

<para>

5073

5544

On mailing lists, some people are in the bad habit of starting a new

5074

discussion by hitting "reply" to any message from the list and changing

5545

discussion by hitting <quote>reply</quote> to any message from the list and changing

5075

5546

the subject to a totally unrelated one.

5076

5547

You can fix such threads by using the <literal><break-thread></literal> function (bound

5077

5548

by default to &num;), which will turn the subthread starting from the

5111

5582

<para>

5112

5583

For SMTP delivery using <link

5113

5584

linkend="smtp-url">&dollar;smtp&lowbar;url</link>, it depends on the

5114

capabilities announced by the server whether mutt will attempt to

5585

capabilities announced by the server whether Mutt will attempt to

5115

5586

request DSN or not.

5116

5587

</para>

5117

5588

5136

5607

5137

5608

</sect1>

5138

5609

5610

5611

<title>Miscellany</title>

5612

5613

<para>

5614

This section documents various features that fit nowhere else.

5615

</para>

5616

5617

5618

5619

<term>

5620

Address normalization

5621

</term>

5622

5623

<para>

5624

Mutt normalizes all e-mail addresses to the simplest form possible. If

5625

an address contains a realname, the form

5626

<emphasis>Joe User <joe@example.com></emphasis> is used and the

5627

pure e-mail address without angle brackets otherwise, i.e. just

5628

<emphasis>joe@example.com</emphasis>.

5629

</para>

5630

<para>

5631

This normalization affects all headers Mutt generates including aliases.

5632

</para>

5633

</listitem>

5634

</varlistentry>

5635

5636

<term>

5637

Initial folder selection

5638

</term>

5639

5640

<para>

5641

The folder Mutt opens at startup is determined as follows: the folder

5642

specified in the <literal>&dollar;MAIL</literal> environment variable if

5643

present. Otherwise, the value of <literal>&dollar;MAILDIR</literal> is taken

5644

into account. If that isn't present either, Mutt takes the user's

5645

mailbox in the mailspool as determined at compile-time (which may also

5646

reside in the home directory). The

5647

5648

this selection. Highest priority has the mailbox given with the

5649

<literal>-f</literal> command line option.

5650

</para>

5651

</listitem>

5652

</varlistentry>

5653

</variablelist>

5654

5655

</sect1>

5656

5139

5657

</chapter>

5140

5658

5141

5659

5162

5680

</para>

5163

5681

5164

5682

5165

<title>Viewing MIME messages in the pager</title>

5683

<title>Viewing MIME Messages in the Pager</title>

5166

5684

5167

5685

<para>

5168

5686

When you select a message from the index and view it in the pager, Mutt

5203

5721

<title>The Attachment Menu</title>

5204

5722

5205

5723

<para>

5206

The default binding for <literal>view-attachments</literal> is `v', which displays the

5724

The default binding for <literal><view-attachments></literal> is <quote>v</quote>, which displays the

5207

5725

attachment menu for a message. The attachment menu displays a list of

5208

5726

the attachments in a message. From the attachment menu, you can save,

5209

5727

print, pipe, delete, and view attachments. You can apply these

5210

5728

operations to a group of attachments at once, by tagging the attachments

5211

and by using the <quote>tag-prefix</quote> operator. You can also reply to the

5729

and by using the <literal><tag-prefix></literal> operator. You can also reply to the

5212

5730

current message from this menu, and only the current attachment (or the

5213

5731

attachments tagged) will be quoted in your reply. You can view

5214

5732

attachments as text, or view them using the mailcap viewer definition.

5252

5770

<para>

5253

5771

The '-' denotes that Mutt will delete the file after sending (or

5254

5772

postponing, or canceling) the message. It can be toggled with the

5255

<literal>toggle-unlink</literal> command (default: u). The next field is the MIME

5256

content-type, and can be changed with the <literal>edit-type</literal> command

5773

<literal><toggle-unlink></literal> command (default: u). The next field is the MIME

5774

content-type, and can be changed with the <literal><edit-type></literal> command

5257

5775

(default: &circ;T). The next field is the encoding for the attachment,

5258

5776

which allows a binary message to be encoded for transmission on 7bit

5259

links. It can be changed with the <literal>edit-encoding</literal> command

5777

links. It can be changed with the <literal><edit-encoding></literal> command

5260

5778

(default: &circ;E). The next field is the size of the attachment,

5261

5779

rounded to kilobytes or megabytes. The next field is the filename,

5262

which can be changed with the <literal>rename-file</literal> command (default: R).

5780

which can be changed with the <literal><rename-file></literal> command (default: R).

5263

5781

The final field is the description of the attachment, and can be

5264

changed with the <literal>edit-description</literal> command (default: d).

5782

changed with the <literal><edit-description></literal> command (default: d).

5265

5783

</para>

5266

5784

5267

5785

</sect2>

5269

5787

</sect1>

5270

5788

5271

5789

5272

<title>MIME Type configuration with <literal>mime.types</literal></title>

5790

<title>MIME Type Configuration with <literal>mime.types</literal></title>

5273

5791

5274

5792

<para>

5275

5793

When you add an attachment to your mail message, Mutt searches your

5276

personal mime.types file at <literal>&dollar;{HOME}/.mime.types</literal>, and then

5277

the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or

5794

personal <literal>mime.types</literal> file at <literal>&dollar;{HOME}/.mime.types</literal>, and then

5795

the system <literal>mime.types</literal> file at <literal>/usr/local/share/mutt/mime.types</literal> or

5278

5796

<literal>/etc/mime.types</literal>

5279

5797

</para>

5280

5798

5281

5799

<para>

5282

The mime.types file consist of lines containing a MIME type and a space

5800

The <literal>mime.types</literal> file consist of lines containing a MIME type and a space

5283

5801

separated list of extensions. For example:

5284

5802

</para>

5285

5803

5300

5818

information, Mutt will assume that the file is plain text, and mark it

5301

5819

as <literal>text/plain</literal>. If the file contains binary information, then Mutt will

5302

5820

mark it as <literal>application/octet-stream</literal>. You can change the MIME

5303

type that Mutt assigns to an attachment by using the <literal>edit-type</literal>

5821

type that Mutt assigns to an attachment by using the <literal><edit-type></literal>

5304

5822

command from the compose menu (default: &circ;T). The MIME type is actually a

5305

5823

major mime type followed by the sub-type, separated by a '/'. 6 major

5306

5824

types: application, text, image, video, audio, and model have been approved

5307

5825

after various internet discussions. Mutt recognizes all of these if the

5308

appropriate entry is found in the mime.types file. It also recognizes other

5826

appropriate entry is found in the <literal>mime.types</literal> file. It also recognizes other

5309

5827

major mime types, such as the chemical type that is widely used in the

5310

5828

molecular modeling community to pass molecular data in various forms to

5311

5829

various molecular viewers. Non-recognized mime types should only be used

5315

5833

</sect1>

5316

5834

5317

5835

5318

<title>MIME Viewer configuration with <literal>mailcap</literal></title>

5836

<title>MIME Viewer Configuration with Mailcap</title>

5319

5837

5320

5838

<para>

5321

5839

Mutt supports RFC 1524 MIME Configuration, in particular the Unix

5323

5841

is commonly referred to as the mailcap format. Many MIME compliant

5324

5842

programs utilize the mailcap format, allowing you to specify handling

5325

5843

for all MIME types in one place for all programs. Programs known to

5326

use this format include Netscape, XMosaic, lynx and metamail.

5844

use this format include Firefox, lynx and metamail.

5327

5845

</para>

5328

5846

5329

5847

<para>

5345

5863

<para>

5346

5864

where <literal>&dollar;HOME</literal> is your home directory. The

5347

5865

<literal>&dollar;PKGDATADIR</literal> and the

5348

<literal>&dollar;SYSCONFDIR</literal> directories depend on where mutt

5866

<literal>&dollar;SYSCONFDIR</literal> directories depend on where Mutt

5349

5867

is installed: the former is the default for shared data, the

5350

5868

latter for system configuration files.

5351

5869

</para>

5366

5884

</para>

5367

5885

5368

5886

5369

<title>The Basics of the mailcap file</title>

5887

<title>The Basics of the Mailcap File</title>

5370

5888

5371

5889

<para>

5372

5890

A mailcap file consists of a series of lines which are comments, blank,

5477

5995

</sect2>

5478

5996

5479

5997

5480

<title>Secure use of mailcap</title>

5998

<title>Secure Use of Mailcap</title>

5481

5999

5482

6000

<para>

5483

6001

The interpretation of shell meta-characters embedded in MIME parameters

5487

6005

</para>

5488

6006

5489

6007

<para>

5490

Although mutt's procedures to invoke programs with mailcap seem to be

6008

Although Mutt's procedures to invoke programs with mailcap seem to be

5491

6009

safe, there are other applications parsing mailcap, maybe taking less care

5492

6010

of it. Therefore you should pay attention to the following rules:

5493

6011

</para>

5518

6036

</sect2>

5519

6037

5520

6038

5521

<title>Advanced mailcap Usage</title>

6039

<title>Advanced Mailcap Usage</title>

5522

6040

5523

6041

5524

6042

<title>Optional Fields</title>

5557

6075

<term>needsterminal</term>

5558

6076

5559

6077

<para>

5560

Mutt uses this flag when viewing attachments with <link linkend="auto-view">auto&lowbar;view</link>, in order to decide whether it should honor the setting

6078

Mutt uses this flag when viewing attachments with <link linkend="auto-view"><command>auto&lowbar;view</command></link>, in order to decide whether it should honor the setting

5561

6079

of the <link linkend="wait-key">&dollar;wait&lowbar;key</link> variable or

5562

6080

not. When an attachment is viewed using an interactive program, and the

5563

6081

corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt will use

5583

6101

<para>

5584

6102

This flag specifies the command to use to create a new attachment of a

5585

6103

specific MIME type. This command differs from the compose command in

5586

that mutt will expect standard MIME headers on the data. This can be

6104

that Mutt will expect standard MIME headers on the data. This can be

5587

6105

used to specify parameters, filename, description, etc. for a new

5588

6106

attachment. Mutt supports this from the compose menu.

5589

6107

</para>

5641

6159

</para>

5642

6160

5643

6161

5644

text/html; netscape -remote 'openURL(%s)' ; test=RunningX

6162

text/html; firefox -remote 'openURL(%s)' ; test=RunningX

5645

6163

text/html; lynx %s

5646

6164

</screen>

5647

6165

5648

6166

<para>

5649

6167

In this example, Mutt will run the program RunningX which will return 0

5650

6168

if the X Window manager is running, and non-zero if it isn't. If

5651

RunningX returns 0, then Mutt will call netscape to display the

5652

text/html object. If RunningX doesn't return 0, then Mutt will go on

5653

to the next entry and use lynx to display the text/html object.

6169

RunningX returns 0, then Mutt will call firefox to display the

6170

<literal>text/html</literal> object. If RunningX doesn't return 0, then Mutt will go on

6171

to the next entry and use lynx to display the <literal>text/html</literal> object.

5654

6172

</para>

5655

6173

</listitem>

5656

6174

</varlistentry>

5681

6199

</para>

5682

6200

5683

6201

<para>

5684

In addition, you can use this with <link linkend="auto-view">auto&lowbar;view</link>

6202

In addition, you can use this with <link linkend="auto-view"><command>auto&lowbar;view</command></link>

5685

6203

to denote two commands for viewing an attachment, one to be viewed

5686

6204

automatically, the other to be viewed interactively from the attachment

5687

6205

menu. In addition, you can then use the test feature to determine which

5689

6207

</para>

5690

6208

5691

6209

5692

text/html; netscape -remote 'openURL(%s)' ; test=RunningX

6210

text/html; firefox -remote 'openURL(%s)' ; test=RunningX

5693

6211

text/html; lynx %s; nametemplate=%s.html

5694

6212

text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput

5695

6213

</screen>

5696

6214

5697

6215

<para>

5698

For <link linkend="auto-view">auto&lowbar;view</link>, Mutt will choose the third

6216

For <link linkend="auto-view"><command>auto&lowbar;view</command></link>, Mutt will choose the third

5699

6217

entry because of the copiousoutput tag. For interactive viewing, Mutt

5700

6218

will run the program RunningX to determine if it should use the first

5701

6219

entry. If the program returns non-zero, Mutt will use the second entry

5709

6227

5710

6228

<para>

5711

6229

The various commands defined in the mailcap files are passed to the

5712

<literal>/bin/sh</literal> shell using the system() function. Before the

6230

<literal>/bin/sh</literal> shell using the <literal>system(3)</literal> function. Before the

5713

6231

command is passed to <literal>/bin/sh -c</literal>, it is parsed to expand

5714

6232

various special parameters with information from Mutt. The keywords

5715

6233

Mutt expands are:

5782

6300

</sect2>

5783

6301

5784

6302

5785

<title>Example mailcap files</title>

6303

<title>Example Mailcap Files</title>

5786

6304

5787

6305

<para>

5788

6306

This mailcap file is fairly simple and standard:

5793

6311

video/*; xanim %s > /dev/null

5794

6312

image/*; xv %s > /dev/null

5795

6313

5796

# I'm always running netscape (if my computer had more memory, maybe)

5797

text/html; netscape -remote 'openURL(%s)'

6314

# I'm always running firefox (if my computer had more memory, maybe)

6315

text/html; firefox -remote 'openURL(%s)'

5798

6316

</screen>

5799

6317

5800

6318

<para>

5806

6324

# send that to /dev/null so I don't see it

5807

6325

video/*; xanim %s > /dev/null

5808

6326

5809

# Send html to a running netscape by remote

5810

text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape

6327

# Send html to a running firefox by remote

6328

text/html; firefox -remote 'openURL(%s)'; test=RunningFirefox

5811

6329

5812

# If I'm not running netscape but I am running X, start netscape on the

6330

# If I'm not running firefox but I am running X, start firefox on the

5813

6331

# object

5814

text/html; netscape %s; test=RunningX

6332

text/html; firefox %s; test=RunningX

5815

6333

5816

6334

# Else use lynx to view it as text

5817

6335

text/html; lynx %s

5822

6340

# I use enscript to print text in two columns to a page

5823

6341

text/*; more %s; print=enscript -2Gr %s

5824

6342

5825

# Netscape adds a flag to tell itself to view jpegs internally

6343

# Firefox adds a flag to tell itself to view jpegs internally

5826

6344

image/jpeg;xv %s; x-mozilla-flags=internal

5827

6345

5828

6346

# Use xv to view images if I'm running X

5847

6365

<title>MIME Autoview</title>

5848

6366

5849

6367

<para>

6368

Usage:

6369

</para>

6370

6371

6372

6373

6374

<replaceable>mimetype</replaceable>

6375

</arg>

6376

6377

<replaceable>mimetype</replaceable>

6378

</arg>

6379

6380

<command>unauto-view</command>

6381

6382

6383

6384

</arg>

6385

6386

<replaceable>mimetype</replaceable>

6387

</arg>

6388

</group>

6389

</cmdsynopsis>

6390

6391

<para>

5850

6392

In addition to explicitly telling Mutt to view an attachment with the

5851

6393

MIME viewer defined in the mailcap file, Mutt has support for

5852

6394

automatically viewing MIME attachments while in the pager.

5860

6402

</para>

5861

6403

5862

6404

<para>

5863

You then use the <literal>auto&lowbar;view</literal> muttrc command to list the

5864

content-types that you wish to view automatically.

5865

</para>

5866

5867

<para>

5868

For instance, if you set auto&lowbar;view to:

6405

You then use the <command>auto&lowbar;view</command> <literal>.muttrc</literal> command to list the

6406

content-types that you wish to view automatically. For instance, if you

6407

set it to:

5869

6408

</para>

5870

6409

5871

6410

5888

6427

</screen>

5889

6428

5890

6429

<para>

5891

<quote>unauto&lowbar;view</quote> can be used to remove previous entries from the autoview list.

5892

This can be used with message-hook to autoview messages based on size, etc.

5893

<quote>unauto&lowbar;view *</quote> will remove all previous entries.

6430

<command>unauto&lowbar;view</command> can be used to remove previous entries from the autoview list.

6431

This can be used with <link linkend="message-hook"><command>message-hook</command></link> to autoview messages based on size, etc.

6432

<quote><command>unauto&lowbar;view</command> *</quote> will remove all previous entries.

5894

6433

</para>

5895

6434

5896

6435

</sect1>

5900

6439

5901

6440

<para>

5902

6441

Mutt has some heuristics for determining which attachment of a

5903

multipart/alternative type to display. First, mutt will check the

5904

alternative&lowbar;order list to determine if one of the available types

5905

is preferred. The alternative&lowbar;order list consists of a number of

5906

mimetypes in order, including support for implicit and explicit

5907

wildcards, for example:

6442

<literal>multipart/alternative</literal> type to display. First, Mutt will check the

6443

<command>alternative&lowbar;order</command> list

6444

to determine if one of the available types is preferred. It consists of

6445

a number of mimetypes in order, including support for implicit and

6446

explicit wildcards, for example:

5908

6447

</para>

5909

6448

5910

6449

5912

6451

</screen>

5913

6452

5914

6453

<para>

5915

Next, mutt will check if any of the types have a defined

5916

5917

that, Mutt will look for any text type. As a last attempt, mutt will

6454

Next, Mutt will check if any of the types have a defined

6455

6456

that, Mutt will look for any text type. As a last attempt, Mutt will

5918

6457

look for any type it knows how to handle.

5919

6458

</para>

5920

6459

5921

6460

<para>

5922

To remove a MIME type from the <literal>alternative&lowbar;order</literal> list, use the

5923

<literal>unalternative&lowbar;order</literal> command.

6461

To remove a MIME type from the <command>alternative&lowbar;order</command> list, use the

6462

<command>unalternative&lowbar;order</command> command.

5924

6463

</para>

5925

6464

5926

6465

</sect1>

5934

6473

make your message index display the number of qualifying attachments in

5935

6474

each message, or search for messages by attachment count. You also can

5936

6475

configure what kinds of attachments qualify for this feature with the

5937

attachments and unattachments commands.

6476

<command>attachments</command> and <command>unattachments</command> commands.

5938

6477

</para>

5939

6478

5940

6479

<para>

5941

In order to provide this information, mutt needs to fully MIME-parse

6480

In order to provide this information, Mutt needs to fully MIME-parse

5942

6481

all messages affected first. This can slow down operation especially for

5943

6482

remote mail folders such as IMAP because all messages have to be

5944

6483

downloaded first regardless whether the user really wants to view them

5949

6488

The syntax is:

5950

6489

</para>

5951

6490

5952

5953

attachments {+|-}disposition mime-type

5954

unattachments {+|-}disposition mime-type

5955

attachments ?

5956

</screen>

6491

6492

<command>attachments</command>

6493

6494

<replaceable>{ + | - }disposition</replaceable>

6495

</arg>

6496

6497

6498

</arg>

6499

6500

<command>unattachments</command>

6501

6502

<replaceable>{ + | - }disposition</replaceable>

6503

</arg>

6504

6505

6506

</arg>

6507

6508

<command>attachments</command>

6509

6510

6511

</arg>

6512

</cmdsynopsis>

5957

6513

5958

6514

<para>

5959

Disposition is the attachment's Content-disposition type -- either

6515

<emphasis>disposition</emphasis> is the attachment's Content-Disposition type — either

5960

6516

<literal>inline</literal> or <literal>attachment</literal>.

5961

6517

You can abbreviate this to <literal>I</literal> or <literal>A</literal>.

5962

6518

</para>

5970

6526

</para>

5971

6527

5972

6528

<para>

5973

Mime-type is, unsurprisingly, the MIME type of the attachment you want

6529

<emphasis>mime-type</emphasis> is, unsurprisingly, the MIME type of the attachment you want

5974

6530

to affect. A MIME type is always of the format <literal>major/minor</literal>, where

5975

6531

<literal>major</literal> describes the broad category of document you're looking at, and

5976

6532

<literal>minor</literal> describes the specific type within that category. The major

5980

6536

</para>

5981

6537

5982

6538

<para>

5983

The MIME types you give to the attachments directive are a kind of

5984

pattern. When you use the attachments directive, the patterns you

5985

specify are added to a list. When you use unattachments, the pattern

6539

The MIME types you give to the <command>attachments</command> directive are a kind of

6540

pattern. When you use the <command>attachments</command> directive, the patterns you

6541

specify are added to a list. When you use <command>unattachments</command>, the pattern

5986

6542

is removed from the list. The patterns are not expanded and matched

5987

to specific MIME types at this time -- they're just text in a list.

6543

to specific MIME types at this time — they're just text in a list.

5988

6544

They're only matched when actually evaluating a message.

5989

6545

</para>

5990

6546

6046

6602

</example>

6047

6603

6048

6604

<para>

6049

Entering the command <quote><literal>attachments ?</literal></quote>

6605

Entering the command <quote><command>attachments</command> ?</quote>

6050

6606

as a command will list your current settings in Muttrc format, so that

6051

6607

it can be pasted elsewhere.

6052

6608

</para>

6057

6613

<title>MIME Lookup</title>

6058

6614

6059

6615

<para>

6616

Usage:

6617

</para>

6618

6619

6620

<command>mime-lookup</command>

6621

6622

<replaceable>mimetype</replaceable>

6623

</arg>

6624

6625

<replaceable>mimetype</replaceable>

6626

</arg>

6627

6628

<command>unmime-lookup</command>

6629

6630

6631

6632

</arg>

6633

6634

<replaceable>mimetype</replaceable>

6635

</arg>

6636

</group>

6637

</cmdsynopsis>

6638

6639

<para>

6060

6640

Mutt's mime&lowbar;lookup list specifies a list of mime-types that should not

6061

6641

be treated according to their mailcap entry. This option is designed to

6062

deal with binary types such as application/octet-stream. When an attachment's

6642

deal with binary types such as <literal>application/octet-stream</literal>. When an attachment's

6063

6643

mime-type is listed in mime&lowbar;lookup, then the extension of the filename will

6064

be compared to the list of extensions in the mime.types file. The mime-type

6644

be compared to the list of extensions in the <literal>mime.types</literal> file. The mime-type

6065

6645

associated with this extension will then be used to process the attachment

6066

6646

according to the rules in the mailcap file and according to any other configuration

6067

options (such as auto&lowbar;view) specified. Common usage would be:

6647

options (such as <command>auto&lowbar;view</command>) specified. Common usage would be:

6068

6648

</para>

6069

6649

6070

6650

6072

6652

</screen>

6073

6653

6074

6654

<para>

6075

In addition, the unmime&lowbar;lookup command may be used to disable this feature

6076

for any particular mime-type if it had been set, for example, in a global

6077

muttrc.

6655

In addition, the <literal>unmime&lowbar;lookup</literal> command may be

6656

used to disable this feature for any particular mime-type if it had been

6657

set, for example, in a global <literal>.muttrc</literal>.

6078

6658

</para>

6079

6659

6080

6660

</sect1>

6082

6662

</chapter>

6083

6663

6084

6664

6085

<title>Optional features</title>

6665

<title>Optional Features</title>

6086

6666

6087

6667

6088

<title>General notes</title>

6668

<title>General Notes</title>

6089

6669

6090

6670

6091

<title>Enabling/disabling features</title>

6671

<title>Enabling/Disabling Features</title>

6092

6672

6093

6673

<para>

6094

6674

Mutt supports several of optional features which can be enabled or

6101

6681

Which features are enabled or disabled can later be determined from the

6102

6682

output of <literal>mutt -v</literal>. If a compile option starts with

6103

6683

<quote>+</quote> it is enabled and disabled if prefixed with <quote>-</quote>. For example, if

6104

mutt was compiled using GnuTLS for encrypted communication instead of

6684

Mutt was compiled using GnuTLS for encrypted communication instead of

6105

6685

OpenSSL, <literal>mutt -v</literal> would contain:

6106

6686

</para>

6107

6687

6111

6691

</sect2>

6112

6692

6113

6693

6114

<title>URL syntax</title>

6694

<title>URL Syntax</title>

6115

6695

6116

6696

<para>

6117

6697

Mutt optionally supports the IMAP, POP3 and SMTP protocols which require

6118

6698

to access servers using URLs. The canonical syntax for specifying URLs

6119

in mutt is (an item enclosed in <literal>[]</literal> means it is optional and

6699

in Mutt is (an item enclosed in <literal>[]</literal> means it is optional and

6120

6700

may be omitted):

6121

6701

</para>

6122

6702

6125

6705

</screen>

6126

6706

6127

6707

<para>

6128

<literal>proto</literal> is the communication protocol:

6708

<emphasis>proto</emphasis> is the communication protocol:

6129

6709

<literal>imap</literal> for IMAP, <literal>pop</literal> for POP3 and

6130

<literal>smtp</literal> for SMTP. If <quote>s</quote> for <quote>secure communication</quote>

6131

is appended, mutt will attempt to establish an encrypted communication

6132

using SSL or TLS. If no explicit port is given, mutt will use the

6133

system's default for the given protocol.

6134

</para>

6135

6136

<para>

6137

Since all protocols by mutt support authentication, the username may be

6138

given directly in the URL instead of using the <literal>pop_user</literal> or

6139

<literal>imap_user</literal> variables. It may contain the <quote>@</quote> symbol

6140

being used by many mail systems as part of the login name. A password can be

6141

given, too but is not recommended if the URL is specified in a configuration

6142

file on disk.

6710

<literal>smtp</literal> for SMTP. If <quote>s</quote> for <quote>secure

6711

communication</quote> is appended, Mutt will attempt to establish an

6712

encrypted communication using SSL or TLS.

6713

</para>

6714

6715

<para>

6716

Since all protocols supported by Mutt support/require authentication,

6717

login credentials may be specified in the URL. This has the advantage

6718

that multiple IMAP, POP3 or SMTP servers may be specified (which isn't

6719

possible using, for example,

6720

6721

may contain the <quote>@</quote> symbol being used by many mail systems

6722

as part of the login name. A password can be given, too but is not

6723

recommended if the URL is specified in a configuration file on disk.

6724

</para>

6725

6726

<para>

6727

If no port number is given, Mutt will use the system's default for the

6728

given protocol (usually consulting <literal>/etc/services</literal>).

6143

6729

</para>

6144

6730

6145

6731

<para>

6146

6732

The optional path is only relevant for IMAP.

6147

6733

</para>

6148

6734

6149

<para>

6150

For IMAP for example, you can select an alternative port by specifying it with the

6151

server: <literal>imap://imapserver:port/INBOX</literal>. You can also specify different

6152

username for each folder: <literal>imap://username@imapserver[:port]/INBOX</literal>

6153

or <literal>imap://username2@imapserver[:port]/path/to/folder</literal>.

6154

Replacing <literal>imap://</literal> by <literal>imaps://</literal>

6155

would make mutt attempt to connect using SSL or TLS on a different port

6156

to encrypt the communication.

6157

</para>

6735

6736

6737

6738

pops://host/

6739

imaps://user@host/INBOX/Sent

6740

smtp://user@host:587/

6741

</screen>

6742

</example>

6158

6743

6159

6744

</sect2>

6160

6745

6164

6749

<title>SSL/TLS Support</title>

6165

6750

6166

6751

<para>

6167

If mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be

6752

If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be

6168

6753

compiled with support for SSL or TLS using either OpenSSL or GnuTLS (

6169

6754

by running the <emphasis>configure</emphasis> script with the

6170

6755

<emphasis>--enable-ssl=...</emphasis> option for OpenSSL or

6179

6764

<title>POP3 Support</title>

6180

6765

6181

6766

<para>

6182

If Mutt was compiled with POP3 support (by running the <emphasis>configure</emphasis>

6767

If Mutt is compiled with POP3 support (by running the <emphasis>configure</emphasis>

6183

6768

script with the <emphasis>--enable-pop</emphasis> flag), it has the ability to work

6184

6769

with mailboxes located on a remote POP3 server and fetch mail for local

6185

6770

browsing.

6199

6784

variable, which defaults to every 60 seconds.

6200

6785

</para>

6201

6786

6787

<para>

6788

POP is read-only which doesn't allow for some features like editing

6789

messages or changing flags. However, using

6790

6791

Mutt simulates the new/old/read flags as well as flagged and replied.

6792

Mutt applies some logic on top of remote messages but cannot change

6793

them so that modifications of flags are lost when

6794

messages are downloaded from the POP server (either by Mutt or other

6795

tools).

6796

</para>

6797

6202

6798

6203

6799

<para>

6204

Another way to access your POP3 mail is the <literal><fetch-mail&dollar;</literal> function

6800

Another way to access your POP3 mail is the <literal><fetch-mail></literal> function

6205

6801

(default: G). It allows to connect to <link linkend="pop-host">&dollar;pop&lowbar;host</link>, fetch all your new mail and place it in the

6206

6802

local <link linkend="spoolfile">&dollar;spoolfile</link>. After this

6207

6803

point, Mutt runs exactly as if the mail had always been local.

6211

6807

<para>

6212

6808

If you only need to fetch all messages to a

6213

6809

local mailbox you should consider using a specialized program, such as

6214

<literal>fetchmail</literal>, <literal>getmail</literal> or similar.

6810

<literal>fetchmail(1)</literal>, <literal>getmail(1)</literal> or similar.

6215

6811

</para>

6216

6812

</note>

6217

6813

6253

6849

6254

6850

and

6255

6851

6256

variables. Personally I use

6852

variables. Reasonable values are:

6257

6853

</para>

6258

6854

6259

6855

6262

6858

</screen>

6263

6859

6264

6860

<para>

6265

with relatively good results over my slow modem line.

6861

with relatively good results even over slow modem lines.

6266

6862

</para>

6267

6863

6268

6864

<note>

6274

6870

</note>

6275

6871

6276

6872

6277

<title>The Folder Browser</title>

6873

<title>The IMAP Folder Browser</title>

6278

6874

6279

6875

<para>

6280

As of version 1.2, mutt supports browsing mailboxes on an IMAP

6876

As of version 1.2, Mutt supports browsing mailboxes on an IMAP

6281

6877

server. This is mostly the same as the local file browser, with the

6282

6878

following differences:

6283

6879

</para>

6286

6882

6287

6883

6288

6884

<para>

6289

In lieu of file permissions, mutt displays the string "IMAP",

6290

possibly followed by the symbol "+", indicating

6885

In lieu of file permissions, Mutt displays the string <quote>IMAP</quote>,

6886

possibly followed by the symbol <quote>+</quote>, indicating

6291

6887

that the entry contains both messages and subfolders. On

6292

6888

Cyrus-like servers folders will often contain both messages and

6293

6889

subfolders.

6307

6903

6308

6904

<para>

6309

6905

You can create, delete and rename mailboxes with the

6310

<literal>create-mailbox</literal>, <literal>delete-mailbox</literal>, and

6311

<literal>rename-mailbox</literal> commands (default bindings: <literal>C</literal>,

6906

<literal><create-mailbox></literal>, <literal><delete-mailbox></literal>, and

6907

<literal><rename-mailbox></literal> commands (default bindings: <literal>C</literal>,

6312

6908

<literal>d</literal> and <literal>r</literal>, respectively). You may also

6313

<literal>subscribe</literal> and <literal>unsubscribe</literal> to mailboxes (normally

6909

<literal><subscribe></literal> and <literal><unsubscribe></literal> to mailboxes (normally

6314

6910

these are bound to <literal>s</literal> and <literal>u</literal>, respectively).

6315

6911

</para>

6316

6912

</listitem>

6329

6925

yet to be integrated into the main tree). There is also support for

6330

6926

the pseudo-protocol ANONYMOUS, which allows you to log in to a public

6331

6927

IMAP server without having an account. To use ANONYMOUS, simply make

6332

your username blank or "anonymous".

6928

your username blank or <quote>anonymous</quote>.

6333

6929

</para>

6334

6930

6335

6931

<para>

6339

6935

(including DIGEST-MD5 and possibly GSSAPI), your entire session will be

6340

6936

encrypted and invisible to those teeming network snoops. It is the best

6341

6937

option if you have it. To use it, you must have the Cyrus SASL library

6342

installed on your system and compile mutt with the <emphasis>--with-sasl</emphasis> flag.

6938

installed on your system and compile Mutt with the <emphasis>--with-sasl</emphasis> flag.

6343

6939

</para>

6344

6940

6345

6941

<para>

6375

6971

<para>

6376

6972

6377

6973

authentication methods to try, in the order you wish to try them. If

6378

specified, this overrides mutt's default (attempt everything, in the order

6974

specified, this overrides Mutt's default (attempt everything, in the order

6379

6975

listed above).

6380

6976

</para>

6381

6977

</listitem>

6391

6987

6392

6988

<para>

6393

6989

Besides supporting traditional mail delivery through a

6394

sendmail-compatible program, mutt supports delivery through SMTP if it

6990

sendmail-compatible program, Mutt supports delivery through SMTP if it

6395

6991

was configured and built with <literal>--enable-smtp</literal>.

6396

6992

</para>

6397

6993

6398

6994

<para>

6399

6995

If the configuration variable

6400

6996

6401

6997

will contact the given SMTP server to deliver messages; if it is unset,

6402

mutt will use the program specified by <link linkend="sendmail">&dollar;sendmail</link>.

6998

Mutt will use the program specified by <link linkend="sendmail">&dollar;sendmail</link>.

6403

6999

</para>

6404

7000

6405

7001

<para>

6410

7006

The built-in SMTP support supports encryption (the <literal>smtps</literal> protocol

6411

7007

using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms

6412

7008

for SASL are specified in <link linkend="smtp-authenticators">&dollar;smtp&lowbar;authenticators</link>

6413

defaulting to an empty list which makes mutt try all available methods

7009

defaulting to an empty list which makes Mutt try all available methods

6414

7010

from most-secure to least-secure.

6415

7011

</para>

6416

7012

6417

7013

</sect1>

6418

7014

6419

7015

6420

<title>Managing multiple accounts</title>

7016

<title>Managing Multiple Accounts</title>

7017

7018

<para>

7019

Usage:

7020

</para>

7021

7022

7023

<command>account-hook</command>

7024

7025

<replaceable class="parameter">pattern</replaceable>

7026

</arg>

7027

7028

<replaceable class="parameter">command</replaceable>

7029

</arg>

7030

</cmdsynopsis>

6421

7031

6422

7032

<para>

6423

7033

If you happen to have accounts on multiple IMAP, POP and/or SMTP servers,

6424

7034

you may find managing all the authentication settings inconvenient and

6425

error-prone. The account-hook command may help. This hook works like

6426

folder-hook but is invoked whenever you access a remote mailbox

7035

error-prone. The <link linkend="account-hook"><command>account-hook</command></link> command may help. This hook works like

7036

6427

7037

(including inside the folder browser), not just when you open the

6428

mailbox which includes (for example) polling for new mail, storing Fcc

7038

mailbox. This includes (for example) polling for new mail, storing Fcc

6429

7039

messages and saving messages to a folder. As a consequence,

6430

account-hook should only be used to set connection-related settings such

7040

6431

7041

as passwords or tunnel commands but not settings such as sender

6432

7042

address or name (because in general it should be considered unpredictable

6433

which account-hook was last used).

7043

which <link linkend="account-hook"><command>account-hook</command></link> was last used).

6434

7044

</para>

6435

7045

6436

7046

<para>

6444

7054

account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'

6445

7055

</screen>

6446

7056

7057

<para>

7058

To manage multiple accounts with, for example, different values of

7059

7060

7061

has to be be used together with

7062

the <link linkend="mailboxes"><command>mailboxes</command></link> command.

7063

</para>

7064

7065

7066

<title>Managing multiple accounts</title>

7067

7068

mailboxes imap://user@host1/INBOX

7069

folder-hook imap://user@host1/ 'set folder=imap://host1/ ; set record=+INBOX/Sent'

7070

7071

mailboxes imap://user@host2/INBOX

7072

folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sent'

7073

</screen>

7074

</example>

7075

7076

<para>

7077

In example

7078

<xref linkend="ex-multiaccount"/> the folders are defined using

7079

7080

mail. Each <link linkend="folder-hook"><command>folder-hook</command></link> triggers when

7081

one mailbox below each IMAP account is opened and sets

7082

7083

folder. Next, it sets <link linkend="record">&dollar;record</link> to

7084

the <emphasis>INBOX/Sent</emphasis> folder below the newly

7085

set <link linkend="folder">&dollar;folder</link>. Please notice that the

7086

value the <quote>+</quote>

7087

7088

the <emphasis>current</emphasis> value

7089

of <link linkend="folder">&dollar;folder</link> and therefore has to be set

7090

separatedly per account. Setting other values

7091

like <link linkend="from">&dollar;from</link>

7092

or <link linkend="signature">&dollar;signature</link> is analogous to setting

7093

7094

</para>

7095

6447

7096

</sect1>

6448

7097

6449

7098

6450

<title>Local caching</title>

7099

<title>Local Caching</title>

6451

7100

6452

7101

<para>

6453

7102

Mutt contains two types of local caching: <emphasis>(1)</emphasis>

6457

7106

6458

7107

<para>

6459

7108

Header caching is optional as it depends on external libraries, body

6460

caching is always enabled if mutt is compiled with POP and/or IMAP

7109

caching is always enabled if Mutt is compiled with POP and/or IMAP

6461

7110

support as these use it (body caching requires no external library).

6462

7111

</para>

6463

7112

6464

7113

6465

<title>Header caching</title>

7114

<title>Header Caching</title>

6466

7115

6467

7116

<para>

6468

7117

Mutt provides optional support for caching message headers for the

6489

7138

to a directory.

6490

7139

</para>

6491

7140

6492

<para>

6493

For the one-file-per-folder case, database files for remote folders

6494

will be named according to their URL while database files for local

6495

folders will be named by the MD5 checksums of their path. These database

6496

files may be safely removed if a system is short on space. You

6497

can compute the name of the header cache file for a particular local folder

6498

through a command like the following:

6499

</para>

6500

6501

6502

$ printf '%s' '/path/to/folder' | md5sum

6503

</screen>

6504

6505

<para>

6506

The <literal>md5sum</literal> command may also be

6507

named <literal>md5</literal>, depending on your operating system.

6508

</para>

6509

6510

7141

</sect2>

6511

7142

6512

7143

6513

<title>Body caching</title>

7144

<title>Body Caching</title>

6514

7145

6515

7146

<para>

6516

7147

Both cache methods can be combined using the same directory for storage

6520

7151

6521

7152

6522

7153

<para>

6523

In addition to caching message headers only, mutt can also cache

7154

In addition to caching message headers only, Mutt can also cache

6524

7155

whole message bodies. This results in faster display of messages

6525

7156

for POP and IMAP folders because messages usually have to be

6526

7157

downloaded only once.

6529

7160

<para>

6530

7161

For configuration, the variable <link linkend="message-cachedir"

6531

7162

>&dollar;message&lowbar;cachedir</link> must point to a

6532

directory. There, mutt will create a hierarchy of subdirectories

7163

directory. There, Mutt will create a hierarchy of subdirectories

6533

7164

named like: <literal>proto:user@hostname</literal> where

6534

7165

<literal>proto</literal> is either <quote>pop</quote> or <quote>imap.</quote> Within

6535

there for each folder, mutt stores messages in single files (just

6536

like Maildir) so that with manual symlink creation these cache

6537

directories can be examined with mutt as read-only Maildir folders.

6538

</para>

6539

6540

<para>

7166

there for each folder, Mutt stores messages in single files.

6541

7167

All files can be removed as needed if the consumed disk space

6542

becomes an issue as mutt will silently fetch missing items again.

7168

becomes an issue as Mutt will silently fetch missing items again.

6543

7169

</para>

6544

7170

6545

7171

</sect2>

6555

7181

</para>

6556

7182

6557

7183

<para>

6558

For body caches, mutt can keep the local cache in sync with the

7184

For body caches, Mutt can keep the local cache in sync with the

6559

7185

remote mailbox if the

6560

7186

6561

7187

variable is set. Cleaning means to remove messages from the cache which

6562

7188

are no longer present in the mailbox which only happens when other mail

6563

clients or instances of mutt using a different body cache location

7189

clients or instances of Mutt using a different body cache location

6564

7190

delete messages (Mutt itself removes deleted messages from the cache

6565

7191

when syncing a mailbox). As cleaning can take a noticeable amount of time,

6566

7192

it should not be set in general but only occasionally.

6571

7197

</sect1>

6572

7198

6573

7199

6574

<title>Exact address generation</title>

7200

<title>Exact Address Generation</title>

6575

7201

6576

7202

<para>

6577

7203

Mutt supports the <quote>Name <user@host></quote> address syntax for reading and

6584

7210

6585

7211

</sect1>

6586

7212

6587

</chapter>

7213

7214

<title>Sending Anonymous Messages via Mixmaster</title>

7215

7216

<para>

7217

You may also have compiled Mutt to co-operate with Mixmaster, an

7218

anonymous remailer. Mixmaster permits you to send your messages

7219

anonymously using a chain of remailers. Mixmaster support in Mutt is for

7220

mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.

7221

It does not support earlier versions or the later so-called version 3 betas,

7222

of which the latest appears to be called 2.9b23.

7223

</para>

7224

7225

<para>

7226

To use it, you'll have to obey certain restrictions. Most

7227

important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell

7228

Mutt to use mixmaster, you have to select a remailer chain, using

7229

the mix function on the compose menu.

7230

</para>

7231

7232

<para>

7233

The chain selection screen is divided into two parts. In the

7234

(larger) upper part, you get a list of remailers you may use. In

7235

the lower part, you see the currently selected chain of remailers.

7236

</para>

7237

7238

<para>

7239

You can navigate in the chain using the <literal><chain-prev></literal> and

7240

<literal><chain-next></literal> functions, which are by default bound to the left

7241

and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi

7242

keyboard bindings). To insert a remailer at the current chain

7243

position, use the <literal><insert></literal> function. To append a remailer behind

7244

the current chain position, use <literal><select-entry></literal> or <literal><append></literal>.

7245

You can also delete entries from the chain, using the corresponding

7246

function. Finally, to abandon your changes, leave the menu, or

7247

<literal><accept></literal> them pressing (by default) the <literal>Return</literal> key.

7248

</para>

7249

7250

<para>

7251

Note that different remailers do have different capabilities,

7252

indicated in the &percnt;c entry of the remailer menu lines (see

7253

7254

the <quote>middleman</quote> capability, indicated by a capital <quote>M</quote>: This

7255

means that the remailer in question cannot be used as the final

7256

element of a chain, but will only forward messages to other

7257

mixmaster remailers. For details on the other capabilities, please

7258

have a look at the mixmaster documentation.

7259

</para>

7260

7261

</sect1>

7262

7263

</chapter>

7264

7265

7266

<title>Security Considerations</title>

7267

7268

<para>

7269

First of all, Mutt contains no security holes included by intention but

7270

may contain unknown security holes. As a consequence, please run Mutt

7271

only with as few permissions as possible. Especially, do not run Mutt as

7272

the super user.

7273

</para>

7274

7275

<para>

7276

When configuring Mutt, there're some points to note about secure setups

7277

so please read this chapter carefully.

7278

</para>

7279

7280

7281

<title>Passwords</title>

7282

7283

<para>

7284

Although Mutt can be told the various passwords for accounts, please

7285

never store passwords in configuration files. Besides the fact that the

7286

system's operator can always read them, you could forget to mask it out

7287

when reporting a bug or asking for help via a mailing list. Even worse,

7288

your mail including your password could be archived by internet search

7289

engines, mail-to-news gateways etc. It may already be too late before

7290

you notice your mistake.

7291

</para>

7292

7293

</sect1>

7294

7295

7296

<title>Temporary Files</title>

7297

7298

<para>

7299

Mutt uses many temporary files for viewing messages, verifying digital

7300

signatures, etc. As long as being used, these files are visible by other

7301

users and maybe even readable in case of misconfiguration. Also, a

7302

different location for these files may be desired which can be changed

7303

via the <link linkend="tmpdir">&dollar;tmpdir</link> variable.

7304

</para>

7305

7306

</sect1>

7307

7308

7309

<title>Information Leaks</title>

7310

7311

7312

<title>Message-Id: headers</title>

7313

7314

<para>

7315

Message-Id: headers contain a local part that is to be created in a

7316

unique fashion. In order to do so, Mutt will <quote>leak</quote> some

7317

information to the outside world when sending messages: the generation

7318

of this header includes a step counter which is increased (and rotated)

7319

with every message sent. In a longer running mutt session, others can

7320

make assumptions about your mailing habbits depending on the number of

7321

messages sent. If this is not desired, the header can be manually

7322

provided using <link

7323

linkend="edit-headers">&dollar;edit&lowbar;headers</link> (though not

7324

recommended).

7325

</para>

7326

7327

</sect2>

7328

7329

7330

<title><literal>mailto:</literal>-style Links</title>

7331

7332

<para>

7333

As Mutt be can be set up to be the mail client to handle

7334

<literal>mailto:</literal> style links in websites, there're security

7335

considerations, too. Arbitrary header fields can be embedded in these

7336

links which could override existing header fields or attach arbitrary

7337

files using <link linkend="attach-header">the Attach:

7338

psuedoheader</link>. This may be problematic if the <link

7339

linkend="edit-headers">&dollar;edit-headers</link> variable is

7340

<emphasis>unset</emphasis>, i.e. the user doesn't want to see header

7341

fields while editing the message and doesn't pay enough attention to the

7342

compose menu's listing of attachments.

7343

</para>

7344

7345

<para>

7346

For example, following a link like

7347

</para>

7348

7349

7350

mailto:joe@host?Attach=~/.gnupg/secring.gpg</screen>

7351

7352

<para>

7353

will send out the user's private gnupg keyring to

7354

<literal>joe@host</literal> if the user doesn't follow the information

7355

on screen carefully enough.

7356

</para>

7357

7358

</sect2>

7359

7360

</sect1>

7361

7362

7363

<title>External Applications</title>

7364

7365

<para>

7366

Mutt in many places has to rely on external applications or for

7367

convenience supports mechanisms involving external applications.

7368

</para>

7369

7370

<para>

7371

One of these is the <literal>mailcap</literal> mechanism as defined by

7372

RfC1524. Details about a secure use of the mailcap mechanisms is given

7373

in <xref linkend="secure-mailcap"/>.

7374

</para>

7375

7376

<para>

7377

Besides the mailcap mechanism, Mutt uses a number of other external

7378

utilities for operation, for example to provide crypto support, in

7379

backtick expansion in configuration files or format string filters. The

7380

same security considerations apply for these as for tools involved via

7381

mailcap.

7382

</para>

7383

7384

</sect1>

7385

7386

</chapter>

7387

6588

7388

6589

7389

6590

<title>Performance tuning</title>

7390

<title>Performance Tuning</title>

6591

7391

6592

7392

6593

<title>Reading and writing mailboxes</title>

7393

<title>Reading and Writing Mailboxes</title>

6594

7394

6595

7395

<para>

6596

7396

Mutt's performance when reading mailboxes can be improved in two ways:

6601

7401

6602

7402

<para>

6603

7403

For remote folders (IMAP and POP) as well as folders using

6604

one-file-per message storage (Maildir and MH), mutt's

7404

one-file-per message storage (Maildir and MH), Mutt's

6605

7405

performance can be greatly improved using

6606

7406

6607

Using a single database per folder may further increase

6608

performance.

7407

using a single database per folder.

6609

7408

</para>

6610

7409

</listitem>

6611

7410

6614

7413

Mutt provides the <link linkend="read-inc">&dollar;read&lowbar;inc</link>

6615

7414

and <link linkend="write-inc">&dollar;write&lowbar;inc</link>

6616

7415

variables to specify at which rate to update progress

6617

counters. If these values are too low, mutt may spend more

7416

counters. If these values are too low, Mutt may spend more

6618

7417

time on updating the progress counter than it spends on

6619

7418

actually reading/writing folders.

6620

7419

</para>

6623

7422

thousand messages, the default value for

6624

7423

6625

7424

may be too low. It can be tuned on on a folder-basis using

6626

7425

6627

7426

</para>

6628

7427

6629

7428

6648

7447

</sect1>

6649

7448

6650

7449

6651

<title>Reading messages from remote folders</title>

7450

<title>Reading Messages from Remote Folders</title>

6652

7451

6653

7452

<para>

6654

7453

Reading messages from remote folders such as IMAP an POP can be

6655

slow especially for large mailboxes since mutt only caches a very

7454

slow especially for large mailboxes since Mutt only caches a very

6656

7455

limited number of recently viewed messages (usually 10) per

6657

7456

session (so that it will be gone for the next session.)

6658

7457

</para>

6659

7458

6660

7459

<para>

6661

7460

To improve performance and permanently cache whole messages,

6662

please refer to mutt's so-called

7461

please refer to Mutt's so-called

6663

7462

6664

7463

</para>

6665

7464

6666

7465

</sect1>

6667

7466

6668

7467

6669

<title>Searching and limiting</title>

7468

<title>Searching and Limiting</title>

6670

7469

6671

7470

<para>

6672

7471

When searching mailboxes either via a search or a limit action, for

6673

some patterns mutt distinguishes between regular expression and string

7472

some patterns Mutt distinguishes between regular expression and string

6674

7473

searches. For regular expressions, patterns are prefixed with

6675

7474

<quote>&tilde;</quote> and with <quote>=</quote> for string searches.

6676

7475

</para>

6692

7491

</para>

6693

7492

6694

7493

<para>

6695

Please note that string search is an exact case-sensitive search

6696

while a regular expression search with only lower-case letters performs

6697

a case-insensitive search.

7494

As for regular expressions, a lower case string search pattern makes

7495

Mutt perform a case-insensitive search except for IMAP (because for IMAP

7496

Mutt performs server-side searches which don't support case-insensivity).

6698

7497

</para>

6699

7498

6700

7499

</sect1>

6705

7504

<title>Reference</title>

6706

7505

6707

7506

6708

<title>Command line options</title>

7507

<title>Command-Line Options</title>

6709

7508

6710

7509

<para>

6711

7510

Running <literal>mutt</literal> with no arguments will make Mutt attempt to read your spool

6724

7523

<row><entry>-a</entry><entry>attach a file to a message</entry></row>

6725

7524

<row><entry>-b</entry><entry>specify a blind carbon-copy (BCC) address</entry></row>

6726

7525

<row><entry>-c</entry><entry>specify a carbon-copy (Cc) address</entry></row>

6727

<row><entry>-D</entry><entry>print the value of all mutt variables to stdout</entry></row>

7526

<row><entry>-D</entry><entry>print the value of all Mutt variables to stdout</entry></row>

6728

7527

<row><entry>-e</entry><entry>specify a config command to be run after initialization files are read</entry></row>

6729

7528

<row><entry>-f</entry><entry>specify a mailbox to load</entry></row>

6730

7529

<row><entry>-F</entry><entry>specify an alternate file to read initialization commands</entry></row>

6739

7538

<row><entry>-s</entry><entry>specify a subject (enclose in quotes if it contains spaces)</entry></row>

6740

7539

<row><entry>-v</entry><entry>show version number and compile-time definitions</entry></row>

6741

7540

<row><entry>-x</entry><entry>simulate the mailx(1) compose mode</entry></row>

6742

<row><entry>-y</entry><entry>show a menu containing the files specified by the mailboxes command</entry></row>

7541

<row><entry>-y</entry><entry>show a menu containing the files specified by the <command>mailboxes</command> command</entry></row>

6743

7542

<row><entry>-z</entry><entry>exit immediately if there are no messages in the mailbox</entry></row>

6744

<row><entry>-Z</entry><entry>open the first folder with new message,exit immediately if none</entry></row>

7543

<row><entry>-Z</entry><entry>open the first folder with new message, exit immediately if none</entry></row>

6745

7544

</tbody>

6746

7545

</tgroup>

6747

7546

</table>

6774

7573

6775

7574

<replaceable>muttrc</replaceable>

6776

7575

</arg>

6777

6778

6779

</arg>

6780

7576

6781

7577

<replaceable>address</replaceable>

6782

7578

</arg>

6787

7583

<replaceable>subject</replaceable>

6788

7584

</arg>

6789

7585

6790

7586

6791

7587

6792

</arg>

6793

6794

</arg>

6795

6796

<replaceable>address</replaceable>

6797

</arg>

6798

7588

7589

--

7590

</arg>

7591

6799

7592

<replaceable>address</replaceable>

6800

7593

</arg>

6801

7594

</cmdsynopsis>

6805

7598

input from the file you wish to send. For example,

6806

7599

</para>

6807

7600

6808

<para>

6809

<literal>mutt -s "data set for run &num;2" professor@bigschool.edu

6810

< &tilde;/run2.dat</literal>

6811

</para>

7601

7602

mutt -s "data set for run &num;2" professor@bigschool.edu < &tilde;/run2.dat</screen>

6812

7603

6813

7604

<para>

6814

This command will send a message to <quote>professor@bigschool.edu</quote> with a subject

7605

will send a message to <literal><professor@bigschool.edu></literal> with a subject

6815

7606

of <quote>data set for run &num;2</quote>. In the body of the message will be the contents

6816

7607

of the file <quote>&tilde;/run2.dat</quote>.

6817

7608

</para>

6818

7609

6819

7610

<para>

6820

All files passed with -a <emphasis>file</emphasis> will be attached as a MIME

6821

part to the message. To attach several files, use <quote>--</quote> to separate files and

6822

recipient addresses: <literal>mutt -a *.png -- some@one.org</literal>

6823

</para>

7611

All files passed with <literal>-a</literal> <emphasis>file</emphasis> will be attached as a MIME

7612

part to the message. To attach a single or several files, use <quote>--</quote> to separate files and

7613

recipient addresses:

7614

</para>

7615

7616

7617

mutt -a image.png -- some@one.org</screen>

7618

7619

<para>

7620

or

7621

</para>

7622

7623

7624

mutt -a *.png -- some@one.org</screen>

7625

7626

<note>

7627

<para>

7628

The <literal>-a</literal> option must be last in the option list.

7629

</para>

7630

</note>

6824

7631

6825

7632

</sect1>

6826

7633

6828

7635

<title>Configuration Commands</title>

6829

7636

6830

7637

<para>

6831

The following are the commands understood by mutt.

7638

The following are the commands understood by Mutt:

6832

7639

</para>

6833

7640

6834

7641

6859

7666

6860

7667

<replaceable class="parameter">address</replaceable>

6861

7668

</arg>

6862

</cmdsynopsis>

6863

</listitem>

6864

7669

6865

6866

6867

7670

<command><link linkend="alias">unalias</link></command>

6868

7671

6869

7672

<option>-group</option>

6893

7696

6894

7697

<replaceable>regexp</replaceable>

6895

7698

</arg>

6896

</cmdsynopsis>

6897

</listitem>

6898

7699

6899

6900

6901

7700

<command><link linkend="alternates">unalternates</link></command>

6902

7701

6903

7702

<option>-group</option>

6923

7722

6924

7723

<replaceable>mimetype</replaceable>

6925

7724

</arg>

6926

</cmdsynopsis>

6927

</listitem>

6928

7725

6929

6930

6931

7726

<command><link linkend="alternative-order">unalternative-order</link></command>

6932

7727

6933

7728

6942

7737

6943

7738

6944

7739

7740

<command><link linkend="attachments">attachments</link></command>

7741

7742

<replaceable>{ + | - }disposition</replaceable>

7743

</arg>

7744

7745

7746

</arg>

7747

7748

<command><link linkend="attachments">unattachments</link></command>

7749

7750

<replaceable>{ + | - }disposition</replaceable>

7751

</arg>

7752

7753

7754

</arg>

7755

</cmdsynopsis>

7756

</listitem>

7757

7758

7759

6945

7760

6946

7761

6947

7762

<replaceable>mimetype</replaceable>

6949

7764

6950

7765

<replaceable>mimetype</replaceable>

6951

7766

</arg>

6952

</cmdsynopsis>

6953

</listitem>

6954

6955

7767

6956

6957

7768

<command><link linkend="auto-view">unauto-view</link></command>

6958

7769

6959

7770

6995

7806

6996

7807

6997

7808

6998

<command><link linkend="charset-hook">iconv-hook</link></command>

7809

<command><link linkend="iconv-hook">iconv-hook</link></command>

6999

7810

7000

7811

<replaceable class="parameter">charset</replaceable>

7001

7812

</arg>

7017

7828

7018

7829

<replaceable class="parameter">background</replaceable>

7019

7830

</arg>

7020

</cmdsynopsis>

7021

7831

7022

7832

<command><link linkend="color">color</link></command>

7023

7833

7024

7834

7037

7847

7038

7848

<replaceable class="parameter">regexp</replaceable>

7039

7849

</arg>

7040

</cmdsynopsis>

7041

7850

7042

7851

<command><link linkend="color">color</link></command>

7043

7852

7044

7853

<option>index</option>

7052

7861

7053

7862

<replaceable class="parameter">pattern</replaceable>

7054

7863

</arg>

7055

</cmdsynopsis>

7056

</listitem>

7057

7864

7058

7059

7060

7865

<command><link linkend="color">uncolor</link></command>

7866

7061

7867

7062

7868

<option>index</option>

7063

7869

</arg>

7870

7871

<option>header</option>

7872

</arg>

7873

7874

7875

</arg>

7876

</group>

7877

7878

7879

7880

</arg>

7064

7881

7882

<replaceable>pattern</replaceable>

7883

</arg>

7884

</group>

7885

</cmdsynopsis>

7886

</listitem>

7887

7888

7889

7890

<command><link linkend="crypt-hook">crypt-hook</link></command>

7891

7065

7892

<replaceable class="parameter">pattern</replaceable>

7066

7893

</arg>

7894

7895

<replaceable class="parameter">keyid</replaceable>

7896

</arg>

7067

7897

</cmdsynopsis>

7068

7898

</listitem>

7069

7899

7132

7962

7133

7963

</arg>

7134

7964

</group>

7135

</cmdsynopsis>

7136

</listitem>

7137

7965

7138

7139

7140

7966

<command><link linkend="addrgroup">ungroup</link></command>

7141

7967

7142

7968

<option>-group</option>

7167

7993

7168

7994

<replaceable class="parameter">header</replaceable>

7169

7995

</arg>

7170

</cmdsynopsis>

7171

</listitem>

7172

7996

7173

7174

7175

7997

<command><link linkend="hdr-order">unhdr&lowbar;order</link></command>

7176

7998

7177

7999

7193

8015

7194

8016

<replaceable class="parameter">pattern</replaceable>

7195

8017

</arg>

7196

</cmdsynopsis>

7197

</listitem>

7198

8018

7199

7200

7201

8019

<command><link linkend="ignore">unignore</link></command>

7202

8020

7203

8021

7223

8041

7224

8042

<replaceable class="parameter">regexp</replaceable>

7225

8043

</arg>

7226

</cmdsynopsis>

7227

</listitem>

7228

8044

7229

7230

7231

8045

<command><link linkend="lists">unlists</link></command>

7232

8046

7233

8047

<option>-group</option>

7271

8085

7272

8086

<replaceable class="parameter">mailbox</replaceable>

7273

8087

</arg>

7274

</cmdsynopsis>

7275

</listitem>

7276

8088

7277

7278

7279

8089

<command><link linkend="mailboxes">unmailboxes</link></command>

7280

8090

7281

8091

7321

8131

7322

8132

<replaceable>mimetype</replaceable>

7323

8133

</arg>

7324

</cmdsynopsis>

7325

</listitem>

7326

8134

7327

7328

7329

8135

<command><link linkend="mime-lookup">unmime-lookup</link></command>

7330

8136

7331

8137

7347

8153

7348

8154

<replaceable class="parameter">attribute</replaceable>

7349

8155

</arg>

7350

</cmdsynopsis>

7351

8156

7352

8157

7353

8158

7354

8159

7364

8169

7365

8170

<replaceable class="parameter">regexp</replaceable>

7366

8171

</arg>

7367

</cmdsynopsis>

7368

8172

7369

8173

7370

8174

7371

8175

<option>index</option>

7376

8180

7377

8181

<replaceable class="parameter">pattern</replaceable>

7378

8182

</arg>

7379

</cmdsynopsis>

7380

</listitem>

7381

8183

7382

7383

7384

8184

<command><link linkend="mono">unmono</link></command>

8185

7385

8186

7386

8187

<option>index</option>

7387

8188

</arg>

8189

8190

<option>header</option>

8191

</arg>

8192

8193

8194

</arg>

8195

</group>

7388

8196

7389

8197

7390

8198

7402

8210

7403

8211

<replaceable class="parameter">string</replaceable>

7404

8212

</arg>

7405

</cmdsynopsis>

7406

</listitem>

7407

8213

7408

7409

7410

8214

<command><link linkend="my-hdr">unmy&lowbar;hdr</link></command>

7411

8215

7412

8216

7421

8225

7422

8226

7423

8227

7424

<command><link linkend="crypt-hook">crypt-hook</link></command>

7425

7426

<replaceable class="parameter">pattern</replaceable>

7427

</arg>

7428

7429

<replaceable class="parameter">keyid</replaceable>

7430

</arg>

7431

</cmdsynopsis>

7432

</listitem>

7433

7434

7435

7436

8228

7437

8229

7438

8230

<replaceable class="parameter">string</replaceable>

7442

8234

7443

8235

7444

8236

7445

<command><link linkend="set">reset</link></command>

7446

7447

<replaceable class="parameter">variable</replaceable>

7448

</arg>

7449

7450

<replaceable class="parameter">variable</replaceable>

7451

</arg>

7452

</cmdsynopsis>

7453

</listitem>

7454

7455

7456

7457

8237

7458

8238

7459

8239

<replaceable class="parameter">[!]pattern</replaceable>

7473

8253

7474

8254

<replaceable class="parameter">value</replaceable>

7475

8255

</arg>

7476

</cmdsynopsis>

7477

</listitem>

7478

8256

7479

7480

7481

8257

<command><link linkend="score">unscore</link></command>

7482

8258

7483

8259

7541

8317

<replaceable class="parameter">variable=value</replaceable>

7542

8318

</arg>

7543

8319

</group>

7544

7545

</cmdsynopsis>

7546

</listitem>

7547

7548

7549

8320

8321

8322

<command><link linkend="set">toggle</link></command>

8323

8324

<replaceable class="parameter">variable</replaceable>

8325

</arg>

8326

8327

<replaceable class="parameter">variable</replaceable>

8328

</arg>

8329

7550

8330

<command><link linkend="set">unset</link></command>

7551

8331

7552

8332

<replaceable class="parameter">variable</replaceable>

7554

8334

7555

8335

<replaceable class="parameter">variable</replaceable>

7556

8336

</arg>

8337

8338

<command><link linkend="set">reset</link></command>

8339

8340

<replaceable class="parameter">variable</replaceable>

8341

</arg>

8342

8343

<replaceable class="parameter">variable</replaceable>

8344

</arg>

7557

8345

</cmdsynopsis>

7558

8346

</listitem>

7559

8347

7575

8363

7576

8364

<replaceable class="parameter">format</replaceable>

7577

8365

</arg>

7578

</cmdsynopsis>

7579

</listitem>

7580

8366

7581

7582

7583

8367

<command><link linkend="spam">nospam</link></command>

7584

8368

7585

8369

7605

8389

7606

8390

<replaceable class="parameter">regexp</replaceable>

7607

8391

</arg>

7608

</cmdsynopsis>

7609

</listitem>

7610

8392

7611

7612

7613

8393

<command><link linkend="subscribe">unsubscribe</link></command>

7614

8394

7615

8395

<option>-group</option>

7628

8408

7629

8409

7630

8410

7631

<command><link linkend="set">toggle</link></command>

7632

7633

<replaceable class="parameter">variable</replaceable>

7634

</arg>

7635

7636

<replaceable class="parameter">variable</replaceable>

7637

</arg>

7638

</cmdsynopsis>

7639

</listitem>

7640

7641

7642

7643

8411

<command><link linkend="unhook">unhook</link></command>

7644

8412

7645

8413

7657

8425

</sect1>

7658

8426

7659

8427

7660

<title>Configuration variables</title>

8428

<title>Configuration Variables</title>