| README.mdView |
|---|
| 1 … | +# ggscrape(1) |
| 2 … | + |
| 3 … | +Download emails from a Google Group. Rescue your archives. |
| 4 … | + |
| 5 … | +## Usage |
| 6 … | + |
| 7 … | +`ggscrape <group_id> test` |
| 8 … | +check if you have permission |
| 9 … | + |
| 10 … | +`ggscrape <group_id> topics` |
| 11 … | +get a list of topics |
| 12 … | + |
| 13 … | +`ggscrape <group_id> messages <topic_id>` |
| 14 … | +get a list of messages in a thread |
| 15 … | + |
| 16 … | +`ggscrape <group_id> download <dest_dir>` |
| 17 … | +download emails! :) |
| 18 … | + |
| 19 … | +### Options |
| 20 … | + |
| 21 … | +`-c, --cookie <cookie>` |
| 22 … | +Use the given cookie string. Needed to access private groups. |
| 23 … | + |
| 24 … | +`-b, --begin <topicnum>` |
| 25 … | +Topic number at which to begin downloading |
| 26 … | + |
| 27 … | +`-e, --end <topicnum>` |
| 28 … | +Topic number at which to stop downloading |
| 29 … | + |
| 30 … | +`-l, --ln <ln_dir>` |
| 31 … | +Hard link email files into this directory. Useful for setting to a Maildir |
| 32 … | +directory, so that your local mail server can move the emails from there but |
| 33 … | +ggscrape will still know it downloaded them in the main `<dest_dir>` (in case |
| 34 … | +ggscrape is interrupted and you have to restart it.) |
| 35 … | + |
| 36 … | +### Environmental variables |
| 37 … | + |
| 38 … | +`GG_COOKIE` |
| 39 … | +equivalent to `--cookie` |
| 40 … | + |
| 41 … | +## License |
| 42 … | + |
| 43 … | +Copyright (c) 2014 Charles Lehner |
| 44 … | + |
| 45 … | +Permission is hereby granted, free of charge, to any person obtaining a copy of |
|
| 46 … | +this software and associated documentation files (the “Software”), to deal in |
| 47 … | +the Software without restriction, including without limitation the rights to |
| 48 … | +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
| 49 … | +the Software, and to permit persons to whom the Software is furnished to do so, |
| 50 … | +subject to the following conditions: |
| 51 … | + |
| 52 … | +The above copyright notice and this permission notice shall be included in all |
| 53 … | +copies or substantial portions of the Software. |
| 54 … | + |
| 55 … | +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 56 … | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
| 57 … | +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
| 58 … | +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
| 59 … | +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
| 60 … | +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |