.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CLAWS-MAIL-NEWMAIL-PLUGIN 7"
.TH CLAWS-MAIL-NEWMAIL-PLUGIN 7 2024-02-18 4.2.0-2 "Claws Mail"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
claws\-mail\-newmail\-plugin \- message header summary to a log file
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This manual page documents briefly the \fBclaws-mail-newmail-plugin\fR
package.
.PP
This manual page was written for the Debian™ distribution because the
original program does not have a manual page.
.PP
\&\fBclaws-mail-newmail-plugin\fR is a plugin (loadable module) for the
\&\fIClaws Mail\fR mailer.
.PP
This plugin writes a summary of new mail headers and message related
values to a log file. Writing is done after sorting.
.PP
The message headers written are: \f(CW\*(C`Date:\*(C'\fR, \f(CW\*(C`Subject:\*(C'\fR, \f(CW\*(C`From:\*(C'\fR, \f(CW\*(C`To:\*(C'\fR
and \f(CW\*(C`Cc:\*(C'\fR. Additionally the message related values currently written
are the following:
.ie n .IP """Size:""" 4
.el .IP \f(CWSize:\fR 4
.IX Item "Size:"
The size of the message in bytes.
.ie n .IP """Path:""" 4
.el .IP \f(CWPath:\fR 4
.IX Item "Path:"
The full path to the message file.
.ie n .IP """Message:""" 4
.el .IP \f(CWMessage:\fR 4
.IX Item "Message:"
The number of the message.
.ie n .IP """Folder:""" 4
.el .IP \f(CWFolder:\fR 4
.IX Item "Folder:"
The folder of the message.
.SH USAGE
.IX Header "USAGE"
Before using a plugin you must instruct \fIClaws Mail\fR to load it on
startup.
.PP
For this you must go “Configuration” menu on main window toolbar, open
“Plugins...”  dialog, click on the “Load plugin...”  button and select
the plugin file, named \fBnewmail.so\fR, and press the “Open” button.
.SH FILES
.IX Header "FILES"
.IP \fI~/Mail/NewLog\fR 4
.IX Item "~/Mail/NewLog"
Default filename where header summary is written.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBclaws-mail\fR(1),
\&\fBclaws-mail-extra-plugins\fR(7).
.SH AUTHORS
.IX Header "AUTHORS"
.IP "H. Merijn Brand <h.m.brand@xs4all.nl>" 4
.IX Item "H. Merijn Brand <h.m.brand@xs4all.nl>"
Wrote the \fBclaws-mail-newmail-plugin\fR plugin.
.IP "Ricardo Mones <mones@debian.org>" 4
.IX Item "Ricardo Mones <mones@debian.org>"
Wrote this manpage for the Debian system.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright © 2006\-2020 Ricardo Mones
.PP
This manual page was written for the Debian system (but may be used by
others).
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License, Version 3 or (at your
option) any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License
can be found in \fI/usr/share/common\-licenses/GPL\fR.