1ftpmail(1)                  General Commands Manual                 ftpmail(1)
2
3
4

NAME

6       ftpmail  -  FIFO-based  Perl  script for sending email based on proftpd
7       TransferLog
8

SYNOPSIS

10       ftpmail [ --help ] [ --fifo fifo-path ]  [  --from  email-address  ]  [
11       --log  xferlog-file  ] [ --recipient email-address ] [ --subject email-
12       subject ] [ --smtp-server server-address ] [ --attach-file ]  [  --auth
13       smtp-auth-info-file  ] [ --ignore-users regex-pattern ] [ --watch-users
14       regex-pattern ]
15

DESCRIPTION

17       ftpmail is a Perl script designed to  read  ProFTPD's  TransferLog  log
18       entries, watching for uploads, and to send an automatic email notifica‐
19       tion when uploads occur.  To use ftpmail , you configure  your  proftpd
20       daemon  to  write  its  TransferLog to a FIFO; the ftpmail program is a
21       FIFO reading program which then processes those log messages.
22

OPTIONS

24       --help      Display a short usage description, including all  available
25                   options.
26
27       --attach-file
28                   If  used, this will cause a copy of the uploaded file to be
29                   included, as an attachment, in the generated email.
30
31       --auth smtp-auth-info-file
32                   Configures the path to a file containing  SMTP  authentica‐
33                   tion  information.   The  configured  file should look like
34                   this:
35                          user      username
36                          password  password
37
38       --fifo fifo-path
39                   Indicates the path to the FIFO to which proftpd is  writing
40                   its  TransferLog.   That is, this is the path that you used
41                   for the TransferLog directive in your  proftpd.conf.   This
42                   parameter is REQUIRED.
43
44       --from email-address
45                   Specifies  the  email  address  to  use  in  the From email
46                   header.  This parameter is REQUIRED.
47
48       --ignore-users regex-pattern
49                   Specifies a Perl regular expression.  If the uploading user
50                   name matches this regular expression, then an email notifi‐
51                   cation is NOT sent; otherwise, an email is sent.
52
53       --log xferlog-path
54                   Since this script reads the TransferLog  using  FIFOs,  the
55                   actual  TransferLog  file  is  not written by default.  Use
56                   this option to write the normal TransferLog file, in  addi‐
57                   tion to watching for uploads.
58
59       --recipient email-address
60                   Specifies  an email address to which to send an email noti‐
61                   fication of the upload.  This option can be  used  multiple
62                   times to specify multiple recipients.  AT LEAST ONE recipi‐
63                   ent is REQUIRED.
64
65       --smtp-server server-address
66                   Specifies the SMTP server to which to send the email.  This
67                   parameter is REQUIRED.
68
69       --subject subject
70                   Specify  a  custom Subject email header for the email sent.
71                   The default Subject is:
72                          User '$user' uploaded file '$file' via FTP
73
74       --watch-users regex-pattern
75                   Specifies a Perl regular expression.  If the uploading user
76                   name matches this regular expression, then an email notifi‐
77                   cation is sent; otherwise, no email is sent.
78

FILES

80       /var/log/xferlog
81

AUTHORS

83       ProFTPD is written and maintained by a number of people,  full  credits
84       can be found on http://www.proftpd.org/credits.html
85

SEE ALSO

87       proftpd(8), xferlog(5)
88
89       Full  documentation  on  ProFTPD,  including configuration and FAQs, is
90       available at http://www.proftpd.org/
91
92       For  help/support,  try  the  ProFTPD  mailing   lists,   detailed   on
93       http://www.proftpd.org/lists.html
94
95       Report bugs at http://bugs.proftpd.org/
96
97
98
99                                  March 2011                        ftpmail(1)
Impressum