File: guile-procedures.texi

package info (click to toggle)
mailutils 1%3A2.99.98-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 31,016 kB
  • ctags: 18,412
  • sloc: ansic: 159,406; sh: 73,526; yacc: 5,832; cpp: 3,827; makefile: 2,902; lex: 2,046; python: 1,652; exp: 1,262; lisp: 782; awk: 200; sed: 31
file content (502 lines) | stat: -rw-r--r-- 15,416 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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502

mu-address-get-personal
@c snarfed from mu_address.c:73
@deffn {Scheme Procedure} mu-address-get-personal address [num]
Return personal part of the @var{num}th email address from @var{address}.

@end deffn

mu-address-get-comments
@c snarfed from mu_address.c:83
@deffn {Scheme Procedure} mu-address-get-comments address [num]
Return comment part of the @var{num}th email address from @var{address}.

@end deffn

mu-address-get-email
@c snarfed from mu_address.c:93
@deffn {Scheme Procedure} mu-address-get-email address [num]
Return email part of the @var{num}th email address from @var{address}.

@end deffn

mu-address-get-domain
@c snarfed from mu_address.c:103
@deffn {Scheme Procedure} mu-address-get-domain address [num]
Return domain part of the @var{num}th email address from @var{address}.

@end deffn

mu-address-get-local
@c snarfed from mu_address.c:113
@deffn {Scheme Procedure} mu-address-get-local address [num]
Return local part of the @var{num}th email address from @var{address}.

@end deffn

mu-address-get-count
@c snarfed from mu_address.c:123
@deffn {Scheme Procedure} mu-address-get-count address
Return number of parts in email address @var{address}.

@end deffn

mu-username->email
@c snarfed from mu_address.c:150
@deffn {Scheme Procedure} mu-username->email [name]
Deduce user's email address from his username. If @var{name} is omitted, 
current username is assumed

@end deffn

mu-body?
@c snarfed from mu_body.c:100
@deffn {Scheme Procedure} mu-body? scm
Return @code{true} if @var{scm} is a Mailutils message body object.

@end deffn

mu-body-read-line
@c snarfed from mu_body.c:109
@deffn {Scheme Procedure} mu-body-read-line body
Read next line from the @var{body}.
@end deffn

mu-body-write
@c snarfed from mu_body.c:151
@deffn {Scheme Procedure} mu-body-write body text
Append @var{text} to message @var{body}.
@end deffn

mu-debug-parse
@c snarfed from mu_debug.c:24
@deffn {Scheme Procedure} mu-debug-parse spec
Parses @var{spec} and sets MU debugging level according to it.
@end deffn

mu-debug-set
@c snarfed from mu_debug.c:46
@deffn {Scheme Procedure} mu-debug-set catlist
Sets MU debug level according to @var{catlist}, which is a list of
conses: (cons category level)

@end deffn

mu-debug-get
@c snarfed from mu_debug.c:78
@deffn {Scheme Procedure} mu-debug-get [catlist [skipunset]]
Returns a list of MU debugging categories with corresponding levels.
If @var{catlist} is supplied, it is a list of category names.  In this case
only categories from this list are returned
@end deffn

mu-mailbox?
@c snarfed from mu_mailbox.c:141
@deffn {Scheme Procedure} mu-mailbox? scm
Return @code{true} if @var{scm} is a Mailutils mailbox.

@end deffn

mu-mail-directory
@c snarfed from mu_mailbox.c:150
@deffn {Scheme Procedure} mu-mail-directory [url]
Do not use this function. Use mu-user-mailbox-url instead.
@end deffn

mu-user-mailbox-url
@c snarfed from mu_mailbox.c:162
@deffn {Scheme Procedure} mu-user-mailbox-url user
Return URL of the default mailbox for user @var{user}.
@end deffn

mu-folder-directory
@c snarfed from mu_mailbox.c:186
@deffn {Scheme Procedure} mu-folder-directory [url]
If @var{url} is given, sets it as a name of the user's folder directory.
Returns the current value of the folder directory.
@end deffn

mu-mailbox-open
@c snarfed from mu_mailbox.c:214
@deffn {Scheme Procedure} mu-mailbox-open url mode
Opens the mailbox specified by @var{url}. @var{mode} is a string, consisting of
the characters described below, giving the access mode for the mailbox

@multitable @columnfractions 0.20 0.70
@headitem @var{mode} @tab Meaning
@item r @tab Open for reading.
@item w @tab Open for writing.
@item a @tab Open for appending to the end of the mailbox.
@item c @tab Create the mailbox if it does not exist.
@end multitable

@end deffn

mu-mailbox-close
@c snarfed from mu_mailbox.c:276
@deffn {Scheme Procedure} mu-mailbox-close mbox
Closes mailbox @var{mbox}.
@end deffn

mu-mailbox-get-url
@c snarfed from mu_mailbox.c:291
@deffn {Scheme Procedure} mu-mailbox-get-url mbox
Returns URL of the mailbox @var{MBOX}.
@end deffn

mu-mailbox-get-message
@c snarfed from mu_mailbox.c:312
@deffn {Scheme Procedure} mu-mailbox-get-message mbox msgno
Retrieve from message #@var{msgno} from the mailbox @var{mbox}.
@end deffn

mu-mailbox-messages-count
@c snarfed from mu_mailbox.c:338
@deffn {Scheme Procedure} mu-mailbox-messages-count mbox
Returns number of messages in the mailbox @var{mbox}.
@end deffn

mu-mailbox-expunge
@c snarfed from mu_mailbox.c:359
@deffn {Scheme Procedure} mu-mailbox-expunge mbox
Expunges deleted messages from the mailbox @var{mbox}.
@end deffn

mu-mailbox-sync
@c snarfed from mu_mailbox.c:378
@deffn {Scheme Procedure} mu-mailbox-sync mbox
Synchronize changes to @var{mbox} with its storage.
@end deffn

mu-mailbox-flush
@c snarfed from mu_mailbox.c:399
@deffn {Scheme Procedure} mu-mailbox-flush mbox [expunge]
Mark all messages in @var{mbox} as seen and synchronize all changes with its storage.  If @var{expunge} is @samp{#t}, expunge deleted messages as well.
@end deffn

mu-mailbox-append-message
@c snarfed from mu_mailbox.c:423
@deffn {Scheme Procedure} mu-mailbox-append-message mbox mesg
Appends message @var{mesg} to the mailbox @var{mbox}.
@end deffn

mu-mailbox-first-message
@c snarfed from mu_mailbox.c:460
@deffn {Scheme Procedure} mu-mailbox-first-message mbox
Returns first message from the mailbox @var{mbox}.
@end deffn

mu-mailbox-next-message
@c snarfed from mu_mailbox.c:487
@deffn {Scheme Procedure} mu-mailbox-next-message mbox
Returns next message from the mailbox @var{mbox}.
@end deffn

mu-mailbox-more-messages?
@c snarfed from mu_mailbox.c:521
@deffn {Scheme Procedure} mu-mailbox-more-messages? mbox
Returns @samp{#t} if there are more messages in the mailbox @var{mbox}
ahead of current iterator position.  Usually this function is used after
a call to @samp{mu-mailbox-first-message} or @samp{mu-mailbox-next-message}.
If not, it initializes the iterator and points it to the first message innthe mailbox.
@end deffn

mu-mailbox-get-size
@c snarfed from mu_mailbox.c:552
@deffn {Scheme Procedure} mu-mailbox-get-size mbox
Return size of the mailbox @var{mbox}.
@end deffn

mu-message?
@c snarfed from mu_message.c:180
@deffn {Scheme Procedure} mu-message? scm
Return @code{true} if @var{scm} is a Mailutils message.

@end deffn

mu-message-create
@c snarfed from mu_message.c:189
@deffn {Scheme Procedure} mu-message-create
Creates an empty message.

@end deffn

mu-message-copy
@c snarfed from mu_message.c:201
@deffn {Scheme Procedure} mu-message-copy mesg
Creates a copy of the message @var{mesg}.

@end deffn

mu-message-destroy
@c snarfed from mu_message.c:246
@deffn {Scheme Procedure} mu-message-destroy mesg
Destroys the message @var{mesg}.
@end deffn

mu-message-set-header
@c snarfed from mu_message.c:263
@deffn {Scheme Procedure} mu-message-set-header mesg header value [replace]
Sets header @var{header} of the message @var{mesg} to new @var{value}.
If @var{header} is already present in the message, its value
is replaced with the suplied one iff the optional @var{replace} is
@code{#t}. Otherwise, a new header is created and appended.
@end deffn

mu-message-get-size
@c snarfed from mu_message.c:307
@deffn {Scheme Procedure} mu-message-get-size mesg
Returns size of the message @var{mesg}
.
@end deffn

mu-message-get-lines
@c snarfed from mu_message.c:322
@deffn {Scheme Procedure} mu-message-get-lines mesg
Returns number of lines in the message @var{msg}.

@end deffn

mu-message-get-envelope
@c snarfed from mu_message.c:364
@deffn {Scheme Procedure} mu-message-get-envelope mesg
Returns envelope date of the message @var{mesg}.

@end deffn

mu-message-get-envelope-date
@c snarfed from mu_message.c:399
@deffn {Scheme Procedure} mu-message-get-envelope-date mesg
Returns envelope date of the message @var{mesg}.

@end deffn

mu-message-get-sender
@c snarfed from mu_message.c:429
@deffn {Scheme Procedure} mu-message-get-sender mesg
Returns email address of the sender of the message @var{mesg}.

@end deffn

mu-message-get-header
@c snarfed from mu_message.c:456
@deffn {Scheme Procedure} mu-message-get-header mesg header
Returns value of the header @var{header} from the message @var{mesg}.

@end deffn

mu-message-get-header-fields
@c snarfed from mu_message.c:501
@deffn {Scheme Procedure} mu-message-get-header-fields mesg [headers]
Returns list of headers in the message @var{mesg}. optional argument
@var{headers} gives a list of header names to restrict return value to.

@end deffn

mu-message-set-header-fields
@c snarfed from mu_message.c:569
@deffn {Scheme Procedure} mu-message-set-header-fields mesg list [replace]
Set headers in the message @var{mesg} to those listed in @var{list},
which is a list of conses @code{(cons @var{header} @var{value})}.

Optional parameter @var{replace} specifies whether new header
values should replace the headers already present in the
message.
@end deffn

mu-message-delete
@c snarfed from mu_message.c:622
@deffn {Scheme Procedure} mu-message-delete mesg [flag]
Mark message @var{mesg} as deleted. Optional argument @var{flag} allows to
toggle the deletion mark. The message is deleted if it is @code{#t} and
undeleted if it is @code{#f}.
@end deffn

mu-message-get-flag
@c snarfed from mu_message.c:657
@deffn {Scheme Procedure} mu-message-get-flag mesg flag
Return the value of the attribute @var{flag} of the message @var{mesg}.
@end deffn

mu-message-set-flag
@c snarfed from mu_message.c:719
@deffn {Scheme Procedure} mu-message-set-flag mesg flag [value]
Set the attribute @var{flag} in message @var{mesg}. If optional @var{value}
is @samp{#f}, the attribute is unset.

@end deffn

mu-message-get-user-flag
@c snarfed from mu_message.c:816
@deffn {Scheme Procedure} mu-message-get-user-flag mesg flag
Return value of the user-defined attribute @var{flag} from the message @var{mesg}.
@end deffn

mu-message-set-user-flag
@c snarfed from mu_message.c:839
@deffn {Scheme Procedure} mu-message-set-user-flag mesg flag [value]
Set user-defined attribute @var{flag} in the message @var{mesg}.
If optional argumen @var{value} is @samp{#f}, the attribute is unset.
@end deffn

mu-message-get-port
@c snarfed from mu_message.c:878
@deffn {Scheme Procedure} mu-message-get-port mesg mode [full]
Returns a port associated with the message @var{mesg}. The @var{mode} is a
string defining operation mode of the stream. It may contain any of the
two characters: @samp{r} for reading, @samp{w} for writing.
If optional argument @var{full} is specified, it should be a boolean value.
If it is @samp{#t} then the returned port will allow access to any
part of the message (including headers). If it is @code{#f} then the port
accesses only the message body (the default).

@end deffn

mu-message-get-body
@c snarfed from mu_message.c:928
@deffn {Scheme Procedure} mu-message-get-body mesg
Returns message body for the message @var{mesg}.
@end deffn

mu-message-multipart?
@c snarfed from mu_message.c:946
@deffn {Scheme Procedure} mu-message-multipart? mesg
Returns @code{#t} if @var{mesg} is a multipart @acronym{MIME} message.
@end deffn

mu-message-get-num-parts
@c snarfed from mu_message.c:962
@deffn {Scheme Procedure} mu-message-get-num-parts mesg
Returns number of parts in a multipart @acronym{MIME} message @var{mesg}.
Returns @code{#f} if the argument is not a multipart message.
@end deffn

mu-message-get-part
@c snarfed from mu_message.c:987
@deffn {Scheme Procedure} mu-message-get-part mesg part
Returns part #@var{part} of a multipart @acronym{MIME} message @var{mesg}.
@end deffn

mu-message-send
@c snarfed from mu_message.c:1016
@deffn {Scheme Procedure} mu-message-send mesg [mailer [from [to]]]
Sends message @var{mesg}. Optional @var{mailer} overrides default mailer
settings. Optional @var{from} and @var{to} give sender and recever
addresses, respectively.

@end deffn

mu-message-get-uid
@c snarfed from mu_message.c:1098
@deffn {Scheme Procedure} mu-message-get-uid mesg
Returns UID of the message @var{mesg}

@end deffn

mu-mime?
@c snarfed from mu_mime.c:93
@deffn {Scheme Procedure} mu-mime? scm
Return @code{true} if @var{scm} is a Mailutils MIME object.

@end deffn

mu-mime-create
@c snarfed from mu_mime.c:105
@deffn {Scheme Procedure} mu-mime-create [flags [mesg]]
Creates a new @acronym{MIME} object.  Both arguments are optional.
@var{Flags} specifies the type of the object to create (@samp{0} is a
reasonable value).  @var{mesg} gives the message to create the
@acronym{MIME} object from.
@end deffn

mu-mime-multipart?
@c snarfed from mu_mime.c:141
@deffn {Scheme Procedure} mu-mime-multipart? mime
Returns @code{#t} if @var{mime} is a multipart object.

@end deffn

mu-mime-get-num-parts
@c snarfed from mu_mime.c:151
@deffn {Scheme Procedure} mu-mime-get-num-parts mime
Returns number of parts in the @acronym{MIME} object @var{mime}.
@end deffn

mu-mime-get-part
@c snarfed from mu_mime.c:170
@deffn {Scheme Procedure} mu-mime-get-part mime num
Returns @var{num}th part from the @acronym{MIME} object @var{mime}.
@end deffn

mu-mime-add-part
@c snarfed from mu_mime.c:192
@deffn {Scheme Procedure} mu-mime-add-part mime mesg
Adds message @var{mesg} to the @acronym{MIME} object @var{mime}.
@end deffn

mu-mime-get-message
@c snarfed from mu_mime.c:218
@deffn {Scheme Procedure} mu-mime-get-message mime
Converts @acronym{MIME} object @var{mime} to a message.

@end deffn

mu-openlog
@c snarfed from mu_logger.c:28
@deffn {Scheme Procedure} mu-openlog ident option facility
Opens a connection to the system logger for Guile program.
@var{ident}, @var{option} and @var{facility} have the same meaning as in openlog(3)
@end deffn

mu-logger
@c snarfed from mu_logger.c:45
@deffn {Scheme Procedure} mu-logger prio text
Distributes @var{text} via the syslog priority @var{prio}.
@end deffn

mu-closelog
@c snarfed from mu_logger.c:64
@deffn {Scheme Procedure} mu-closelog
Closes the channel to the system logger opened by @code{mu-openlog}.
@end deffn

mu-register-format
@c snarfed from mu_scm.c:109
@deffn {Scheme Procedure} mu-register-format . rest
Registers desired mailutils formats.  Any number of arguments can be given.
Each argument must be one of the following strings:

@multitable @columnfractions 0.3 0.6
@headitem Argument @tab Meaning
@item @samp{mbox}  @tab Regular UNIX mbox format
@item @samp{mh}    @tab @acronym{MH} mailbox format
@item @samp{maildir} @tab @i{Maildir} mailbox format
@item @samp{pop}   @tab @acronym{POP} mailbox format
@item @samp{imap}  @tab @acronym{IMAP} mailbox format
@item @samp{sendmail} @tab @i{sendmail} mailer format
@item @samp{smtp}  @tab @acronym{SMTP} mailer format
@end multitable

If called without arguments, the function registers all available formats

@end deffn

mu-strerror
@c snarfed from mu_scm.c:145
@deffn {Scheme Procedure} mu-strerror err
Return the error message corresponding to @var{err}, which must be
an integer value.

@end deffn

mu-getpwuid
@c snarfed from mu_util.c:28
@deffn {Scheme Procedure} mu-getpwuid user
Look up an entry in the user database. @var{User} can be an integer,
or a string, giving the behaviour of @code{mu_get_auth_by_uid} or
@code{mu_get_auth_by_name} respectively.

Returns a vector with fields corresponding to those of the @code{mu_auth_data}
entry in question. If no matching entry was found, returns @code{#f}.

@end deffn