tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Regen docs

Browse Source
This commit is contained in:
John Goerzen 2005-06-17 19:18:30 +01:00
parent eeb3d89aa8
commit d46fcf177d
5 changed files with 110 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
manual.html
View File

@ -1547,7 +1547,7 @@ CLASS="PROPERTY"
>folderfilter</SPAN >folderfilter</SPAN
> and <SPAN > and <SPAN
CLASS="PROPERTY" CLASS="PROPERTY"
>foldertrans</SPAN >nametrans</SPAN
> >
configuration file options to request certain folders and rename them configuration file options to request certain folders and rename them
as they come in if you like. as they come in if you like.
@ -2131,7 +2131,7 @@ NAME="AEN573"
><H2 ><H2
>Copyright</H2 >Copyright</H2
><P ><P
>OfflineIMAP, and this manual, are Copyright &copy; 2002, 2003 John Goerzen.</P >OfflineIMAP, and this manual, are Copyright © 2002, 2003 John Goerzen.</P
><P ><P
> This program is free software; you can redistribute it and/or modify > This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by

BIN
manual.pdf
View File

Binary file not shown.

83
manual.ps
View File

@ -1,6 +1,6 @@
%!PS-Adobe-3.0 %!PS-Adobe-3.0
%%Creator: groff version 1.18.1 %%Creator: groff version 1.18.1
%%CreationDate: Tue Nov 16 11:14:06 2004 %%CreationDate: Fri Jun 17 08:17:27 2005
%%DocumentNeededResources: font Times-Roman %%DocumentNeededResources: font Times-Roman
%%+ font Times-Bold %%+ font Times-Bold
%%+ font Times-Italic %%+ font Times-Italic
@ -395,8 +395,8 @@ F3<2f7573722f73686172>2.755 E<652f646f632f6f66>-.37 E
<4f668d696e65494d4150>3.304 E F0 5.804<2e59>C .804 <4f668d696e65494d4150>3.304 E F0 5.804<2e59>C .804
<6f752063616e2073696d706c7920636f70>-6.904 F 3.304<7974>-.1 G .803<6869 <6f752063616e2073696d706c7920636f70>-6.904 F 3.304<7974>-.1 G .803<6869
73208c6c6520696e746f20796f757220686f6d65206469726563746f727920616e64206e 73208c6c6520696e746f20796f757220686f6d65206469726563746f727920616e64206e
616d65206974>-3.304 F<4a6f686e20476f65727a656e>72 768 Q<3136204e6f> 616d65206974>-3.304 F<4a6f686e20476f65727a656e>72 768 Q
140.285 E -.15<7665>-.15 G<6d6265722032303034>.15 E<31>190.545 E 0 Cg EP <3137204a756e652032303035>152.075 E<31>202.335 E 0 Cg EP
%%Page: 2 2 %%Page: 2 2
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -538,8 +538,8 @@ F2<53595354454d2d5749444520494e5354>87 674.4 Q<414c4c41>-.9 E
<62792073696d706c792072756e6e696e672074686520666f6c6c6f>3.208 F .708 <62792073696d706c792072756e6e696e672074686520666f6c6c6f>3.208 F .708
<77696e6720636f6d2d>-.25 F<6d616e6420617320726f6f743a>108 698.4 Q F2 <77696e6720636f6d2d>-.25 F<6d616e6420617320726f6f743a>108 698.4 Q F2
<6170742d67657420696e7374616c6c206f668d696e65696d6170>108 715.2 Q F0 <6170742d67657420696e7374616c6c206f668d696e65696d6170>108 715.2 Q F0
<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 G <4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075 E
<6d6265722032303034>.15 E<32>190.545 E 0 Cg EP <32>202.335 E 0 Cg EP
%%Page: 3 3 %%Page: 3 3
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -682,8 +682,8 @@ F .506<776e2061206d616c66756e6374696f6e>-.25 F 1.195<6f72208c6775726520
<756767657374207468617420796f752075736520746869732077697468>-3.695 F F1 <756767657374207468617420796f752075736520746869732077697468>-3.695 F F1
<2d31>3.695 E F0 1.195<746f206d616b>3.695 F 3.695<6574>-.1 G<6865>-3.695 <2d31>3.695 E F0 1.195<746f206d616b>3.695 F 3.695<6574>-.1 G<6865>-3.695
E<726573756c7473206d6f72652073656e7369626c652e>144 717.6 Q E<726573756c7473206d6f72652073656e7369626c652e>144 717.6 Q
<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 G <4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075 E
<6d6265722032303034>.15 E<33>190.545 E 0 Cg EP <33>202.335 E 0 Cg EP
%%Page: 4 4 %%Page: 4 4
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -828,8 +828,8 @@ F1<426c61636b>108 544.8 Q F0 .57
<657373616765206c697374206973206265696e67206c6f616465642e>-2.5 E F1 <657373616765206c697374206973206265696e67206c6f616465642e>-2.5 E F1
<426c7565>108 693.6 Q F0<69732074686520636f6c6f72206f662061206d65737361 <426c7565>108 693.6 Q F0<69732074686520636f6c6f72206f662061206d65737361
67652073796e6368726f6e697a6174696f6e20636f6e74726f6c6c657220746872656164 67652073796e6368726f6e697a6174696f6e20636f6e74726f6c6c657220746872656164
2e>16.55 E<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15 2e>16.55 E<4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>
<7665>-.15 G<6d6265722032303034>.15 E<34>190.545 E 0 Cg EP 152.075 E<34>202.335 E 0 Cg EP
%%Page: 5 5 %%Page: 5 5
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -969,8 +969,8 @@ F .455 -.15<76652074>-.2 H .155
<626f6172643b206163636f756e74207061737377>.15 F 1.38 <626f6172643b206163636f756e74207061737377>.15 F 1.38
<6f726473206d7573742062652073706563698c6564>-.1 F<7573696e67206f6e65206f <6f726473206d7573742062652073706563698c6564>-.1 F<7573696e67206f6e65206f
662074686520636f6e8c6775726174696f6e208c6c65206f7074696f6e732e>108 708 Q 662074686520636f6e8c6775726174696f6e208c6c65206f7074696f6e732e>108 708 Q
<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 G <4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075 E
<6d6265722032303034>.15 E<35>190.545 E 0 Cg EP <35>202.335 E 0 Cg EP
%%Page: 6 6 %%Page: 6 6
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1066,8 +1066,8 @@ F2<4f668d696e65494d4150>3.004 E F0 1.604 -.55<27732022>D .505<7265666572
666f6c6465728c6c746572203d206c616d62646120666f6c6465726e616d653a20666f6c 666f6c6465728c6c746572203d206c616d62646120666f6c6465726e616d653a20666f6c
6465726e616d6520696e205b>108 705.6 Q<274d61696c2f494e424f>123 717.6 Q 6465726e616d6520696e205b>108 705.6 Q<274d61696c2f494e424f>123 717.6 Q
<58272c>-.4 E<274d61696c2f6c6973742f7a61757275732d67656e6572616c272c>123 <58272c>-.4 E<274d61696c2f6c6973742f7a61757275732d67656e6572616c272c>123
729.6 Q<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15 729.6 Q<4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>
<7665>-.15 G<6d6265722032303034>.15 E<36>190.545 E 0 Cg EP 152.075 E<36>202.335 E 0 Cg EP
%%Page: 7 7 %%Page: 7 7
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1164,8 +1164,8 @@ G 1.242<68652073657276>-3.742 F 1.242<65722077696c6c206f6674656e20737461
<616e642074686520666f6c6465722077697468207468652070726f626c656d20697320 <616e642074686520666f6c6465722077697468207468652070726f626c656d20697320
494e424f>2.5 E<582c20796f7527>-.4 E 2.5<6474>-.5 G<79706520746869733a> 494e424f>2.5 E<582c20796f7527>-.4 E 2.5<6474>-.5 G<79706520746869733a>
-2.5 E<726d202d72207e2f46>108 722.4 Q<6f6c646572732f494e424f>-.15 E<58> -2.5 E<726d202d72207e2f46>108 722.4 Q<6f6c646572732f494e424f>-.15 E<58>
-.4 E<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665> -.4 E<4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075
-.15 G<6d6265722032303034>.15 E<37>190.545 E 0 Cg EP E<37>202.335 E 0 Cg EP
%%Page: 8 8 %%Page: 8 8
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1260,14 +1260,14 @@ F<6571756972>-.18 E 3.096<656d>-.18 G 3.096<6574>-3.096 G 3.096<6f75>
-.25 E F0 -1.1<596f>144 451.2 S 3.55<7564>1.1 G 3.55<6f6e>-3.55 G 1.05 -.25 E F0 -1.1<596f>144 451.2 S 3.55<7564>1.1 G 3.55<6f6e>-3.55 G 1.05
<6f74206e65656420746f2e>-3.55 F F2<4f668d696e65494d4150>6.05 E F0 1.05< <6f74206e65656420746f2e>-3.55 F F2<4f668d696e65494d4150>6.05 E F0 1.05<
697320736d61727420656e6f75676820746f206175746f6d61746963616c6c79208c6775 697320736d61727420656e6f75676820746f206175746f6d61746963616c6c79208c6775
7265206f7574207768617420666f6c6465727320617265>3.55 F 1.127 7265206f7574207768617420666f6c6465727320617265>3.55 F 1.287
<70726573656e74206f6e2074686520494d41502073657276>144 463.2 R 1.128 <70726573656e74206f6e2074686520494d41502073657276>144 463.2 R 1.287
<657220616e642073796e6368726f6e697a65207468656d2e>-.15 F -1.1<596f>6.128 <657220616e642073796e6368726f6e697a65207468656d2e>-.15 F -1.1<596f>6.287
G 3.628<7563>1.1 G 1.128<616e2075736520746865>-3.628 F F1 G 3.787<7563>1.1 G 1.287<616e2075736520746865>-3.787 F F1
<666f6c6465728c6c746572>3.628 E F0<616e64>3.628 E F1<666f6c6465727472> <666f6c6465728c6c746572>3.787 E F0<616e64>3.788 E F1<6e616d657472>3.788
3.628 E<616e73>-.15 E F0<636f6e8c6775726174696f6e208c6c65206f7074696f6e E<616e73>-.15 E F0<636f6e8c6775726174696f6e208c6c65206f7074696f6e732074
7320746f2072657175657374206365727461696e20666f6c6465727320616e642072656e 6f2072657175657374206365727461696e20666f6c6465727320616e642072656e616d65
616d65207468656d20617320746865>144 475.2 Q 2.5<7963>-.15 G 207468656d20617320746865>144 475.2 Q 2.5<7963>-.15 G
<6f6d6520696e20696620796f75206c696b>-2.5 E<652e>-.1 E F2<486f>108 492 Q <6f6d6520696e20696620796f75206c696b>-2.5 E<652e>-.1 E F2<486f>108 492 Q
2.5<7763>-.1 G<616e2049207072>-2.5 E -2.3 -.15<65762065>-.18 H 2.5<7763>-.1 G<616e2049207072>-2.5 E -2.3 -.15<65762065>-.18 H
<6e74206365727461696e2066>.15 E<6f6c64657273206672>-.25 E <6e74206365727461696e2066>.15 E<6f6c64657273206672>-.25 E
@ -1313,8 +1313,8 @@ Q<2d6163636f756e742073656374696f6e20666f722065616368206f6e652e>-.2 E F2
6c65206d756c74692d6d616368696e652073796e6368726f6e697a6174696f6e206c696b> 6c65206d756c74692d6d616368696e652073796e6368726f6e697a6174696f6e206c696b>
-.2 F<65>-.1 E F2<4f668d696e65494d4150>144 708 Q F0<63616e20646f2e>2.5 E -.2 F<65>-.1 E F2<4f668d696e65494d4150>144 708 Q F0<63616e20646f2e>2.5 E
F2<4f668d696e65494d4150>5 E F0<77696c6c206e6f7420737570706f72742069742e> F2<4f668d696e65494d4150>5 E F0<77696c6c206e6f7420737570706f72742069742e>
2.5 E<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665> 2.5 E<4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075
-.15 G<6d6265722032303034>.15 E<38>190.545 E 0 Cg EP E<38>202.335 E 0 Cg EP
%%Page: 9 9 %%Page: 9 9
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1456,8 +1456,8 @@ F .507<617265206d616e>3.007 F 3.007<7976>-.15 G .507
<73697465206769>2.5 E -.15<7665>-.25 G 2.5<7374>.15 G<6869732065>-2.5 E <73697465206769>2.5 E -.15<7665>-.25 G 2.5<7374>.15 G<6869732065>-2.5 E
<78616d706c653a>-.15 E<6d6f756e74202d66202d73202d62202d6f206d616e616765 <78616d706c653a>-.15 E<6d6f756e74202d66202d73202d62202d6f206d616e616765
642022643a2f746d702f6d61696c2220222f686f6d652f6f662f6d61696c22>144 715.2 642022643a2f746d702f6d61696c2220222f686f6d652f6f662f6d61696c22>144 715.2
Q<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 Q<4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075 E
G<6d6265722032303034>.15 E<39>190.545 E 0 Cg EP <39>202.335 E 0 Cg EP
%%Page: 10 10 %%Page: 10 10
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1625,8 +1625,7 @@ Q<672f6f66>-.18 E<8d696e65696d617040636f6d706c6574652e6f72>-.25 E
Q 2.5<672e2044656269616e>-.18 F<75736572732061726520656e636f757261676564 Q 2.5<672e2044656269616e>-.18 F<75736572732061726520656e636f757261676564
20746f20696e737465616420757365207468652044656269616e2062>2.5 E 20746f20696e737465616420757365207468652044656269616e2062>2.5 E
<75672d747261636b696e672073797374656d2e>-.2 E<4a6f686e20476f65727a656e> <75672d747261636b696e672073797374656d2e>-.2 E<4a6f686e20476f65727a656e>
72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 G<6d6265722032303034>.15 E 72 768 Q<3137204a756e652032303035>152.075 E<3130>197.335 E 0 Cg EP
<3130>185.545 E 0 Cg EP
%%Page: 11 11 %%Page: 11 11
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1685,15 +1684,15 @@ F 2.732<7766>-.25 G .232<6561747572657320696e20342e302e>-2.732 F -.15
<6f726d616c2e>-2.5 E F1<434f50595249474854>72 271.2 Q F0<4f66>108 283.2 <6f726d616c2e>-2.5 E F1<434f50595249474854>72 271.2 Q F0<4f66>108 283.2
Q<8d696e65494d4150>-.25 E 2.5<2c61>-1.11 G Q<8d696e65494d4150>-.25 E 2.5<2c61>-1.11 G
<6e642074686973206d616e75616c2c2061726520436f70>-2.5 E <6e642074686973206d616e75616c2c2061726520436f70>-2.5 E
<7972696768742028432920323030322c2032303033204a6f686e20476f65727a656e2e> <79726967687420a920323030322c2032303033204a6f686e20476f65727a656e2e>-.1
-.1 E .286<546869732070726f6772616d206973206672656520736f667477>108 300 E .286<546869732070726f6772616d206973206672656520736f667477>108 300 R
R .286<6172653b20796f752063616e20726564697374726962>-.1 F .287<75746520 .286<6172653b20796f752063616e20726564697374726962>-.1 F .287<7574652069
697420616e642f6f72206d6f6469667920697420756e64657220746865207465726d7320 7420616e642f6f72206d6f6469667920697420756e64657220746865207465726d73206f
6f662074686520474e552047656e6572616c>-.2 F .766<5075626c6963204c6963656e 662074686520474e552047656e6572616c>-.2 F .766<5075626c6963204c6963656e73
7365206173207075626c697368656420627920746865204672656520536f667477>108 65206173207075626c697368656420627920746865204672656520536f667477>108 312
312 R .766<6172652046>-.1 F .766<6f756e646174696f6e3b206569746865722076> R .766<6172652046>-.1 F .766<6f756e646174696f6e3b206569746865722076>-.15
-.15 F .766<657273696f6e2032206f6620746865204c6963656e73652c206f72202861 F .766<657273696f6e2032206f6620746865204c6963656e73652c206f722028617420
7420796f7572>-.15 F<6f7074696f6e2920616e>108 324 Q 2.5<796c>-.15 G 796f7572>-.15 F<6f7074696f6e2920616e>108 324 Q 2.5<796c>-.15 G
<617465722076>-2.5 E<657273696f6e2e>-.15 E .579 <617465722076>-2.5 E<657273696f6e2e>-.15 E .579
<546869732070726f6772616d2069732064697374726962>108 340.8 R .579<757465 <546869732070726f6772616d2069732064697374726962>108 340.8 R .579<757465
6420696e2074686520686f706520746861742069742077696c6c2062652075736566756c 6420696e2074686520686f706520746861742069742077696c6c2062652075736566756c
@ -1792,8 +1791,8 @@ F 2.193<617320696e74726f6475636564207769746820332e302e302c20616c6f6e6720
204a756c792032312c20616464696e6720746865204e6f6e696e74657261637469>-.1 F 204a756c792032312c20616464696e6720746865204e6f6e696e74657261637469>-.1 F
.39 -.15<76652075>-.25 H .09<73657220696e74657266>.15 F .09 .39 -.15<76652075>-.25 H .09<73657220696e74657266>.15 F .09
<616365732c2070726f8c6c696e6720737570706f72742c>-.1 F <616365732c2070726f8c6c696e6720737570706f72742c>-.1 F
<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 G <4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075 E
<6d6265722032303034>.15 E<3131>185.545 E 0 Cg EP <3131>197.335 E 0 Cg EP
%%Page: 12 12 %%Page: 12 12
%%BeginPageSetup %%BeginPageSetup
BP BP
@ -1826,8 +1825,8 @@ F 4.446<6f49>-.1 G<4d4150>-4.446 E<73657276>108 165.6 Q 1.371<6572732c20
6775726174696f6e208c6c6520746f2072658c6e6520746865206e6f74696f6e206f6620 6775726174696f6e208c6c6520746f2072658c6e6520746865206e6f74696f6e206f6620
616e206163636f756e742c20616e6420746865206e65>-.15 F<77>-.25 E 616e206163636f756e742c20616e6420746865206e65>-.15 F<77>-.25 E
<43757273657320696e74657266>108 177.6 Q<6163652e>-.1 E <43757273657320696e74657266>108 177.6 Q<6163652e>-.1 E
<4a6f686e20476f65727a656e>72 768 Q<3136204e6f>140.285 E -.15<7665>-.15 G <4a6f686e20476f65727a656e>72 768 Q<3137204a756e652032303035>152.075 E
<6d6265722032303034>.15 E<3132>185.545 E 0 Cg EP <3132>197.335 E 0 Cg EP
%%Trailer %%Trailer
end end
%%EOF %%EOF

63
manual.txt
View File

@ -560,7 +560,7 @@ OTHER FREQUENTLY ASKED QUESTIONS
How do I specify the names of my folders? How do I specify the names of my folders?
You do not need to. OfflineIMAP is smart enough to automati- You do not need to. OfflineIMAP is smart enough to automati-
cally figure out what folders are present on the IMAP server and cally figure out what folders are present on the IMAP server and
synchronize them. You can use the folderfilter and foldertrans synchronize them. You can use the folderfilter and nametrans
configuration file options to request certain folders and rename configuration file options to request certain folders and rename
them as they come in if you like. them as they come in if you like.
@ -770,78 +770,77 @@ UPGRADING TO 4.0
from the server and then you can continue using it like normal. from the server and then you can continue using it like normal.
COPYRIGHT COPYRIGHT
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John OfflineIMAP, and this manual, are Copyright 2002, 2003 John Goerzen.
Goerzen.
This program is free software; you can redistribute it and/or modify it This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your Free Software Foundation; either version 2 of the License, or (at your
option) any later version. option) any later version.
This program is distributed in the hope that it will be useful, but This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER- WITHOUT ANY WARRANTY; without even the implied warranty of MER-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details. Public License for more details.
You should have received a copy of the GNU General Public License along You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc., with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
imaplib.py comes from the Python dev tree and is licensed under the imaplib.py comes from the Python dev tree and is licensed under the
GPL-compatible PSF license as stated in the file COPYRIGHT in the GPL-compatible PSF license as stated in the file COPYRIGHT in the
OfflineIMAP distribution. OfflineIMAP distribution.
AUTHOR AUTHOR
OfflineIMAP, its libraries, documentation, and all included files, OfflineIMAP, its libraries, documentation, and all included files,
except where noted, was written by John Goerzen <jgoerzen@complete.org> except where noted, was written by John Goerzen <jgoerzen@complete.org>
and copyright is held as stated in the COPYRIGHT section. and copyright is held as stated in the COPYRIGHT section.
OfflineIMAP may be downloaded, and information found, from its homepage OfflineIMAP may be downloaded, and information found, from its homepage
via either Gopher <URL:gopher://quux.org/1/devel/offlineimap> or HTTP via either Gopher <URL:gopher://quux.org/1/devel/offlineimap> or HTTP
<URL:http://quux.org/devel/offlineimap>. <URL:http://quux.org/devel/offlineimap>.
OfflineIMAP may also be downloaded using Subversion. Additionally, the OfflineIMAP may also be downloaded using Subversion. Additionally, the
distributed tar.gz may be updated with a simple "svn update" command; distributed tar.gz may be updated with a simple "svn update" command;
it is ready to go. For information on getting OfflineIMAP with Subver- it is ready to go. For information on getting OfflineIMAP with Subver-
sion, please visit the complete.org Subversion page sion, please visit the complete.org Subversion page
<URL:http://svn.complete.org/>. <URL:http://svn.complete.org/>.
SEE ALSO SEE ALSO
mutt(1), python(1) mutt(1), python(1)
HISTORY HISTORY
Detailed history may be found in the file ChangeLog in the OfflineIMAP Detailed history may be found in the file ChangeLog in the OfflineIMAP
distribution. Feature and bug histories may be found in the file distribution. Feature and bug histories may be found in the file
debian/changelog which, despite its name, is not really Debian-spe- debian/changelog which, despite its name, is not really Debian-spe-
cific. This section provides a large overview. cific. This section provides a large overview.
Development on OfflineIMAP began on June 18, 2002. Version 1.0.0 was Development on OfflineIMAP began on June 18, 2002. Version 1.0.0 was
released three days later on June 21, 2002. Point releases followed, released three days later on June 21, 2002. Point releases followed,
including speed optimizations and some compatibility fixes. including speed optimizations and some compatibility fixes.
Version 2.0.0 was released on July 3, 2002, and represented the first Version 2.0.0 was released on July 3, 2002, and represented the first
time the synchronization became multithreaded and, to the best of my time the synchronization became multithreaded and, to the best of my
knowledge, the first multithreaded IMAP syncrhonizing application in knowledge, the first multithreaded IMAP syncrhonizing application in
existance. The last 2.0.x release, 2.0.8, was made on July 9. existance. The last 2.0.x release, 2.0.8, was made on July 9.
Version 3.0.0 was released on July 11, 2002, and introduced modular Version 3.0.0 was released on July 11, 2002, and introduced modular
user interfaces and the first GUI interface for OfflineIMAP. This man- user interfaces and the first GUI interface for OfflineIMAP. This man-
ual also was introduced with 3.0.0, along with many command-line ual also was introduced with 3.0.0, along with many command-line
options. Version 3.1.0 was released on July 21, adding the Noninterac- options. Version 3.1.0 was released on July 21, adding the Noninterac-
tive user interfaces, profiling support, and several bugfixes. 3.2.0 tive user interfaces, profiling support, and several bugfixes. 3.2.0
was released on July 24, adding support for the Blinkenlights GUI was released on July 24, adding support for the Blinkenlights GUI
interface. OfflineIMAP entered maintenance mode for awhile, as it had interface. OfflineIMAP entered maintenance mode for awhile, as it had
reached a feature-complete milestone in my mind. reached a feature-complete milestone in my mind.
The 3.99.x branch began in on October 7, 2002, to begin work for 4.0. The 3.99.x branch began in on October 7, 2002, to begin work for 4.0.
The Curses.Blinkenlights interface was added in 3.99.6, and many archi- The Curses.Blinkenlights interface was added in 3.99.6, and many archi-
tectural changes were made. tectural changes were made.
4.0.0 was released on July 18, 2003, including the ability to synchro- 4.0.0 was released on July 18, 2003, including the ability to synchro-
nize directly between two IMAP servers, the first re-architecting of nize directly between two IMAP servers, the first re-architecting of
the configuration file to refine the notion of an account, and the new the configuration file to refine the notion of an account, and the new
Curses interface. Curses interface.
John Goerzen 16 November 2004 OFFLINEIMAP(1) John Goerzen 17 June 2005 OFFLINEIMAP(1)

72
offlineimap.1
View File

@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches, .\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>. .\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "OFFLINEIMAP" "1" "16 November 2004" "John Goerzen" "OfflineIMAP Manual" .TH "OFFLINEIMAP" "1" "17 June 2005" "John Goerzen" "OfflineIMAP Manual"
.SH NAME .SH NAME
OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support
@ -92,9 +92,9 @@ You can quickly set up your configuration file. The distribution
includes a file \fIofflineimap.conf.minimal\fR includes a file \fIofflineimap.conf.minimal\fR
(Debian users (Debian users
may find this at may find this at
\fI/usr/share/doc/offlineimap/examples/offlineimap.conf.minimal\fR) that is a basic example of setting of \fBOfflineIMAP\fR. You can \fI/usr/share/doc/offlineimap/examples/offlineimap.conf.minimal\fR) that is a basic example of setting of \fBOfflineIMAP\fR\&. You can
simply copy this file into your home directory and name it simply copy this file into your home directory and name it
\fI.offlineimaprc\fR (note the leading period). A \fI\&.offlineimaprc\fR (note the leading period). A
command such as \fBcp offlineimap.conf.minimal ~/.offlineimaprc\fR will do it. Or, if you prefer, you can just copy this text to command such as \fBcp offlineimap.conf.minimal ~/.offlineimaprc\fR will do it. Or, if you prefer, you can just copy this text to
\fI~/.offlineimaprc\fR: \fI~/.offlineimaprc\fR:
@ -141,7 +141,7 @@ yourself, you have three options: a system-wide installation with
Debian, system-wide installation with other systems, and a single-user Debian, system-wide installation with other systems, and a single-user
installation. You can download the latest version of \fBOfflineIMAP\fR from installation. You can download the latest version of \fBOfflineIMAP\fR from
the \fBOfflineIMAP\fR the \fBOfflineIMAP\fR
website <URL:http://quux.org/devel/offlineimap/>. website <URL:http://quux.org/devel/offlineimap/>\&.
.SS "PREREQUISITES" .SS "PREREQUISITES"
.PP .PP
In order to use \fBOfflineIMAP\fR, you need to have these conditions In order to use \fBOfflineIMAP\fR, you need to have these conditions
@ -160,7 +160,7 @@ If you are
running on Debian GNU/Linux, this requirement will automatically be running on Debian GNU/Linux, this requirement will automatically be
taken care of for you. If you do not have Python already, check with taken care of for you. If you do not have Python already, check with
your system administrator or operating system vendor; or, download it from your system administrator or operating system vendor; or, download it from
the Python website <URL:http://www.python.org/>. the Python website <URL:http://www.python.org/>\&.
If you intend to use the Tk interface, you must have Tkinter If you intend to use the Tk interface, you must have Tkinter
(python-tk) installed. If you intend to use the SSL interface, your (python-tk) installed. If you intend to use the SSL interface, your
Python must have been built with SSL support. Python must have been built with SSL support.
@ -171,7 +171,7 @@ format. Most modern mail readers have this support
built-in, so you can choose from a wide variety of mail built-in, so you can choose from a wide variety of mail
servers. This format is also known as the "qmail" servers. This format is also known as the "qmail"
format, so any mail reader compatible with it will work format, so any mail reader compatible with it will work
with \fBOfflineIMAP\fR. If you do not have a mail reader with \fBOfflineIMAP\fR\&. If you do not have a mail reader
that supports Maildir, you can often install a local that supports Maildir, you can often install a local
IMAP server and point both \fBOfflineIMAP\fR and your mail IMAP server and point both \fBOfflineIMAP\fR and your mail
reader at it. reader at it.
@ -190,7 +190,7 @@ invoke the program.
.SS "SYSTEM-WIDE INSTALLATION, OTHER" .SS "SYSTEM-WIDE INSTALLATION, OTHER"
.PP .PP
Download the tar.gz version of the package from the Download the tar.gz version of the package from the
website <URL:http://quux.org/devel/offlineimap/>. website <URL:http://quux.org/devel/offlineimap/>\&.
Then run Then run
these commands, making sure that you are the "root" user first: these commands, making sure that you are the "root" user first:
@ -201,13 +201,13 @@ python2.2 setup.py install
.fi .fi
.PP .PP
On some systems, you will need to use On some systems, you will need to use
\fBpython\fR instead of \fBpython2.2\fR. \fBpython\fR instead of \fBpython2.2\fR\&.
Next, proceed to [XRef to CONFIGURATION] below. You will type \fBofflineimap\fR to Next, proceed to [XRef to CONFIGURATION] below. You will type \fBofflineimap\fR to
invoke the program. invoke the program.
.SS "SINGLE-ACCOUNT INSTALLATION" .SS "SINGLE-ACCOUNT INSTALLATION"
.PP .PP
Download the tar.gz version of the package from the Download the tar.gz version of the package from the
website <URL:http://quux.org/devel/offlineimap/>. website <URL:http://quux.org/devel/offlineimap/>\&.
Then run these commands: Then run these commands:
.nf .nf
@ -217,28 +217,28 @@ cd offlineimap-x.y.z
.PP .PP
When you want to run \fBOfflineIMAP\fR, you will issue the When you want to run \fBOfflineIMAP\fR, you will issue the
\fBcd\fR command as above and then type \fBcd\fR command as above and then type
\fB./offlineimap.py\fR; there is no installation \fB\&./offlineimap.py\fR; there is no installation
step necessary. step necessary.
.SH "CONFIGURATION" .SH "CONFIGURATION"
.PP .PP
\fBOfflineIMAP\fR is regulated by a configuration file that is normally \fBOfflineIMAP\fR is regulated by a configuration file that is normally
stored in \fI~/.offlineimaprc\fR. \fBOfflineIMAP\fR stored in \fI~/.offlineimaprc\fR\&. \fBOfflineIMAP\fR
ships with a file named \fIofflineimap.conf\fR ships with a file named \fIofflineimap.conf\fR
that you should copy to that location and then edit. This file is that you should copy to that location and then edit. This file is
vital to proper operation of the system; it sets everything you need vital to proper operation of the system; it sets everything you need
to run \fBOfflineIMAP\fR. Full documentation for the configuration file to run \fBOfflineIMAP\fR\&. Full documentation for the configuration file
is included within the sample file. is included within the sample file.
.PP .PP
\fBOfflineIMAP\fR also ships a file named \fBOfflineIMAP\fR also ships a file named
\fIofflineimap.conf.minimal\fR that you can also try. \fIofflineimap.conf.minimal\fR that you can also try.
It's useful if you want to get started with It's useful if you want to get started with
the most basic feature set, and you can read about other features the most basic feature set, and you can read about other features
later with \fIofflineimap.conf\fR. later with \fIofflineimap.conf\fR\&.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
Most configuration is done via the configuration file. Nevertheless, Most configuration is done via the configuration file. Nevertheless,
there are a few command-line options that you may set for there are a few command-line options that you may set for
\fBOfflineIMAP\fR. \fBOfflineIMAP\fR\&.
.TP .TP
\fB-1\fR \fB-1\fR
Disable most multithreading operations and use Disable most multithreading operations and use
@ -258,7 +258,7 @@ is present for debugging and optimization only, and should NOT be used
unless you have a specific reason to do so. It will significantly unless you have a specific reason to do so. It will significantly
slow program performance, may reduce reliability, and can generate slow program performance, may reduce reliability, and can generate
huge amounts of data. You must use the \fB-1\fR option when huge amounts of data. You must use the \fB-1\fR option when
you use \fB-P\fR. you use \fB-P\fR\&.
.TP .TP
\fB-a \fIaccountlist\fB\fR \fB-a \fIaccountlist\fB\fR
Overrides the \fIaccounts\fR option Overrides the \fIaccounts\fR option
@ -269,7 +269,7 @@ accounts by commas, and use no embedded spaces.
.TP .TP
\fB-c \fIconfigfile\fB\fR \fB-c \fIconfigfile\fB\fR
Specifies a configuration file to use in lieu of Specifies a configuration file to use in lieu of
the default, \fI~/.offlineimaprc\fR. the default, \fI~/.offlineimaprc\fR\&.
.TP .TP
\fB-d \fIdebugtype[,...]\fB\fR \fB-d \fIdebugtype[,...]\fB\fR
Enables debugging for OfflineIMAP. This is useful if Enables debugging for OfflineIMAP. This is useful if
@ -280,7 +280,7 @@ on under the hood. I suggest that you use this with
\fB-d\fR requires one or more debugtypes, \fB-d\fR requires one or more debugtypes,
separated by commas. These define what exactly will be separated by commas. These define what exactly will be
debugged, and include three options: \fIimap\fR, debugged, and include three options: \fIimap\fR,
\fImaildir\fR, and \fIthread\fR. \fImaildir\fR, and \fIthread\fR\&.
The \fIimap\fR The \fIimap\fR
option will enable IMAP protocol stream and parsing debugging. Note option will enable IMAP protocol stream and parsing debugging. Note
that the output may contain passwords, so take care to remove that that the output may contain passwords, so take care to remove that
@ -327,7 +327,7 @@ in this section.
Tk.Blinkenlights is an interface designed to be sleek, fun to watch, and Tk.Blinkenlights is an interface designed to be sleek, fun to watch, and
informative of the overall picture of what \fBOfflineIMAP\fR informative of the overall picture of what \fBOfflineIMAP\fR
is doing. I consider it to be the best general-purpose interface in is doing. I consider it to be the best general-purpose interface in
\fBOfflineIMAP\fR. \fBOfflineIMAP\fR\&.
.PP .PP
Tk.Blinkenlights contains, by default, a small window with a row of Tk.Blinkenlights contains, by default, a small window with a row of
LEDs, a small log, and a row of command buttons. LEDs, a small log, and a row of command buttons.
@ -354,7 +354,7 @@ activity.
\fBRed (Meaning 1)\fR \fBRed (Meaning 1)\fR
is the color of the main program's thread, which basically does is the color of the main program's thread, which basically does
nothing but monitor the others. It might remind you of HAL 9000 in nothing but monitor the others. It might remind you of HAL 9000 in
2001. 2001\&.
.TP .TP
\fBGray\fR \fBGray\fR
indicates that the thread is establishing a new connection to the IMAP indicates that the thread is establishing a new connection to the IMAP
@ -465,7 +465,7 @@ This example shows you how to set up \fBOfflineIMAP\fR to
synchronize multiple accounts with the mutt mail reader. synchronize multiple accounts with the mutt mail reader.
.PP .PP
Start by creating a directory to hold your folders by running Start by creating a directory to hold your folders by running
\fBmkdir ~/Mail\fR. Then, in your \fBmkdir ~/Mail\fR\&. Then, in your
\fI~/.offlineimaprc\fR, specify: \fI~/.offlineimaprc\fR, specify:
.nf .nf
@ -478,7 +478,7 @@ and an \fI[Account Work]\fR section. The
local repository for each account must have different local repository for each account must have different
\fIlocalfolder\fR path names. \fIlocalfolder\fR path names.
Also, make sure Also, make sure
to enable \fI[mbnames]\fR. to enable \fI[mbnames]\fR\&.
.PP .PP
In each local repository section, write something like this: In each local repository section, write something like this:
@ -500,7 +500,7 @@ spoolfile=+Personal/INBOX
That's it! That's it!
.SS "UW-IMAPD AND REFERENCES" .SS "UW-IMAPD AND REFERENCES"
.PP .PP
Some users with a UW-IMAPD server need to use \fBOfflineIMAP\fR's Some users with a UW-IMAPD server need to use \fBOfflineIMAP\fR\&'s
"reference" feature to get at their mailboxes, specifying a reference "reference" feature to get at their mailboxes, specifying a reference
of "~/Mail" or "#mh/" depending on the configuration. The below of "~/Mail" or "#mh/" depending on the configuration. The below
configuration from (originally from docwhat@gerf.org) configuration from (originally from docwhat@gerf.org)
@ -591,9 +591,9 @@ please check this section.
.PP .PP
IMAP servers use a unique ID (UID) to refer to a specific message. IMAP servers use a unique ID (UID) to refer to a specific message.
This number is guaranteed to be unique to a particular message This number is guaranteed to be unique to a particular message
\fBforever\fR. \fBforever\fR\&.
No other message in the same folder will ever get the same No other message in the same folder will ever get the same
UID. UIDs are an integral part of \fBOfflineIMAP\fR's synchronization UID. UIDs are an integral part of \fBOfflineIMAP\fR\&'s synchronization
scheme; they are used to match up messages on your computer to scheme; they are used to match up messages on your computer to
messages on the server. messages on the server.
.PP .PP
@ -633,7 +633,7 @@ this condition and abort prior to synchronization.)
.PP .PP
This question comes up frequently on the This question comes up frequently on the
\fBOfflineIMAP\fR \fBOfflineIMAP\fR
mailing list <URL:http://lists.complete.org/offlineimap@complete.org/>. You can find a mailing list <URL:http://lists.complete.org/offlineimap@complete.org/>\&. You can find a
detailed detailed
discussion <URL:http://lists.complete.org/offlineimap@complete.org/2003/04/msg00012.html.gz> of the problem there. discussion <URL:http://lists.complete.org/offlineimap@complete.org/2003/04/msg00012.html.gz> of the problem there.
.SH "OTHER FREQUENTLY ASKED QUESTIONS" .SH "OTHER FREQUENTLY ASKED QUESTIONS"
@ -660,7 +660,7 @@ manual.
You do not need to. \fBOfflineIMAP\fR is smart You do not need to. \fBOfflineIMAP\fR is smart
enough to automatically figure out what folders are present enough to automatically figure out what folders are present
on the IMAP server and synchronize them. You can use the on the IMAP server and synchronize them. You can use the
\fIfolderfilter\fR and \fIfoldertrans\fR \fIfolderfilter\fR and \fInametrans\fR
configuration file options to request certain folders and rename them configuration file options to request certain folders and rename them
as they come in if you like. as they come in if you like.
.TP .TP
@ -717,7 +717,7 @@ necessary so \fBOfflineIMAP\fR can detect a message moved to a different
folder. \fBOfflineIMAP\fR stores the UID (U= number) and an md5sum of the folder. \fBOfflineIMAP\fR stores the UID (U= number) and an md5sum of the
foldername (FMD5= number) to facilitate this. foldername (FMD5= number) to facilitate this.
.TP .TP
\fBWhat is the speed of OfflineIMAP's sync?\fR \fBWhat is the speed of OfflineIMAP\&'s sync?\fR
OfflineIMAP OfflineIMAP
versions 2.0 and above contain a multithreaded system. A good way to versions 2.0 and above contain a multithreaded system. A good way to
experiment is by setting \fImaxsyncaccounts\fR to 3 and \fImaxconnections\fR to 3 experiment is by setting \fImaxsyncaccounts\fR to 3 and \fImaxconnections\fR to 3
@ -770,7 +770,7 @@ environment.
Next, you'll need to mount your Maildir directory in a Next, you'll need to mount your Maildir directory in a
special way. There is information for doing that at special way. There is information for doing that at
<URL:http://barnson.org/node/view/295>. <URL:http://barnson.org/node/view/295>\&.
That site gives this example: That site gives this example:
.nf .nf
@ -792,7 +792,7 @@ CRAM-MD5 as specified in RFC2195
\(bu \(bu
Maildir as specified in Maildir as specified in
the Maildir manpage <URL:http://www.qmail.org/qmail-manual-html/man5/maildir.html> and the Maildir manpage <URL:http://www.qmail.org/qmail-manual-html/man5/maildir.html> and
the qmail website <URL:http://cr.yp.to/proto/maildir.html>. the qmail website <URL:http://cr.yp.to/proto/maildir.html>\&.
.TP 0.2i .TP 0.2i
\(bu \(bu
Standard Python 2.2.1 as implemented on POSIX-compliant systems. Standard Python 2.2.1 as implemented on POSIX-compliant systems.
@ -848,7 +848,7 @@ is not compatible
with KMail. KMail cannot work in any mode other than to move with KMail. KMail cannot work in any mode other than to move
all messages out of all folders immediately, which (besides being annoying all messages out of all folders immediately, which (besides being annoying
and fundamentally broken) is incompatible with and fundamentally broken) is incompatible with
\fBOfflineIMAP\fR. \fBOfflineIMAP\fR\&.
.PP .PP
However, I have made KMail version 3 work well with However, I have made KMail version 3 work well with
\fBOfflineIMAP\fR by installing an IMAP server on my local \fBOfflineIMAP\fR by installing an IMAP server on my local
@ -860,7 +860,7 @@ There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail to To subscribe, send the text "Subscribe" in the subject of a mail to
offlineimap-request@complete.org. To post, send the message to offlineimap-request@complete.org. To post, send the message to
offlineimap@complete.org. Archives are available at offlineimap@complete.org. Archives are available at
<URL:http://lists.complete.org/offlineimap@complete.org/>. <URL:http://lists.complete.org/offlineimap@complete.org/>\&.
.SS "BUGS" .SS "BUGS"
.PP .PP
Reports of bugs should be sent via e-mail to the Reports of bugs should be sent via e-mail to the
@ -889,7 +889,7 @@ local side and another for the remote side.) See the files
\fIofflineimap.conf\fR in the distribution if \fIofflineimap.conf\fR in the distribution if
you need more assistance. you need more assistance.
.PP .PP
\fBOfflineIMAP\fR's status directory area has also changed. \fBOfflineIMAP\fR\&'s status directory area has also changed.
Therefore, you should delete everything in ~/.offlineimap as Therefore, you should delete everything in ~/.offlineimap as
well as your local mail folders. well as your local mail folders.
.PP .PP
@ -898,7 +898,7 @@ your mail from the server and then you can continue using it
like normal. like normal.
.SH "COPYRIGHT" .SH "COPYRIGHT"
.PP .PP
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John Goerzen. OfflineIMAP, and this manual, are Copyright © 2002, 2003 John Goerzen.
.PP .PP
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
@ -926,13 +926,13 @@ copyright is held as stated in the COPYRIGHT section.
.PP .PP
\fBOfflineIMAP\fR may be downloaded, and information found, from its \fBOfflineIMAP\fR may be downloaded, and information found, from its
homepage via either Gopher <URL:gopher://quux.org/1/devel/offlineimap> homepage via either Gopher <URL:gopher://quux.org/1/devel/offlineimap>
or HTTP <URL:http://quux.org/devel/offlineimap>. or HTTP <URL:http://quux.org/devel/offlineimap>\&.
.PP .PP
\fBOfflineIMAP\fR may also be downloaded using Subversion. Additionally, \fBOfflineIMAP\fR may also be downloaded using Subversion. Additionally,
the distributed tar.gz may be updated with a simple "svn update" the distributed tar.gz may be updated with a simple "svn update"
command; it is ready to go. For information on getting OfflineIMAP command; it is ready to go. For information on getting OfflineIMAP
with Subversion, please visit the with Subversion, please visit the
complete.org Subversion page <URL:http://svn.complete.org/>. complete.org Subversion page <URL:http://svn.complete.org/>\&.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
\fBmutt\fR(1), \fBmutt\fR(1),
@ -958,7 +958,7 @@ The last 2.0.x release, 2.0.8, was made on July 9.
.PP .PP
Version 3.0.0 was released on July 11, 2002, and introduced Version 3.0.0 was released on July 11, 2002, and introduced
modular user interfaces and the first GUI interface for modular user interfaces and the first GUI interface for
\fBOfflineIMAP\fR. This manual also was introduced with 3.0.0, \fBOfflineIMAP\fR\&. This manual also was introduced with 3.0.0,
along with many command-line options. Version 3.1.0 was along with many command-line options. Version 3.1.0 was
released on July 21, adding the Noninteractive user released on July 21, adding the Noninteractive user
interfaces, profiling support, and several bugfixes. 3.2.0 interfaces, profiling support, and several bugfixes. 3.2.0