File: pythonms.1

package info (click to toggle)
pms 0.2.19-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 456 kB
  • ctags: 389
  • sloc: python: 2,655; makefile: 59; sh: 24
file content (185 lines) | stat: -rw-r--r-- 3,506 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
.TH PMS "An MUA Framework in Python"
.SH NAME
pms \- run a mail command

pythonms \- run a Python interpreter with all the functions in PMS.Commands
            in the current namespace
.SH SYNOPSIS
.B pms <command> <args>

.B pythonms

.SH QUICK INTRODUCTION

.PP
In order to start using PMS, some directories need to be initialized.
In order to start using PMS, the easiest way to create them is to
use

.PP
.B pms init

.PP
While this will initialize the directories, it will not allow you to
read e-mail from the spool -- PMS does not currently support unix mail
boxes. If you are using an MH-like setup, where your mail is in
.B ~/Mail/inbox,
the following commands should get you started:

.PP
.B pms server default;pms server inbox

.SH DESCRIPTION
For 
.B pms,
the following commands are available
.PP
.TP
.B comp [-without_sig] 
\- Compose a message.

.TP
.B cp 
.I folder [server]
\- copy the current message to another folder

.TP
.B cpall 
.I folder [server]
\- copy all messages to another folder

.TP
.B create
\- Create the current folder

.TP
.B current 
\- Print the current folder and message: useful inside prompts.

.TP 
.B edit 
.I draft_number 
.B 
\- Edit an existing draft

.TP
.B folder [-relative] [-push] 
.I name 
\- Change folder

.TP
.B forw [-without_sig] 
\- Forward the current message

.TP
.B from 
.I [sender]
\- Limit to the messages with a given sender.
If sender is not given, the sender of the current message is assumed.

.TP
.B i 
.I number
\- Change the current message

.TP
.B init
\- Initialize the files needed for a user.

.TP
.B label
.I name [numbers [...]]
\- Label the current message

.TP
.B labels
.I [name]
\- If name is not given, label of current message is assumed.

.TP
.B m 
\- Go to previous message.

.TP
.B mv 
.I folder [server]
\- move current message to another folder

.TP
.B mvall 
.I folder [server]
\- move all messages to another folder

.TP
.B p 
\- Go to next message

.TP
.B pop 
\- Pop the current folder off the stack.

.TP
.B recursive 
\- Push on the folder stack a folder whose messages are the messages
in the current folder, plus those in all the children.

.TP 
.B repl [-without_sig] [-to_all] [-group] [-no_include_text] 
\- Reply to current message

.TP
.B replies 
\- Limit to the replies to the current message.

.TP 
.B resync 
\- Resynchronize the folder with the messages actually in it, in case
some other program changes the folder.

.TP
.B rm 
.I [range [range ...]] 
\- Remove the current message, or given messages if any.

.TP
.B rmall
\- remove all messages in current folder

.TP
.B scan [-summary] [-folder_only] [-recursive] 
\- Report on the messages in the current folder

.TP
.B s (subject|from|date) 
\- Sort according to criterion

.TP
.B server 
.I name [folder]
\- Change the default server. If there is no current folder for the server
the current folder will be by default 'inbox', unless
.I folder
is given

.TP
.B show [-headers_only] [-full_headers] 
\- Show message.

.TP
.B subject 
.I [name]
\- Limit to messages with given subject, or the current subject if none given

.TP
.B subset
.I [range [range ...]] 
\- limit to messages whose indices fall within the specified ranges

.PP
Inside pythonms, the following functions are available:

comp create delete edit edit_actions folder forward index label limit_from
limit_label limit_replies limit_subject minus plus pop recursive refile
remove repl save_draft scan send server show sort_date sort_from sort_subject

All of them have docstrings