claws-mail.1 (13644B)
1 .TH "CLAWS MAIL" "1" "February 17, 2024" "The Claws Mail team" "User Manuals" 2 3 .SH "NAME" 4 .LP 5 Claws Mail \- a GTK based fast email and news client 6 7 .SH "SYNOPSIS" 8 .B claws\-mail 9 .RI [ options ]... 10 11 .SH "DESCRIPTION" 12 .TP 13 Claws Mail is an email client (and news reader) based on GTK, running on the X Window System, and aiming for: 14 .br 15 \[bu] Quick response 16 .br 17 \[bu] Graceful, and sophisticated interface 18 .br 19 \[bu] Easy configuration, intuitive operation 20 .br 21 \[bu] Abundant features 22 \fR 23 .TP 24 Currently implemented features include: 25 \[bu] POP3 support 26 .br 27 \[bu] IMAP4rev1 support 28 .br 29 \[bu] integrated NetNews client 30 .br 31 \[bu] unlimited multiple account handling 32 .br 33 \[bu] thread display 34 .br 35 \[bu] filtering 36 .br 37 \[bu] MIME (attachments) 38 .br 39 \[bu] built\-in image view 40 .br 41 \[bu] X\-Face and (colour) Face support 42 .br 43 \[bu] multiple MH folder support 44 .br 45 \[bu] mbox importing / exporting 46 .br 47 \[bu] external editor support 48 .br 49 \[bu] message queueing 50 .br 51 \[bu] automatic mail checking 52 .br 53 \[bu] draft message function 54 .br 55 \[bu] template function 56 .br 57 \[bu] line\-wrapping 58 .br 59 \[bu] clickable URI 60 .br 61 \[bu] XML\-based address book 62 .br 63 \[bu] LDAP, vCard, and JPilot support 64 .br 65 \[bu] newly arrived and unread message management 66 .br 67 \[bu] Mew/Wanderlust\-like key bind 68 .br 69 \[bu] printing 70 .br 71 \[bu] APOP authentication support 72 .br 73 \[bu] SMTP AUTH support 74 .br 75 \[bu] SSL support (POP3, SMTP, IMAP4rev1) 76 .br 77 \[bu] IPv6 support 78 .br 79 \[bu] drag & drop (partially implemented) 80 .br 81 \[bu] GnuPG support 82 .br 83 \[bu] automake + autoconf support 84 .br 85 \[bu] internationalization of UI messages by gettext 86 .br 87 \[bu] support of many code sets, including UTF\-8 (Unicode) 88 .br 89 \[bu] support for plugins 90 \fR 91 .LP 92 This list is not complete. 93 94 .SH "OPTIONS" 95 .LP 96 \fB \-\-compose\fR [address] 97 .br 98 \fB \-\-compose\-from\-file\fR file 99 .br 100 \fB \-\-subscribe\fR uri 101 .br 102 \fB \-\-attach\fR file1 [file2]...\fR 103 .br 104 \fB \-\-insert\fR file1 [file2]...\fR 105 .br 106 \fB \-\-import-mbox\fR file\fR 107 .br 108 \fB \-\-receive\fR 109 .br 110 \fB \-\-receive\-all\fR 111 .br 112 \fB \-\-cancel\-receiving\fR 113 .br 114 \fB \-\-cancel\-sending\fR 115 .br 116 \fB \-\-search\fR folder type request [recursive] 117 .br 118 \fB \-\-send\fR 119 .br 120 \fB \-\-status\fR 121 .br 122 \fB \-\-status\fR folder[/subfolder] 123 .br 124 \fB \-\-status\-full\fR 125 .br 126 \fB \-\-status\-full\fR folder[/subfolder] 127 .br 128 \fB \-\-statistics\fR 129 .br 130 \fB \-\-reset-statistics\fR 131 .br 132 \fB \-\-select\fR [#mh/mailbox/]folder[/msg|/msgid], a file:// uri or an absolute path 133 .br 134 \fB \-\-online\fR 135 .br 136 \fB \-\-offline\fR 137 .br 138 \fB \-\-exit\fR 139 .br 140 \fB \-\-debug\fR 141 .br 142 \fB \-\-toggle\-debug\fR 143 .br 144 \fB \-\-help\fR 145 .br 146 \fB \-\-version\fR 147 .br 148 \fB \-\-version\-full\fR 149 .br 150 \fB \-\-config\-dir\fR 151 .br 152 \fB \-\-alternate\-config\-dir\fR directory 153 .br 154 \fB \-\-geometry\fR [WxH][+X+Y] 155 156 .SH "FILES" 157 .LP 158 .TP 159 \fB$HOME/Mail\fR 160 Default directory for mail storage. 161 .TP 162 \fB$PREFIX/share/claws\-mail\fR 163 Global program directory. 164 .TP 165 \fB$PREFIX/share/claws\-mail/manual\fR 166 Manual files in HTML, PDF, PostScript and plain text format. 167 .TP 168 \fB$PREFIX/share/claws\-mail/themes\fR 169 Global themes directory. 170 .TP 171 \fB$PREFIX/lib/claws\-mail/plugins\fR 172 Directory for plugins. 173 .TP 174 \fB$PREFIX/include/claws\-mail\fR 175 Directory for header files. 176 .TP 177 \fB$HOME/.claws\-mail\fR 178 Default directory for user's configuration files directory. 179 .TP 180 \fB$HOME/.claws\-mail/addrbook/*\fR 181 Addressbook files. 182 .TP 183 \fB$HOME/.claws\-mail/autofaces/*\fR 184 Automatic Faces and X\-Faces files for accounts. 185 .TP 186 \fB$HOME/.claws\-mail/certs/*\fR 187 SSL certificates received from mail servers. 188 .TP 189 \fB$HOME/.claws\-mail/tagsdb\fR 190 Tags directory. 191 .TP 192 \fB$HOME/.claws\-mail/templates\fR 193 User\-defined templates directory. 194 .TP 195 \fB$HOME/.claws\-mail/themes\fR 196 User's themes directory. 197 .TP 198 \fB$HOME/.claws\-mail/accountrc\fR 199 Configuration for account(s). 200 .TP 201 \fB$HOME/.claws\-mail/actionsrc\fR 202 User\-defined custom actions. 203 .TP 204 \fB$HOME/.claws\-mail/addrbook/attributesrc\fR 205 User\-defined address book custom attributes. 206 .TP 207 \fB$HOME/.claws\-mail/claws.log\fR 208 Claws Mail logfile. 209 .TP 210 \fB$HOME/.claws\-mail/clawsrc\fR 211 Main configuration file. 212 .TP 213 \fB$HOME/.claws\-mail/command_history\fR 214 User\-specified commands. 215 .TP 216 \fB$HOME/.claws\-mail/customheaderrc\fR 217 Configuration for custom headers for sending mail. 218 .TP 219 \fB$HOME/.claws\-mail/dispheaderrc\fR 220 Configuration for custom display of headers in message view. 221 .TP 222 \fB$HOME/.claws\-mail/extraheaderrc\fR 223 Editable extra headers to be added to compose window combobox. 224 .TP 225 \fB$HOME/.claws\-mail/folderitemrc\fR 226 All folders' attributes. 227 .TP 228 \fB$HOME/.claws\-mail/folderlist.xml\fR 229 Folder hierarchy listing. 230 .TP 231 \fB$HOME/.claws\-mail/gtkrc-2.0\fR 232 Optional GTK settings to be load on startup. 233 .TP 234 \fB$HOME/.claws\-mail/matcherrc\fR 235 Filtering and Processing function configuration. 236 .TP 237 \fB$HOME/.claws\-mail/menurc\fR 238 Menu shortcut\-key configuration. 239 .TP 240 \fB$HOME/.claws\-mail/messagesearch_history\fR 241 User\-specified searches in message bodies. 242 .TP 243 \fB$HOME/.claws\-mail/quicksearch_history\fR 244 User\-specified quick\-search list. 245 .TP 246 \fB$HOME/.claws\-mail/messagesearch_history\fR 247 User\-specified searches in message bodies. 248 .TP 249 \fB$HOME/.claws\-mail/summary*_history\fR 250 User\-specified searches in message list. 251 .TP 252 \fB$HOME/.claws\-mail/passwordstorerc\fR 253 User saved passwords. 254 .TP 255 \fB$HOME/.claws\-mail/tagsrc\fR 256 User\-specified tag list. 257 .TP 258 \fB$HOME/.claws\-mail/toolbar*.xml\fR 259 User\-defined custom toolbars. 260 .TP 261 \fB%TEMP%\\claws\-win32.log \fI(Windows only)\fR 262 Claws Mail output file when \-\-debug is enabled. If 263 %TEMP% is not set it defaults to windows directory (usually 264 C:\\Windows) or C:\\ if windows directory is not available. 265 .TP 266 \fB%APPDATA%\\Claws\-mail\\claws.log \fI(Windows only)\fR 267 Claws Mail log file. 268 269 .SH "EXAMPLES" 270 .LP 271 To run this program the standard way type: 272 .LP 273 claws\-mail 274 .LP 275 Alternatively you can run it with the following options: 276 .TP 277 \fB\-\-compose\fR [address] 278 To open a Compose window. 279 .TP 280 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR" 281 This syntax can be used in web\-browsers and CLI to open a pre\-populated 282 Compose window. Possible fields after the destination recipient are: subject, 283 from, cc, bcc, in\-reply\-to, body, insert (insert a file in body part, needs 284 an absolute path), attach (attach a file, needs an absolute path, see also: 285 \-\-attach). 286 .TP 287 \fB\-\-compose\-from\-file\fR file 288 Open composition window with data from the given file. Use \- as file name 289 for reading from standard input. Content format: headers first (To: header 290 required) until an empty line is found, then mail body until end of file. 291 .TP 292 \fB\-\-subscribe\fR uri 293 Subscribe to the given URI if possible. 294 .TP 295 \fB\-\-attach\fR file1 [file2]... 296 Open composition window with specified files attached. 297 .TP 298 \fB\-\-insert\fR file1 [file2]... 299 Open composition window with specified files inserted. 300 .TP 301 \fB\-\-receive\fR 302 Receive new messages. 303 .TP 304 \fB\-\-receive\-all\fR 305 Receive new messages from all accounts. 306 .TP 307 \fB\-\-cancel\-receiving\fR 308 Cancel receiving of messages. 309 .TP 310 \fB\-\-cancel\-sending\fR 311 Cancel sending of messages. 312 .TP 313 \fB\-\-search\fR folder type request [recursive] 314 .br 315 Searches mail: 316 .br 317 folder ex.: "#mh/Mailbox/inbox" or "Mail" 318 .br 319 type: s[ubject],f[rom],t[o],e[xtended],m[ixed] or g: tag 320 .br 321 request: search string 322 .br 323 recursive: false if arg. starts with 0, n, N, f or F 324 .TP 325 \fB\-\-send\fR 326 .br 327 Send all queued messages. 328 .TP 329 \fB\-\-status\fR 330 Show the total number of messages: 331 .br 332 [new][unread][unread answers to marked][total] 333 .TP 334 \fB\-\-status\fR folder[/subfolder] 335 Show the total number of messages in the specified folder: 336 .br 337 [new][unread][unread answers to marked][total] 338 .TP 339 \fB\-\-status\-full\fR 340 Show the total number of messages per folder: 341 .br 342 [new][unread][unread answers to marked][total] 343 .TP 344 \fB\-\-status\-full\fR folder[/subfolder] 345 Show the total number of messages int the specified folder: 346 .br 347 [new][unread][unread answers to marked][total] 348 .TP 349 \fB\-\-statistics\fR 350 .br 351 Show session statistics. 352 .TP 353 \fB\-\-reset-statistics\fR 354 .br 355 Reset session statistics. 356 .TP 357 \fB\-\-select\fR #mh/Mailbox/inbox/123 358 .RS 0 359 .br 360 \fB\-\-select\fR file://home/johndoe/Mail/inbox/123 361 .br 362 \fB\-\-select\fR /home/johndoe/Mail/inbox/123 363 .RS 364 On startup, jump to the specified folder/message. 365 .RE 366 .TP 367 \fB\-\-online\fR 368 Start Claws Mail in (or switch to, if already running) online mode. 369 .TP 370 \fB\-\-offline\fR 371 Start Claws Mail in (or switch to, if already running) offline mode. 372 .TP 373 \fB\-\-exit\fR 374 Exit Claws Mail. 375 .TP 376 \fB\-\-debug\fR 377 For debug mode (on Windows systems output is written to a file instead 378 of standard error output, see \fBWindows only\fR on \fBFILES\fR 379 section). 380 .TP 381 \fB\-\-toggle-debug\fR 382 Toggle debug mode of the running Claws Mail instance. 383 .TP 384 \fB\-\-help\fR 385 Display the help message. 386 .TP 387 \fB\-\-version\fR 388 Display version number. 389 .TP 390 \fB\-\-version\-full\fR 391 Display version number and compiled\-in features. 392 .TP 393 \fB\-\-config\-dir\fR 394 Display the CONFIG\-DIR. 395 .TP 396 \fB\-\-alternate\-config\-dir\fR dir 397 Start Claws Mail with the configuration stored in the [dir] directory. 398 .TP 399 \fB\-\-geometry\fR [WxH][+X+Y] 400 Set initial X geometry of main window. 401 402 .SH "ENVIRONMENT" 403 .LP 404 .TP 405 \fBCLAWS_NO_CRASH\fR 406 If defined disables crash dialog (only if Claws Mail has been built with 407 crash dialog feature enabled). 408 .TP 409 \fBDISPLAY\fR 410 Default host and display number to use. 411 .TP 412 \fBETPANSERVER\fR, \fBETPANPORT\fR 413 When using a tunnel command to open server connections these temporary 414 variables are set to the server name and server port respectively in the 415 environment of the running command. 416 .TP 417 \fBGPG_AGENT_INFO\fR 418 The information to access the GPG agent if using GPG agent is enabled in 419 GPG plugin preferences (this is usually set by the agent when launched, 420 otherwise it likely means the GPG agent is not running). 421 .TP 422 \fBG_BROKEN_FILENAMES\fR 423 Assumes that filenames are in the locale encoding rather than in UTF\-8. 424 .TP 425 \fBHOME\fR 426 Full path of the user's home directory. 427 .TP 428 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLANG\fR 429 Locale to use for non\-windows systems (the first one not empty is used). 430 .TP 431 \fBPILOT_CHARSET\fR 432 If defined overrides default J\-Pilot charset (CP1252). 433 .TP 434 \fBPOSIXLY_CORRECT\fR 435 If defined regular expressions matching follows POSIX standards. 436 .TP 437 \fBSHELL\fR 438 If defined overrides default shell "sh" used by Spamassassin plugin to 439 launch spamc wrappers. 440 .TP 441 \fBSSL_CERT_DIR\fR 442 Use this CA certificates directory instead known system directories. 443 .TP 444 \fBSSL_CERT_FILE\fR 445 Use this CA certificates file instead of searching known system files. 446 .TP 447 \fBUSER\fR 448 Used to initialize default "user_id" preference in newly created accounts. 449 450 .SH "BUGS" 451 .LP 452 .TP 453 You can search for existing bugs and report new ones on Claws Mail bugzilla: 454 .br 455 <https://www.thewildbeast.co.uk/claws\-mail/bugzilla/> 456 457 .SH "COPYRIGHT" 458 .LP 459 .TP 460 1999\-2022 The Claws Mail team and Hiroyuki Yamamoto 461 .LP 462 Portions are also Copyright: 463 .br 464 (C) 2007\-2009 g10 Code GmbH 465 .br 466 (C) 1999\-2005 Nullsoft, Inc. 467 .br 468 (C) 1991\-1993, 1996\-2000, 2001 Free Software Foundation, Inc. 469 .br 470 (C) 2001 Thomas Link, Hiroyuki Yamamoto 471 .br 472 (C) 1995\-1997 Peter Mattis and Spencer Kimball 473 .br 474 (C) 1995\-1997 Peter Mattis, Spencer Kimball, Josh MacDonald 475 .br 476 (C) 1997\-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org> 477 .br 478 (C) 1999\-2003 Michael Natterer <mitch@gimp.org> 479 .br 480 (C) 2000 Evan Martin 481 .br 482 (C) 1998 Lars Hamann and Stefan Jeske 483 .br 484 (C) 2005, 2006, 2007, 2009 GNOME Foundation 485 .br 486 (C) 2004\-2006 Christian Hammond 487 .br 488 (C) 2003\-2004 Pawel Salek 489 .br 490 (C) 2001, 2002 \- DINH Viet Hoa 491 .br 492 (C) 1999\-2000, Gael Roualland <gael.roualland@iname.com> 493 .br 494 (C) 1998\-2002 Sendmail, Inc. 495 .br 496 (C) 2007\-2008 Juha Kautto (juha at xfce.org) 497 .br 498 (C) 1994\-2002 World Wide Web Consortium 499 .br 500 (C) 1999 Graham Davison 501 .br 502 (C) 1999 Eric Busboom 503 .br 504 (C) 2000, Eric Busboom, http://www.softwarestudio.org 505 .br 506 (C) 2002\-2007 Randall Hand <yerase@yerot.com> 507 .br 508 (C) 2001 by Werner Koch <dd9jn@gnu.org> 509 .br 510 (C) 2004 Apache Software Foundation 511 .br 512 (C) 2008 Mikkel Kamstrup Erlandsen 513 .br 514 (C) 2002 Red Hat, Inc.; Copyright 1998, 2001 Tim Janik 515 .br 516 (C) 2008\-2009 Christian Hammond, David Trowbridge 517 .br 518 (C) 2003\-2005 Lars Lindner <lars.lindner@gmx.net> 519 .br 520 (C) 2004,2005 Nathan J. Conrad <t98502@users.sourceforge.net> 521 .br 522 (C) 2004 Karl Soderstrom <ks@xanadunet.net> 523 .br 524 (C) 2000 Helix Code, Inc. (www.helixcode.com) 525 526 .SH "LICENSE" 527 .LP 528 .TP 529 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 530 .TP 531 See COPYING file on toplevel distribution directory for more license details. 532 533 .SH "AUTHORS" 534 .LP 535 .TP 536 .I "The Claws Mail Team" 537 .LP 538 .RS 4 539 Holger Berndt <berndth@users.sf.net> 540 .br 541 Tristan Chabredier <wwp@claws\-mail.org> 542 .br 543 Darko Koruga <darko@users.sf.net> 544 .br 545 Ricardo Mones Lastra <ricardo@mones.org> 546 .br 547 Paul Mangan <paul@claws\-mail.org> 548 .br 549 Salvatore De Paolis <iwkse@claws\-mail.org> 550 .br 551 Michael Rasmussen <mir@datanom.net> 552 .RE 553 554 .TP 555 .I "Previous team members" 556 .LP 557 .RS 4 558 Ho\(`a Vi\(^et Dinh, Keith Edmunds, Match Grun, Melvin Hadasht, 559 Oliver Haertel, Christoph Hohmann, Alfons Hoogervorst, Andrej Kacian, 560 Werner Koch, Charles Lehner, Colin Leroy, Thorsten Maerz, Pawel Pekala, 561 Leandro A. F. Pereira, Luke Plant, Martin Schaaf, Carsten Schurig, 562 Fabien Vantard, Sergey Vlasov and Hiroyuki Yamamoto. 563 .RE 564 565 .SH "SEE ALSO" 566 .LP 567 .TP 568 Claws Mail Homepage 569 <https://www.claws\-mail.org> 570 .TP 571 Claws Mail frequently asked questions 572 <https://www.claws\-mail.org/faq> 573 .TP 574 Claws Mail online manual 575 <https://www.claws\-mail.org/manual> 576 .TP 577 Claws Mail plugins 578 <https://www.claws\-mail.org/plugins.php> 579 .TP 580 \fIX\fR(7), \fIxwininfo\fR(1). 581