claws-mail(1)

1CLAWS MAIL(1)                    User Manuals                    CLAWS MAIL(1)
2
3
4

NAME

6       Claws Mail - a GTK+ based fast email and news client
7
8

SYNOPSIS

10       claws-mail [options]
11
12

DESCRIPTION

14       Claws  Mail is an email client (and news reader) based on GTK+, running
15       on the X Window System, and aiming for:
16              · Quick response
17              · Graceful, and sophisticated interface
18              · Easy configuration, intuitive operation
19              · Abundant features
20
21       Currently implemented features include:
22              · POP3 support
23              · IMAP4rev1 support
24              · integrated NetNews client
25              · unlimited multiple account handling
26              · thread display
27              · filtering
28              · MIME (attachments)
29              · built-in image view
30              · X-Face and (colour) Face support
31              · multiple MH folder support
32              · mbox importing / exporting
33              · external editor support
34              · message queueing
35              · automatic mail checking
36              · draft message function
37              · template function
38              · line-wrapping
39              · clickable URI
40              · XML-based address book
41              · LDAP, vCard, and JPilot support
42              · newly arrived and unread message management
43              · Mew/Wanderlust-like key bind
44              · printing
45              · APOP authentication support
46              · SMTP AUTH support
47              · SSL support (POP3, SMTP, IMAP4rev1)
48              · IPv6 support
49              · drag & drop (partially implemented)
50              · GnuPG support
51              · automake + autoconf support
52              · internationalization of UI messages by gettext
53              · support of many code sets, including UTF-8 (Unicode)
54              · support for plugins
55
56       This list is not complete.
57
58

OPTIONS

60        --compose [address]
61        --compose-from-file file
62        --subscribe uri
63        --attach file1 [file2]...
64        --insert file1 [file2]...
65        --receive
66        --receive-all
67        --cancel-receiving
68        --cancel-sending
69        --send
70        --status
71        --status folder[/subfolder]
72        --status-full
73        --statistics
74        --reset-statistics
75        --select [#mh/mailbox/]folder[/msg|/msgid]
76        --online
77        --offline
78        --exit
79        --debug
80        --toggle-debug
81        --help
82        --version
83        --version-full
84        --config-dir
85        --alternate-config-dir directory
86        --geometry WxH+X+Y
87
88

FILES

90       $HOME/Mail
91              Default directory for mail storage.
92
93       $PREFIX/share/claws-mail
94              Global program directory.
95
96       $PREFIX/share/claws-mail/manual
97              Manual files in HTML, PDF, PostScript and plain text format.
98
99       $PREFIX/share/claws-mail/themes
100              Global themes directory.
101
102       $PREFIX/lib/claws-mail/plugins
103              Directory for plugins.
104
105       $PREFIX/include/claws-mail
106              Directory for header files.
107
108       $HOME/.claws-mail
109              Default directory for user's configuration files directory.
110
111       $HOME/.claws-mail/addrbook/*
112              Addressbook files.
113
114       $HOME/.claws-mail/autofaces/*
115              Automatic Faces and X-Faces files for accounts.
116
117       $HOME/.claws-mail/certs/*
118              SSL certificates received from mail servers.
119
120       $HOME/.claws-mail/tagsdb
121              Tags directory.
122
123       $HOME/.claws-mail/templates
124              User-defined templates directory.
125
126       $HOME/.claws-mail/themes
127              User's themes directory.
128
129       $HOME/.claws-mail/accountrc
130              Configuration for account(s).
131
132       $HOME/.claws-mail/actionsrc
133              User-defined custom actions.
134
135       $HOME/.claws-mail/addrbook/attributesrc
136              User-defined address book custom attributes.
137
138       $HOME/.claws-mail/claws.log
139              Claws Mail logfile.
140
141       $HOME/.claws-mail/clawsrc
142              Main configuration file.
143
144       $HOME/.claws-mail/command_history
145              User-specified commands.
146
147       $HOME/.claws-mail/customheaderrc
148              Configuration for custom headers for sending mail.
149
150       $HOME/.claws-mail/dispheaderrc
151              Configuration for custom display of headers in message view.
152
153       $HOME/.claws-mail/extraheaderrc
154              Editable extra headers to be added to compose window combobox.
155
156       $HOME/.claws-mail/folderitemrc
157              All folders' attributes.
158
159       $HOME/.claws-mail/folderlist.xml
160              Folder hierarchy listing.
161
162       $HOME/.claws-mail/gtkrc-2.0
163              Optional GTK+ settings to be load on startup.
164
165       $HOME/.claws-mail/matcherrc
166              Filtering and Processing function configuration.
167
168       $HOME/.claws-mail/menurc
169              Menu shortcut-key configuration.
170
171       $HOME/.claws-mail/messagesearch_history
172              User-specified searches in message bodies.
173
174       $HOME/.claws-mail/quicksearch_history
175              User-specified quick-search list.
176
177       $HOME/.claws-mail/messagesearch_history
178              User-specified searches in message bodies.
179
180       $HOME/.claws-mail/summary*_history
181              User-specified searches in message list.
182
183       $HOME/.claws-mail/passwordstorerc
184              User saved passwords.
185
186       $HOME/.claws-mail/tagsrc
187              User-specified tag list.
188
189       $HOME/.claws-mail/toolbar*.xml
190              User-defined custom toolbars.
191
192       %TEMP%\claws-win32.log
193              (Windows only) Claws Mail output file when --debug  is  enabled.
194              If  %TEMP%  is not set it defaults to windows directory (usually
195              C:\Windows) or C:\ if windows directory is not available.
196
197       (Windows only) %APPDATA%\Claws-mail\claws.log
198              Claws Mail log file.
199
200

EXAMPLES

202       To run this program the standard way type:
203
204       claws-mail
205
206       Alternatively you can run it with the following options:
207
208       --compose [address]
209              To open a Compose window.
210
211       --compose-from-file file
212              Open composition window with data from the given file. Use -  as
213              file name for reading from standard input. Content format: head‐
214              ers first (To: header required) until an empty  line  is  found,
215              then mail body until end of file.
216
217       --subscribe [uri]
218              Subscribe to the given URI if possible.
219
220       --attach file1 [file2]...
221              Open composition window with specified files attached.
222
223       --insert file1 [file2]...
224              Open composition window with specified files inserted.
225
226       --compose "mailto:%t?subject=%s&cc=%c&body=%b"
227              This  syntax  can  be  used  in  web-browsers  and CLI to open a
228              pre-populated Compose window. Possible fields after the destina‐
229              tion  recipient  are: subject, from, cc, bcc, in-reply-to, body,
230              insert (insert a file in body part,  needs  an  absolute  path),
231              attach  (attach  a  file,  needs  an  absolute  path,  see also:
232              --attach).
233
234       --receive
235              Receive new messages.
236
237       --receive-all
238              Receive new messages from all accounts.
239
240       --cancel-receiving
241              Cancel receiving of messages.
242
243       --cancel-sending
244              Cancel sending of messages.
245
246       --send
247              Send all queued messages.
248
249       --status
250              Show the total number of messages:
251              [new][unread][unread answers to marked][total]
252
253       --status folder[/subfolder]
254              Show the total number of messages in the specified folder:
255              [new][unread][unread answers to marked][total]
256
257       --status-full
258              Show the total number of messages per folder:
259              [new][unread][unread answers to marked][total]
260
261       --statistics
262              Show session statistics.
263
264       --reset-statistics
265              Reset session statistics.
266
267       --select [#mh/mailbox/]folder[/msg|/msgid]
268              On startup, jumps to the specified folder/message.
269
270       --online
271              Start Claws Mail in (or switch to, if  already  running)  online
272              mode.
273
274       --offline
275              Start  Claws  Mail in (or switch to, if already running) offline
276              mode.
277
278       --help Display the help message and exit.
279
280       --exit Exit Claws Mail.
281
282       --debug
283              For debug mode (on Windows systems output is written to  a  file
284              instead of standard error output, see Windows only on FILES sec‐
285              tion).
286
287       --toggle-debug
288              Toggle debug mode of the running Claws Mail instance.
289
290       --version
291              Display version number and exit.
292
293       --version-full
294              Display version number and compiled-in features then exit.
295
296       --config-dir
297              Display the CONFIG-DIR and exit.
298
299       --alternate-config-dir [dir]
300              Start Claws Mail with the  configuration  stored  in  the  [dir]
301              directory.
302
303       --geometry WxH+X+Y
304              Set initial X geometry of main window.
305
306

ENVIRONMENT

308       CLAWS_NO_CRASH
309              If  defined  disables  crash dialog (only if Claws Mail has been
310              built with crash dialog feature enabled).
311
312       DISPLAY
313              Default host and display number to use.
314
315       ETPANSERVER, ETPANPORT
316              When using a tunnel command to  open  server  connections  these
317              temporary  variables  are set to the server name and server port
318              respectively in the environment of the running command.
319
320       GPG_AGENT_INFO
321              The information to access the GPG agent if using  GPG  agent  is
322              enabled  in  GPG  plugin preferences (this is usually set by the
323              agent when launched, otherwise it likely means the GPG agent  is
324              not running).
325
326       G_BROKEN_FILENAMES
327              Assumes that filenames are in the locale encoding rather than in
328              UTF-8.
329
330       HOME   Full path of the user's home directory.
331
332       LC_ALL, LC_CTYPE, LANG
333              Locale to use for non-windows systems (the first one  not  empty
334              is used).
335
336       PILOT_CHARSET
337              If defined overrides default J-Pilot charset (CP1252).
338
339       POSIXLY_CORRECT
340              If defined regular expressions matching follows POSIX standards.
341
342       SESSION_MANAGER
343              If  defined tries to use the Session Manager (only if Claws Mail
344              has been built with libSM feature enabled).
345
346       SHELL  If defined overrides default shell  "sh"  used  by  Spamassassin
347              plugin to launch spamc wrappers.
348
349       SSL_CERT_DIR
350              Use this CA certificates directory instead known system directo‐
351              ries.
352
353       SSL_CERT_FILE
354              Use this CA certificates file instead of searching known  system
355              files.
356
357       USER   Used to initialize default "user_id" preference in newly created
358              accounts.
359
360

BUGS

362       You can search for existing bugs and report  new  ones  on  Claws  Mail
363       bugzilla:
364              <http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
365
366

COPYRIGHT

368       1999-2020 The Claws Mail team and Hiroyuki Yamamoto
369
370       Portions are also Copyright:
371       (C) 2007-2009 g10 Code GmbH
372       (C) 1999-2005 Nullsoft, Inc.
373       (C) 1991-1993, 1996-2000, 2001 Free Software Foundation, Inc.
374       (C) 2001 Thomas Link, Hiroyuki Yamamoto
375       (C) 1995-1997 Peter Mattis and Spencer Kimball
376       (C) 1995-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
377       (C) 1997-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
378       (C) 1999-2003 Michael Natterer <mitch@gimp.org>
379       (C) 2000 Evan Martin
380       (C) 1998 Lars Hamann and Stefan Jeske
381       (C) 2005, 2006, 2007, 2009 GNOME Foundation
382       (C) 2004-2006 Christian Hammond
383       (C) 2003-2004 Pawel Salek
384       (C) 2001, 2002 - DINH Viet Hoa
385       (C) 1999-2000, Gael Roualland <gael.roualland@iname.com>
386       (C) 1998-2002 Sendmail, Inc.
387       (C) 2007-2008 Juha Kautto (juha at xfce.org)
388       (C) 1994-2002 World Wide Web Consortium
389       (C) 1999 Graham Davison
390       (C) 1999 Eric Busboom
391       (C) 2000, Eric Busboom, http://www.softwarestudio.org
392       (C) 2002-2007 Randall Hand <yerase@yerot.com>
393       (C) 2001 by Werner Koch <dd9jn@gnu.org>
394       (C) 2004 Apache Software Foundation
395       (C) 2008 Mikkel Kamstrup Erlandsen
396       (C) 2002  Red Hat, Inc.; Copyright 1998, 2001 Tim Janik
397       (C) 2008-2009  Christian Hammond, David Trowbridge
398       (C) 2003-2005  Lars Lindner <lars.lindner@gmx.net>
399       (C) 2004,2005  Nathan J. Conrad <t98502@users.sourceforge.net>
400       (C) 2004 Karl Soderstrom <ks@xanadunet.net>
401       (C) 2000 Helix Code, Inc. (www.helixcode.com)
402
403

LICENSE

405       This program is free software: you can redistribute it and/or modify it
406       under the terms of the GNU General Public License as published  by  the
407       Free  Software Foundation, either version 3 of the License, or (at your
408       option) any later version.
409
410       See COPYING file on toplevel distribution directory  for  more  license
411       details.
412
413

AUTHORS

415       The Claws Mail Team
416
417           Holger Berndt            <berndth@users.sf.net>
418           Tristan Chabredier       <wwp@claws-mail.org>
419           Andrej Kacian            <andrej@kacian.sk>
420           Darko Koruga             <darko@users.sf.net>
421           Ricardo Mones Lastra     <ricardo@mones.org>
422           Charles Lehner           <charles@claws-mail.org>
423           Colin Leroy              <colin@colino.net>
424           Paul Mangan              <paul@claws-mail.org>
425           Salvatore De Paolis      <iwkse@claws-mail.org>
426           Pawel Pekala             <cOrn@o2.pl>
427           Michael Rasmussen        <mir@datanom.net>
428
429
430       Previous team members
431
432           Hoà  Viêt  Dinh,  Keith Edmunds, Match Grun, Melvin Hadasht, Oliver
433           Haertel,  Christoph  Hohmann,  Alfons  Hoogervorst,  Werner   Koch,
434           Thorsten  Maerz,  Leandro A. F. Pereira, Luke Plant, Martin Schaaf,
435           Carsten  Schurig,  Fabien  Vantard,  Sergey  Vlasov  and   Hiroyuki
436           Yamamoto.
437
438