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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
.\" Hey, EMACS: -*- nroff -*-
.TH GETLIVE 1 "August 1, 2012"
.SH NAME
getlive \- fetch mail from your Hotmail Live account
.SH SYNOPSIS
.B getlive
\fB--config-file\fR \fIFILE\fR [\fB--verbosity\fR \fI0..100\fR]
.B getlive
\fB--port\fR \fIport\fR [\fB--verbosity\fR \fI0..100\fR]
.SH DESCRIPTION
\fBgetlive\fP is a utility that fetches mail from your Hotmail/Windows
Live account. The mail is then presented to any filter (typically
\fBprocmail\fP) for further processing or dropping in a local mailbox.
There is a second mode of operation (indicated by the \fB--port\fR option),
that makes getlive work as a no-configuration POP3 server that relays requests
to Hotmail.
.SH OPTIONS
.TP
.B \-\-config\-file
The format for this file is listed below.
.TP
.B \-\-port
This option enables the "FreePops" mode. In this mode, no configuration is
necessary, and getlive starts a POP3 server on the port specified.
See the \fBFREEPOPS MODE\fR section for more information.
.TP
.B \-\-verbosity
Higher number corresponds to greater output as command runs.
.SH "CONFIGURATION FILE"
The configuration file takes arguments of the form option = value.
Empty lines or lines commented with # are allowed.
.TP
.B UserName
Your Hotmail username, excluding the at-sign and domain.
.TP
.B Password
Your account password, you should restrict access to your configuration file to
avoid this information being read by other users.
.TP
.B Domain
The domain for your account, defaults to \fIhotmail.com\fR.
.TP
.B Proxy
Hostname of proxy, if applicable.
.TP
.B ProxyAuth
Password for proxy, if applicable.
.TP
.B Downloaded
File that keeps track of IDs of messages that were fetched already.
Default is \fI${HOME}/.getlive.log\fR.
.TP
.B FetchOnlyUnread
If \fIYes\fR only messages that are marked unread are fetched. If set to
\fBYes\fP, \fBDownloaded\fR is ignored.
Defaults to \fINo\fR.
.TP
.B RetryLimit
Number of times to retry fetching a web page via curl. Defaults to \fI2\fR.
.TP
.B CurlBin
Command for curl. Default is \fI"curl \-k"\fR.
.TP
.B Processor
Any command taking the message in mbox format on its stdin and doing something
with it.
Default is \fI/usr/bin/procmail\fR.
.RS
.IP \(bu 2
\fI"/bin/cat \- >> FetchedMail"\fR might be used to drop directly in a mbox
file.
.IP \(bu
The distribution contains also
\fI/usr/share/doc/getlive/examples/SmtpForward.pl\fR and
\fI/usr/share/doc/getlive/examples/SmtpAuthForward.pl\fR These can be used to
forward the messages to an SMTP server.
.RE
.TP
.B Folder
Folder that needs to be fetched.
This option must be repeated for each folder you want to fetch. If this option
is not present then all folders will be fetched.
.TP
.B MarkRead
Whether the message will be marked read after being downloaded.
Note that a message never gets marked in any way if it's not downloaded due to
it being already in the \fBDownloaded\fR file.
Defaults to \fINo\fR.
.TP
.B Delete
Whether the message will be deleted after being downloaded.
Note that a message never gets deleted if it's not downloaded due to it being
already in the \fBDownloaded\fR file.
Defaults to \fINo\fR.
.TP
.B MoveToFolder
Folder to which the message must be moved after being downloaded.
If this argument takes the form \fI@FileName\fR then the folder name is taken
from the contents of the file.
This can be used, for example, to enable a spam filter to decide to what folder
the message must be moved. That spamfilter would be invoked by the
\fBProcessor\fR option and then write a folder name (for instance \fIJunk\fR if
considered junk) to the file \fIFileName\fR.
Note that a message is not moved if it's not downloaded due to it being
already in the \fBDownloaded\fR file.
.TP
.B SkipTrash
Whether the Trash folder handling will be skipped or not.
Defaults to \fINo\fR.
.TP
.B BreakOnAlreadyDownloaded
Number of consecutive already downloaded messages after which the search will stop. Useful to avoid slowness on extremely large Downloaded files.
.SH "FREEPOPS MODE"
When using this mode, the configuration is ignored, and all configuration
values are taken from the username used to connect to the POP3 server.
The format for the username is as follows:
.B
username@hotmail.com[?Option=Value][&Option=Value][&Option=Value]
With \fIOption=Value\fR pairs from:
.RS
\fBfolder=\fR"\fIFolderName\fR" : The folder as displayed in hotmail for the
folder you want to interact with. Defaults to \fBInbox\fR.
\fBfolderid=\fR\fIN\fR: the folderid you want to interact with:
1: Inbox
2: Trash
3: Sent
5: Junk
\fBmarkread=1\fR: It will mark mails as read on your hotmail account if you
read them via the the Pop3 Server.
.RE
Note that if your mail client is configured to delete messages after download,
getlive will delete them from Hotmail.
The password passed to the POP3 server will be used to authenticate with
Hotmail.
.SH AUTHOR
getlive was written by Jos De Laender <jos.de_laender@pandora.be>.
.PP
This manual page was adapted by Tyler Trafford <ttrafford@gmail.com> and Martin
Ferrari <tincho@debian.org> from the included \fIManual\fR, for the Debian
project (but may be used by others).
|
