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        --search folder type request [recursive]
70        --send
71        --status
72        --status folder[/subfolder]
73        --status-full
74        --status-full folder[/subfolder]
75        --statistics
76        --reset-statistics
77        --select [#mh/mailbox/]folder[/msg|/msgid], a file:// uri or an  abso‐
78       lute path
79        --online
80        --offline
81        --exit
82        --debug
83        --toggle-debug
84        --help
85        --version
86        --version-full
87        --config-dir
88        --alternate-config-dir directory
89        --geometry [WxH][+X+Y]
90
91

FILES

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

EXAMPLES

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

ENVIRONMENT

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

BUGS

378       You  can  search  for  existing  bugs and report new ones on Claws Mail
379       bugzilla:
380              <https://www.thewildbeast.co.uk/claws-mail/bugzilla/>
381
382

COPYRIGHT

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

LICENSE

421       This program is free software: you can redistribute it and/or modify it
422       under  the  terms of the GNU General Public License as published by the
423       Free Software Foundation, either version 3 of the License, or (at  your
424       option) any later version.
425
426       See  COPYING  file  on toplevel distribution directory for more license
427       details.
428
429

AUTHORS

431       The Claws Mail Team
432
433           Holger Berndt            <berndth@users.sf.net>
434           Tristan Chabredier       <wwp@claws-mail.org>
435           Darko Koruga             <darko@users.sf.net>
436           Ricardo Mones Lastra     <ricardo@mones.org>
437           Paul Mangan              <paul@claws-mail.org>
438           Salvatore De Paolis      <iwkse@claws-mail.org>
439           Michael Rasmussen        <mir@datanom.net>
440
441
442       Previous team members
443
444           Hoà Viêt Dinh, Keith Edmunds, Match Grun,  Melvin  Hadasht,  Oliver
445           Haertel, Christoph Hohmann, Alfons Hoogervorst, Andrej Kacian, Wer‐
446           ner Koch,  Charles  Lehner,  Colin  Leroy,  Thorsten  Maerz,  Pawel
447           Pekala,  Leandro  A. F. Pereira, Luke Plant, Martin Schaaf, Carsten
448           Schurig, Fabien Vantard, Sergey Vlasov and Hiroyuki Yamamoto.
449
450