segfault-larch 1.0.2.3

Sign up to get free protection for your applications and to get access to all the features.
data/HISTORY ADDED
@@ -0,0 +1,44 @@
1
+ Larch History
2
+ ================================================================================
3
+
4
+ Version 1.1.0 (git)
5
+ * Mailbox and message state information is now stored in a local SQLite
6
+ database, which allows Larch to resync and resume interrupted syncs much
7
+ more quickly without having to rescan all messages. As a result, SQLite 3 is
8
+ now a dependency.
9
+ * Larch now loads config options from ~/.larch/config.yaml if it exists, or
10
+ from the file specified by the --config command-line option. This file may
11
+ contain multiple sections. If a section name is specified via the
12
+ command-line, Larch will use the options in that section for the session;
13
+ otherwise it will use the options in the "default" section. See the README
14
+ for more details.
15
+ * Folders are now copied recursively by default.
16
+ * Progress information is now displayed regularly while scanning large
17
+ mailboxes.
18
+ * Added short versions of common command-line options.
19
+ * The --fast-scan option has been removed.
20
+
21
+ Version 1.0.2 (2009-08-05)
22
+ * Fixed a bug that caused Larch to try to set the read-only \Recent flag on
23
+ the destination server.
24
+
25
+ Version 1.0.1 (2009-05-10)
26
+ * Ruby 1.9.1 support.
27
+ * Much more robust handling of unexpected server disconnects and dropped
28
+ connections.
29
+ * Added --all option to copy all folders recursively.
30
+ * Added --all-subscribed option to copy all subscribed folders recursively.
31
+ * Added --dry-run option to simulate changes without actually making them.
32
+ * Added --exclude and --exclude-file options to specify folders that should
33
+ not be copied.
34
+ * Added --ssl-certs option to specify a bundle of trusted SSL certificates.
35
+ * Added --ssl-verify option to verify server SSL certificates.
36
+ * Added a new "insane" logging level, which will output all IMAP commands and
37
+ responses to STDERR.
38
+ * Fixed excessive post-scan processing times for very large mailboxes.
39
+ * Fixed potential scan problems with very large mailboxes on certain servers.
40
+ * POSIX signals are no longer trapped on platforms that aren't likely to
41
+ support them.
42
+
43
+ Version 1.0.0 (2009-03-17)
44
+ * First release.
data/LICENSE ADDED
@@ -0,0 +1,280 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
data/README.rdoc ADDED
@@ -0,0 +1,273 @@
1
+ = Larch
2
+
3
+ Larch is a tool to copy messages from one IMAP server to another quickly and
4
+ safely. It's smart enough not to copy messages that already exist on the
5
+ destination and robust enough to deal with interruptions caused by flaky
6
+ connections or misbehaving servers.
7
+
8
+ Larch is particularly well-suited for copying email to, from, or between Gmail
9
+ accounts.
10
+
11
+ *Author*:: Ryan Grove (mailto:ryan@wonko.com)
12
+ *Version*:: 1.1.0 (git)
13
+ *Copyright*:: Copyright (c) 2009 Ryan Grove. All rights reserved.
14
+ *License*:: GPL 2.0 (http://opensource.org/licenses/gpl-2.0.php)
15
+ *Website*:: http://github.com/rgrove/larch
16
+
17
+ == Installation
18
+
19
+ Install the latest stable version of Larch via RubyGems:
20
+
21
+ gem install larch
22
+
23
+ Or you can install the latest development version from GitHub:
24
+
25
+ gem sources -a http://gems.github.com
26
+ gem install rgrove-larch
27
+
28
+ == Usage
29
+
30
+ larch [config section] [options]
31
+ larch --from <uri> --to <uri> [options]
32
+
33
+ Server Options:
34
+ --from, -f <s>: URI of the source IMAP server.
35
+ --from-folder, -F <s>: Source folder to copy from (default: INBOX)
36
+ --from-pass, -p <s>: Source server password (default: prompt)
37
+ --from-user, -u <s>: Source server username (default: prompt)
38
+ --to, -t <s>: URI of the destination IMAP server.
39
+ --to-folder, -T <s>: Destination folder to copy to (default: INBOX)
40
+ --to-pass, -P <s>: Destination server password (default: prompt)
41
+ --to-user, -U <s>: Destination server username (default: prompt)
42
+
43
+ Sync Options:
44
+ --all, -a: Copy all folders recursively
45
+ --all-subscribed, -s: Copy all subscribed folders recursively
46
+ --exclude <s+>: List of mailbox names/patterns that shouldn't be
47
+ copied
48
+ --exclude-file <s>: Filename containing mailbox names/patterns that
49
+ shouldn't be copied
50
+
51
+ General Options:
52
+ --config, -c <s>: Specify a non-default config file to use (default:
53
+ ~/.larch/config.yaml)
54
+ --database <s>: Specify a non-default message database to use
55
+ (default: ~/.larch/larch.db)
56
+ --dry-run, -n: Don't actually make any changes
57
+ --max-retries <i>: Maximum number of times to retry after a recoverable
58
+ error (default: 3)
59
+ --no-create-folder: Don't create destination folders that don't already
60
+ exist
61
+ --ssl-certs <s>: Path to a trusted certificate bundle to use to
62
+ verify server SSL certificates
63
+ --ssl-verify: Verify server SSL certificates
64
+ --verbosity, -V <s>: Output verbosity: debug, info, warn, error, or fatal
65
+ (default: info)
66
+ --version, -v: Print version and exit
67
+ --help, -h: Show this message
68
+
69
+ == Usage Examples
70
+
71
+ Larch is run from the command line. The following examples demonstrate how to
72
+ run Larch using only command line arguments, but you may also place these
73
+ options in a config file and run Larch without any arguments if you prefer. See
74
+ the "Configuration" section below for more details.
75
+
76
+ For an overview of all available options, run:
77
+
78
+ larch -h
79
+
80
+ At a minimum, you must <b>specify a source server and a destination server</b>
81
+ in the form of IMAP URIs:
82
+
83
+ larch --from imap://mail.example.com --to imap://imap.gmail.com
84
+
85
+ Larch will prompt you for the necessary usernames and passwords, then sync the
86
+ contents of the source's +INBOX+ folder to the destination's INBOX folder.
87
+
88
+ To <b>connect using SSL</b>, specify a URI beginning with <tt>imaps://</tt>:
89
+
90
+ larch --from imaps://mail.example.com --to imaps://imap.gmail.com
91
+
92
+ If you'd like to <b>sync a specific folder</b> other than +INBOX+, specify the
93
+ source and destination folders using <tt>--from-folder</tt> and
94
+ <tt>--to-folder</tt>. Folder names containing spaces must be enclosed in quotes:
95
+
96
+ larch --from imaps://mail.example.com --to imaps://imap.gmail.com \
97
+ --from-folder 'Sent Mail' --to-folder 'Sent Mail'
98
+
99
+ To <b>sync all folders</b>, use the <tt>--all</tt> option (or
100
+ <tt>--all-subscribed</tt> if you only want to <b>sync subscribed folders</b>):
101
+
102
+ larch --from imaps://mail.example.com --to imaps://imap.gmail.com --all
103
+
104
+ By default Larch will create folders on the destination server if they don't
105
+ already exist. To prevent this, add the <tt>--no-create-folder</tt> option:
106
+
107
+ larch --from imaps://mail.example.com --to imaps://imap.gmail.com --all \
108
+ --no-create-folder
109
+
110
+ You can <b>prevent Larch from syncing one or more folders</b> by using the
111
+ <tt>--exclude</tt> option, which accepts multiple arguments:
112
+
113
+ larch --from imaps://mail.example.com --to imaps://imap.gmail.com --all \
114
+ --exclude Spam Trash Drafts "[Gmail]/*"
115
+
116
+ If your exclusion list is long or complex, create a text file with one exclusion
117
+ pattern per line and tell Larch to load it with the <tt>--exclude-file</tt>
118
+ option:
119
+
120
+ larch --from imaps://mail.example.com --to imaps://imap.gmail.com --all \
121
+ --exclude-file exclude.txt
122
+
123
+ The wildcard characters <tt>*</tt> and <tt>?</tt> are supported in exclusion
124
+ lists. You may also use a regular expression by enclosing a pattern in
125
+ forward slashes, so the previous example could be achieved with the
126
+ pattern <tt>/(Spam|Trash|Drafts|\[Gmail\]\/.*)/</tt>
127
+
128
+ == Configuration
129
+
130
+ While it's possible to control Larch entirely from the command line, this can be
131
+ inconvenient if you need to specify a lot of options or if you run Larch
132
+ frequently and can't always remember which options to use. Using a configuration
133
+ file can simplify things.
134
+
135
+ By default, Larch looks for a config file at <tt>~/.larch/config.yaml</tt> and
136
+ uses it if found. You may specify a custom config file using the
137
+ <tt>--config</tt> command line option.
138
+
139
+ The Larch configuration file is a simple YAML[http://yaml.org/] file that may
140
+ contain multiple sections, each with a different set of options, as well as a
141
+ special +default+ section. The options in the +default+ section will be used
142
+ unless they're overridden either in another config section or on the command
143
+ line.
144
+
145
+ === Example
146
+
147
+ Here's a sample Larch config file:
148
+
149
+ default:
150
+ all-subscribed: true # Copy all subscribed folders by default
151
+
152
+ # Copy mail from Gmail to my server, excluding stuff I don't want.
153
+ gmail to my server:
154
+ from: imaps://imap.gmail.com
155
+ from-user: example
156
+ from-pass: secret
157
+
158
+ to: imaps://mail.example.com
159
+ to-user: example
160
+ to-pass: secret
161
+
162
+ exclude:
163
+ - "[Gmail]/Sent Mail"
164
+ - "[Gmail]/Spam"
165
+ - "[Gmail]/Trash"
166
+
167
+ # Copy mail from my INBOX to Gmail's INBOX
168
+ my inbox to gmail inbox:
169
+ all-subscribed: false
170
+
171
+ from: imaps://mail.example.com
172
+ from-folder: INBOX
173
+ from-user: example
174
+ from-pass: secret
175
+
176
+ to: imaps://imap.gmail.com
177
+ to-folder: INBOX
178
+ to-user: example
179
+ to-pass: secret
180
+
181
+ This file contains three sections. The options from +default+ will be used in
182
+ all other sections as well unless they're overridden.
183
+
184
+ To specify which config section you want Larch to use, just pass its name on the
185
+ command line (use quotes if the name contains spaces):
186
+
187
+ larch 'gmail to my server'
188
+
189
+ If you specify additional command line options, they'll override options in the
190
+ config file:
191
+
192
+ larch 'gmail to my server' --from-user anotheruser
193
+
194
+ Running Larch with no command line arguments will cause the +default+ section
195
+ to be used. With the example above, this will result in an error since the
196
+ +default+ section doesn't contain the required +from+ and +to+ options, but if
197
+ you only need to use Larch with a single configuration, you could use the
198
+ +default+ section for everything and save yourself some typing on the command
199
+ line.
200
+
201
+ == Server Compatibility
202
+
203
+ Larch should work well with any server that properly supports
204
+ IMAP4rev1[http://tools.ietf.org/html/rfc3501], and does its best to get along
205
+ with servers that have buggy, unreliable, or incomplete IMAP implementations.
206
+
207
+ Larch has been tested on and is known to work well with the following IMAP
208
+ servers:
209
+
210
+ * Dovecot
211
+ * Gmail
212
+ * Microsoft Exchange 2003
213
+
214
+ The following servers do not work well with Larch:
215
+
216
+ * BlitzMail - Buggy server implementation; fails to properly quote or escape
217
+ some IMAP responses, which can cause Larch to hang waiting for a terminating
218
+ character that will never arrive.
219
+
220
+ == Known Issues
221
+
222
+ * Larch uses Ruby's Net::IMAP standard library for all IMAP operations. While
223
+ Net::IMAP is generally a very solid library, it contains a bug that can
224
+ cause a deadlock to occur if a connection drops unexpectedly (either due to
225
+ network issues or because the server closed the connection without warning)
226
+ when the server has already begun sending a response and Net::IMAP is
227
+ waiting to receive more data.
228
+
229
+ If this happens, Net::IMAP will continue waiting forever without passing
230
+ control back to Larch, and you will need to manually kill and restart Larch.
231
+
232
+ * The Ruby package on Debian, Ubuntu, and some other Debian-based Linux
233
+ distributions doesn't include the OpenSSL standard library. If you see an
234
+ error like <tt>uninitialized constant Larch::IMAP::OpenSSL (NameError)</tt>
235
+ when running Larch, you may need to install the <tt>libopenssl-ruby</tt>
236
+ package. Please feel free to complain to the maintainer of your distribution's
237
+ Ruby packages.
238
+
239
+ == Support
240
+
241
+ The Larch mailing list is the best place for questions, comments, and discussion
242
+ about Larch. You can join the list or view the archives at
243
+ http://groups.google.com/group/larch
244
+
245
+ == Credit
246
+
247
+ The Larch::IMAP class borrows heavily from Sup[http://sup.rubyforge.org] by
248
+ William Morgan, the source code of which should be required reading if you're
249
+ doing anything with IMAP in Ruby.
250
+
251
+ Larch uses the excellent Trollop[http://trollop.rubyforge.org] command-line
252
+ option parser (also by William Morgan) and the
253
+ HighLine[http://highline.rubyforge.org] command-line IO library (by James Edward
254
+ Gray II).
255
+
256
+ == License
257
+
258
+ Copyright (c) 2009 Ryan Grove <ryan@wonko.com>
259
+
260
+ Licensed under the GNU General Public License version 2.0.
261
+
262
+ This program is free software; you can redistribute it and/or modify it under
263
+ the terms of version 2.0 of the GNU General Public License as published by the
264
+ Free Software Foundation.
265
+
266
+ This program is distributed in the hope that it will be useful, but WITHOUT ANY
267
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
268
+ PARTICULAR PURPOSE. See the GNU General Public License for more details.
269
+
270
+ You should have received a copy of the GNU General Public License along with
271
+ this program; if not, visit http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
272
+ or write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
273
+ Boston, MA 02111-1307 USA.