File: getmails.1

package info (click to toggle)
getmail 5.13-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,012 kB
  • sloc: python: 6,044; sh: 58; makefile: 18
file content (63 lines) | stat: -rw-r--r-- 1,844 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.TH getmails "1" "December 2017" "getmail" "User Commands"
.SH NAME
getmails \- wrapper for getmail to access multiple mailboxes
.SH SYNOPSIS
.B getmails
[\fB-p\fR] 
[\fIOPTION\fR] ...
.SH DESCRIPTION
.\" Add any additional description here
.PP
.B getmails
is a wrapper script for
.B getmail 
to retrieve messages with multiple independent configuration files
.I ~/.getmail/config/*
instead of a single
.I ~/.getmailrc
file.

The configuration file name can be any arbitrary names.  It's good idea to use
the corresponding email address as its name since it is the most intuitive
choice.  For example 
.I ~/.getmail/config/foo@example.org .

To disable operation for an email account temporary, rename its configuration
file to the hidden file such as
.I ~/.getmail/config/.foo@example.org .
Then, it is ignored as the configuration file.

For the robust operation, the editor generated files such as
.I ~/.getmail/config/foo~
,
.I ~/.getmail/config/#foo#
,
.I ~/.getmail/config/foo.swp
, and
.I ~/.getmail/config/foo.bak
are also ignored as the configuration file.

When there are multiple email configuration files, 
.B getmails
retrieves mails sequentially.  But adding an optional option
.B -p
before other options makes
.B getmails
to invoke
.B getmail
with each configuration file in parallel to retrieve mails.

The option provided as \fIOPTION\fR is passed to \fBgetmail\fR as is.  The use
of the \fB-r\fR option is not a good idea.

The existence of 
.I ~/.getmail/stop 
can prevent this wrapper script to execute \fBgetmail\fR.

.SH "REPORTING BUGS"
Report bugs to the getmail debian package if bugs are in this wrapper script.
.SH COPYRIGHT
Copyright 2011-2017 Osamu Aoki
.br
This is free software; see the file COPYING for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.