{
    "content": [
        {
            "type": "text",
            "text": "# ftpmail (man)\n\n## NAME\n\nftpmail - FIFO-based Perl script for sending email based on proftpd TransferLog\n\n## SYNOPSIS\n\nftpmail  [  --help  ]  [ --fifo fifo-path ] [ --from email-address ] [ --log xferlog-file ] [\n--recipient email-address ] [ --subject email-subject ] [ --smtp-server  server-address  ]  [\n--attach-file  ]  [  --auth smtp-auth-info-file ] [ --ignore-users regex-pattern ] [ --watch-\nusers regex-pattern ]\n\n## DESCRIPTION\n\nftpmail is a Perl script designed to read ProFTPD's TransferLog log entries, watching for up‐\nloads,  and to send an automatic email notification when uploads occur.  To use ftpmail , you\nconfigure your proftpd daemon to write its TransferLog to a FIFO; the ftpmail  program  is  a\nFIFO reading program which then processes those log messages.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (1 subsections)\n- **FILES** (1 subsections)\n- **AUTHORS** (1 subsections)\n- **SEE ALSO** (3 subsections)\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "ftpmail",
        "section": "",
        "mode": "man",
        "summary": "ftpmail - FIFO-based Perl script for sending email based on proftpd TransferLog",
        "synopsis": "ftpmail  [  --help  ]  [ --fifo fifo-path ] [ --from email-address ] [ --log xferlog-file ] [\n--recipient email-address ] [ --subject email-subject ] [ --smtp-server  server-address  ]  [\n--attach-file  ]  [  --auth smtp-auth-info-file ] [ --ignore-users regex-pattern ] [ --watch-\nusers regex-pattern ]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "",
                "long": "--attach-file",
                "arg": null,
                "description": "If used, this will cause a copy of the uploaded file to be included, as an at‐ tachment, in the generated email. --auth smtp-auth-info-file Configures the path to a file containing SMTP authentication information. The configured file should look like this: user username password password --fifo fifo-path Indicates the path to the FIFO to which proftpd is writing its TransferLog. That is, this is the path that you used for the TransferLog directive in your proftpd.conf. This parameter is REQUIRED. --from email-address Specifies the email address to use in the From email header. This parameter is REQUIRED. --ignore-users regex-pattern Specifies a Perl regular expression. If the uploading user name matches this regular expression, then an email notification is NOT sent; otherwise, an email is sent. --log xferlog-path Since this script reads the TransferLog using FIFOs, the actual TransferLog file is not written by default. Use this option to write the normal TransferLog file, in addition to watching for uploads. --recipient email-address Specifies an email address to which to send an email notification of the upload. This option can be used multiple times to specify multiple recipients. AT LEAST ONE recipient is REQUIRED. --smtp-server server-address Specifies the SMTP server to which to send the email. This parameter is RE‐‐ QUIRED. --subject subject Specify a custom Subject email header for the email sent. The default Subject is: User '$user' uploaded file '$file' via FTP --watch-users regex-pattern Specifies a Perl regular expression. If the uploading user name matches this regular expression, then an email notification is sent; otherwise, no email is sent."
            }
        ],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "--attach-file",
                        "lines": 47,
                        "long": "--attach-file"
                    }
                ]
            },
            {
                "name": "FILES",
                "lines": 1,
                "subsections": [
                    {
                        "name": "/var/log/xferlog",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "AUTHORS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "http://www.proftpd.org/credits.html",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "SEE ALSO",
                "lines": 1,
                "subsections": [
                    {
                        "name": "proftpd(8), xferlog(5)",
                        "lines": 1
                    },
                    {
                        "name": "http://www.proftpd.org/",
                        "lines": 1
                    },
                    {
                        "name": "http://www.proftpd.org/lists.html",
                        "lines": 5
                    }
                ]
            }
        ],
        "sections": {
            "NAME": {
                "content": "ftpmail - FIFO-based Perl script for sending email based on proftpd TransferLog\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "ftpmail  [  --help  ]  [ --fifo fifo-path ] [ --from email-address ] [ --log xferlog-file ] [\n--recipient email-address ] [ --subject email-subject ] [ --smtp-server  server-address  ]  [\n--attach-file  ]  [  --auth smtp-auth-info-file ] [ --ignore-users regex-pattern ] [ --watch-\nusers regex-pattern ]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "ftpmail is a Perl script designed to read ProFTPD's TransferLog log entries, watching for up‐\nloads,  and to send an automatic email notification when uploads occur.  To use ftpmail , you\nconfigure your proftpd daemon to write its TransferLog to a FIFO; the ftpmail  program  is  a\nFIFO reading program which then processes those log messages.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "--help      Display a short usage description, including all available options.\n",
                "subsections": [
                    {
                        "name": "--attach-file",
                        "content": "If  used,  this  will cause a copy of the uploaded file to be included, as an at‐\ntachment, in the generated email.\n\n--auth smtp-auth-info-file\nConfigures the path to a file containing SMTP  authentication  information.   The\nconfigured file should look like this:\nuser      username\npassword  password\n\n--fifo fifo-path\nIndicates the path to the FIFO to which proftpd is writing its TransferLog.  That\nis, this is the path  that  you  used  for  the  TransferLog  directive  in  your\nproftpd.conf.  This parameter is REQUIRED.\n\n--from email-address\nSpecifies  the  email address to use in the From email header.  This parameter is\nREQUIRED.\n\n--ignore-users regex-pattern\nSpecifies a Perl regular expression.  If the uploading  user  name  matches  this\nregular  expression,  then an email notification is NOT sent; otherwise, an email\nis sent.\n\n--log xferlog-path\nSince this script reads the TransferLog using FIFOs, the actual TransferLog  file\nis not written by default.  Use this option to write the normal TransferLog file,\nin addition to watching for uploads.\n\n--recipient email-address\nSpecifies an email address to which to send an email notification of the  upload.\nThis  option can be used multiple times to specify multiple recipients.  AT LEAST\nONE recipient is REQUIRED.\n\n--smtp-server server-address\nSpecifies the SMTP server to which to send the  email.   This  parameter  is  RE‐‐\nQUIRED.\n\n--subject subject\nSpecify  a  custom  Subject email header for the email sent.  The default Subject\nis:\nUser '$user' uploaded file '$file' via FTP\n\n--watch-users regex-pattern\nSpecifies a Perl regular expression.  If the uploading  user  name  matches  this\nregular  expression,  then  an email notification is sent; otherwise, no email is\nsent.\n",
                        "long": "--attach-file"
                    }
                ]
            },
            "FILES": {
                "content": "",
                "subsections": [
                    {
                        "name": "/var/log/xferlog",
                        "content": ""
                    }
                ]
            },
            "AUTHORS": {
                "content": "ProFTPD is written and maintained by a number  of  people,  full  credits  can  be  found  on",
                "subsections": [
                    {
                        "name": "http://www.proftpd.org/credits.html",
                        "content": ""
                    }
                ]
            },
            "SEE ALSO": {
                "content": "",
                "subsections": [
                    {
                        "name": "proftpd(8), xferlog(5)",
                        "content": "Full   documentation   on   ProFTPD,  including  configuration  and  FAQs,  is  available  at"
                    },
                    {
                        "name": "http://www.proftpd.org/",
                        "content": "For     help/support,     try     the     ProFTPD     mailing     lists,     detailed      on"
                    },
                    {
                        "name": "http://www.proftpd.org/lists.html",
                        "content": "Report bugs at http://bugs.proftpd.org/\n\n\n\nMarch 2011                                   ftpmail(1)"
                    }
                ]
            }
        }
    }
}