Skip to main content

Backup PTT mail

Project description

一個用來備份 PTT 站內信的 CLI 工具。不會再因為站內信打包失敗而把信箱塞爆一整個禮拜。


  • 使用 SSH 連上 PTT,再一頁頁爬

  • 下載回來的檔案為 Big5-UAO 編碼

  • 支援自動換行、寬度大於 80 的文章

  • 支援上色、閃爍、雙色字


> NOTE: This package requires python 3.7+

From PYPI:

pip install ptt-mail-backup


執行 ptt-mail-backup ...:

usage: ptt-mail-backup [-h] [-u USER] [-p PASSWORD] [-d DEST] [-v]
                       [-f FILENAME_FORMAT] (-r START END | --all)

Backup PTT mail.

optional arguments:
  -h, --help            show this help message and exit
  -u USER, --user USER  username, otherwise prompt for the value.
                        password, otherwise prompt for the value.
  -d DEST, --dest DEST  save to dest. Default: '.'
  -v, --verbose         print verbose message.
                        filename format. Default: '{index}. [{board}] {title}
                        [{author}] ({time:%Y%m%d%H%M%S}).ans'
  -r START END, --range START END
                        specify a range (inclusive). Negative values and zeros
                        are allowed, they are treated as (last_index + value)
                        i.e. --range 0 0 would download the last mail. This
                        option could be used multiple times.
  --all                 download all

或是 python -m ptt_mail_backup ...


下載所有信件到 2018-06-12 資料夾:

ptt-mail-backup -d 2018-06-12 --all


ptt-mail-backup -r -9 0

從 CLI 傳入使用者名稱、密碼,並下載最舊的信件:

ptt-mail-backup -u myusername -p mypassword -r 1 1


The distributed package includes a branch of pyte which supports blinking text. pyte is licensed under LGPL v3 and ptt_mail_backup itself is licensed under MIT.


  • 0.6.0 (Feb 28, 2024)

    • Bump dependencies.

    • Change: require python 3.7+.

    • Fix: issues with wcwidth 0.2.13.

  • 0.5.0 (Feb 3, 2024)

    • Bump dependencies.

    • Fix: hang while refreshing screen.

  • 0.4.0 (Jun 30, 2021)

    • Bump dependencies

    • Fix: hang while fetching index

  • 0.3.0 (Aug 26, 2019)

    • Breaking: stop relying on the footer information.

    • Fix: unable to download articles including **s or **n.

  • 0.2.3 (Aug 21, 2019)

    • Fix: handle login views.

  • 0.2.2 (Nov 18, 2018)

    • Fix: Support Python 3.7.

  • 0.2.1 (Jul 25, 2018)

    • Fix: handle mailbox is full message.

    • Fix: handle add new board to favorite message.

  • 0.2.0 (Jun 22, 2018)

    • The distributed package now includes pyte with blinking text support.

    • Add: a better way to get full title.

    • Add: allow multiple --range.

    • Fix: handle password error.

    • Fix: handle article recovery screen.

    • Fix: handle password attack alert screen.

  • 0.1.1 (Jun 12, 2018)

    • Fix: missing deps.

  • 0.1.0 (Jun 12, 2018)

    • First release.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ptt-mail-backup-0.6.0.tar.gz (35.8 kB view hashes)

Uploaded Source

Built Distribution

ptt_mail_backup-0.6.0-py3-none-any.whl (38.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page