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)  (when
54              using libjconv)
55              · support for plugins
56
57       This list is not complete.
58
59

OPTIONS

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

FILES

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

EXAMPLES

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

ENVIRONMENT

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

BUGS

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

COPYRIGHT

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

LICENSE

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

AUTHORS

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