bg.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH FETCHYAHOO 1 "September 20, 2002"
.SH NAME
fetchyahoo \- retrieve mail from Yahoo!'s webmail service
.SH SYNOPSIS
.B fetchyahoo
.RI [ options ]
.SH DESCRIPTION
.PP
\fBFetchYahoo\fP is a Perl script that downloads mail from a Yahoo!
account to a local mail spool. It is meant to replace fetchmail for
people using Yahoo! mail since Yahoo!'s POP service no longer free. It
downloads messages to a local mail spool, including all parts and
attachments. It then deletes messages unless requested not to. It can
also optionally forward messages to a specified e-mail address and
repeat with a given interval.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`\-').
A summary of options is included below.  For additional information,
see the HTML documentation.
.TP
.B \-\-help
Show summary of options.
.TP
.B \-\-version
Show version of program.
.TP
.B \-\-quiet, \-\-noquiet
Suppress (or do not suppress) non-error messages.
.TP
.B \-\-noerrors, \-\-errors
Suppress (or do not suppress) error messages.
.TP
.B \-\-configfile=CONFIG-FILE
Use CONFIG-FILE as the configuration file.
.TP
.B \-\-username=USERNAME
Use USERNAME as the Yahoo! login.
.TP
.B \-\-password=PASSWORD
Use PASSWORD as your Yahoo! password.
.TP
.B \-\-spoolfile=SPOOL
Specify SPOOL as the file to spool messages to; if \-\-pipe is also
specified, SPOOL is a program that accepts messages from standard
input (such as \fBprocmail\fP).
.TP
.B \-\-https \-\-nohttps
Use insecure plaintext or secure HTTPS to login (default is to use HTTPS).
.TP
.B \-\-append
Append messages to the SPOOL (the default behavior).
.TP
.B \-\-pipe
Pipe messages to the program SPOOL, instead of appending to SPOOL.
.TP
.B \-\-overwrite
Overwrite SPOOL, instead of appending to it.
.TP
.B \-\-folder=FOLDER
Specify the folder on Yahoo! to download messages from.  (Default is Inbox.)
.TP
.B \-\-newonly
Only download new messages.  (The default is to download all
messages.)
.TP
.B \-\-allmsgs
Download all messages.
.TP
.B \-\-nodelete, \-\-delete
Do not (or do) delete messages after they are downloaded.
.TP
.B \-\-nodownload, \-\-download
Do not download messages; however, they will be deleted unless
\fB\-\-nodelete\fP is also specified.  (\-\-download is the default.)
.TP
.B \-\-listmessages, \-\-nolistmessages
List messages in mail folder. (\-\-nolistmessages is the default.)
.TP
.B \-\-onlylistmessages
Only list messages in mail folder. This combines
\fB\-\-listmessages\fP, \fB\-\-nodownload\fP and \fB\-\-nodelete\fP
.TP
.B \-\-emptybulk
Empty Bulk folder before downloading messages.
.TP
.B \-\-emptytrashbefore
Empty trash before downloading messages.
.TP
.B \-\-emptytrashafter
Empty trash after downloading messages.
.TP
.B \-\-noempty
Do not empty trash or bulk.  (Default)
.TP
.B \-\-leaveunread
Leave the messages marked as unread on the server.
.TP
.B \-\-markread
Mark the messages downloaded as read.  (Default)
.TP
.B \-\-repeatinterval=N
Check for mail every N minutes.
.TP
.B \-\-statusonly, \-\-nostatusonly
Just get the number of messages. (\-\-nostatusonly is the default.)
.TP
.B \-\-getexternal, \-\-nogetexternal
Retrieve messages from external mailboxes also. (\-\-nogetexternal is the default.)
.TP
.B \-\-externalmailboxes=boxes,list
retrieve messages from only this comma-separated list of external mailboxes
.TP
.B \-\-maxmessages=N
Maximum number of messages to download (default is 100). Setting this to over 100 may cause problems.
.TP
.B \-\-warninglevel=N
Warn if more than N% of storage quota is used. Never warn if N=0 (default is 0).
.TP
.B \-\-nofromline, \-\-includefromline
Omit (or include) the leading "From " in messages appended or piped. (\-\-includefromline is the default.)
.TP
.B \-\-logout, \-\-nologout
Log out (or do not log out) of Yahoo! on exit. (\-\-nologout is the default.)
.TP
.B \-\-proxyhost=s
Hostname to use for proxy (default is off).
.TP
.B \-\-proxyport=N
Port to use for proxy (default is 80).
.TP
.B \-\-proxyuser=s
Username to use for proxy authentication (default is no authentication)
.TP
.B \-\-proxypass=s
Password to use for proxy authentication (default is no authentication)
.TP
.B \-\-imaphost=s
Hostname to use for IMAP (default is off).
.TP
.B \-\-imapport=N
Port to use for IMAP (default is 143).
.TP
.B \-\-imapuser=s
Username to use for IMAP authentication (no default)
.TP
.B \-\-imappass=s
Password to use for IMAP authentication (no default)
.TP
.B \-\-imapmailbox=s
IMAP mailbox to use (default is INBOX)
.TP
.B \-\-repeatinterval=N
Check for mail every N minutes (daemon mode).
.TP
.B \-\-md5hex
Print the MD5 hex hash value of a password entered interactively
.TP
.SH FILES
.TP
/etc/fetchyahoorc
.TP
$HOME/.fetchyahoorc
Configuration files for FetchYahoo.  An example configuration file is
located in /usr/share/doc/fetchyahoo/examples/
.SH "SEE ALSO"
procmail(1)
.BR
/usr/share/doc/fetchyahoo/index.html
.SH AUTHOR
FetchYahoo was written by Ravi Ramkissoon <ravi_ramkissoon@yahoo.com>.
This manual page was written by Chris Lawrence <lawrencc@debian.org>,
for the Debian GNU/Linux system (but may be used by others).