File: guile-procedures.txt

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 (438 lines) | stat: -rw-r--r-- 12,311 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
This is guile-procedures.txt, produced by makeinfo version 4.13 from
guile-procedures.texi.

mu-address-get-personal

 -- Scheme Procedure: mu-address-get-personal address [num]
     Return personal part of the NUMth email address from ADDRESS.


   mu-address-get-comments

 -- Scheme Procedure: mu-address-get-comments address [num]
     Return comment part of the NUMth email address from ADDRESS.


   mu-address-get-email

 -- Scheme Procedure: mu-address-get-email address [num]
     Return email part of the NUMth email address from ADDRESS.


   mu-address-get-domain

 -- Scheme Procedure: mu-address-get-domain address [num]
     Return domain part of the NUMth email address from ADDRESS.


   mu-address-get-local

 -- Scheme Procedure: mu-address-get-local address [num]
     Return local part of the NUMth email address from ADDRESS.


   mu-address-get-count

 -- Scheme Procedure: mu-address-get-count address
     Return number of parts in email address ADDRESS.


   mu-username->email

 -- Scheme Procedure: mu-username->email [name]
     Deduce user's email address from his username. If NAME is omitted,
     current username is assumed


   mu-body?

 -- Scheme Procedure: mu-body? scm
     Return `true' if SCM is a Mailutils message body object.


   mu-body-read-line

 -- Scheme Procedure: mu-body-read-line body
     Read next line from the BODY.

   mu-body-write

 -- Scheme Procedure: mu-body-write body text
     Append TEXT to message BODY.

   mu-debug-parse

 -- Scheme Procedure: mu-debug-parse spec
     Parses SPEC and sets MU debugging level according to it.

   mu-debug-set

 -- Scheme Procedure: mu-debug-set catlist
     Sets MU debug level according to CATLIST, which is a list of
     conses: (cons category level)


   mu-debug-get

 -- Scheme Procedure: mu-debug-get [catlist [skipunset]]
     Returns a list of MU debugging categories with corresponding
     levels.  If CATLIST is supplied, it is a list of category names.
     In this case only categories from this list are returned

   mu-mailbox?

 -- Scheme Procedure: mu-mailbox? scm
     Return `true' if SCM is a Mailutils mailbox.


   mu-mail-directory

 -- Scheme Procedure: mu-mail-directory [url]
     Do not use this function. Use mu-user-mailbox-url instead.

   mu-user-mailbox-url

 -- Scheme Procedure: mu-user-mailbox-url user
     Return URL of the default mailbox for user USER.

   mu-folder-directory

 -- Scheme Procedure: mu-folder-directory [url]
     If URL is given, sets it as a name of the user's folder directory.
     Returns the current value of the folder directory.

   mu-mailbox-open

 -- Scheme Procedure: mu-mailbox-open url mode
     Opens the mailbox specified by URL. MODE is a string, consisting of
     the characters described below, giving the access mode for the
     mailbox

     MODE          Meaning
     -------------------------------------------------------------- 
     r             Open for reading.
     w             Open for writing.
     a             Open for appending to the end of the mailbox.
     c             Create the mailbox if it does not exist.


   mu-mailbox-close

 -- Scheme Procedure: mu-mailbox-close mbox
     Closes mailbox MBOX.

   mu-mailbox-get-url

 -- Scheme Procedure: mu-mailbox-get-url mbox
     Returns URL of the mailbox MBOX.

   mu-mailbox-get-message

 -- Scheme Procedure: mu-mailbox-get-message mbox msgno
     Retrieve from message #MSGNO from the mailbox MBOX.

   mu-mailbox-messages-count

 -- Scheme Procedure: mu-mailbox-messages-count mbox
     Returns number of messages in the mailbox MBOX.

   mu-mailbox-expunge

 -- Scheme Procedure: mu-mailbox-expunge mbox
     Expunges deleted messages from the mailbox MBOX.

   mu-mailbox-sync

 -- Scheme Procedure: mu-mailbox-sync mbox
     Synchronize changes to MBOX with its storage.

   mu-mailbox-flush

 -- Scheme Procedure: mu-mailbox-flush mbox [expunge]
     Mark all messages in MBOX as seen and synchronize all changes with
     its storage.  If EXPUNGE is `#t', expunge deleted messages as well.

   mu-mailbox-append-message

 -- Scheme Procedure: mu-mailbox-append-message mbox mesg
     Appends message MESG to the mailbox MBOX.

   mu-mailbox-first-message

 -- Scheme Procedure: mu-mailbox-first-message mbox
     Returns first message from the mailbox MBOX.

   mu-mailbox-next-message

 -- Scheme Procedure: mu-mailbox-next-message mbox
     Returns next message from the mailbox MBOX.

   mu-mailbox-more-messages?

 -- Scheme Procedure: mu-mailbox-more-messages? mbox
     Returns `#t' if there are more messages in the mailbox MBOX ahead
     of current iterator position.  Usually this function is used after
     a call to `mu-mailbox-first-message' or `mu-mailbox-next-message'.
     If not, it initializes the iterator and points it to the first
     message innthe mailbox.

   mu-mailbox-get-size

 -- Scheme Procedure: mu-mailbox-get-size mbox
     Return size of the mailbox MBOX.

   mu-message?

 -- Scheme Procedure: mu-message? scm
     Return `true' if SCM is a Mailutils message.


   mu-message-create

 -- Scheme Procedure: mu-message-create
     Creates an empty message.


   mu-message-copy

 -- Scheme Procedure: mu-message-copy mesg
     Creates a copy of the message MESG.


   mu-message-destroy

 -- Scheme Procedure: mu-message-destroy mesg
     Destroys the message MESG.

   mu-message-set-header

 -- Scheme Procedure: mu-message-set-header mesg header value [replace]
     Sets header HEADER of the message MESG to new VALUE.  If HEADER is
     already present in the message, its value is replaced with the
     suplied one iff the optional REPLACE is `#t'. Otherwise, a new
     header is created and appended.

   mu-message-get-size

 -- Scheme Procedure: mu-message-get-size mesg
     Returns size of the message MESG .

   mu-message-get-lines

 -- Scheme Procedure: mu-message-get-lines mesg
     Returns number of lines in the message MSG.


   mu-message-get-envelope

 -- Scheme Procedure: mu-message-get-envelope mesg
     Returns envelope date of the message MESG.


   mu-message-get-envelope-date

 -- Scheme Procedure: mu-message-get-envelope-date mesg
     Returns envelope date of the message MESG.


   mu-message-get-sender

 -- Scheme Procedure: mu-message-get-sender mesg
     Returns email address of the sender of the message MESG.


   mu-message-get-header

 -- Scheme Procedure: mu-message-get-header mesg header
     Returns value of the header HEADER from the message MESG.


   mu-message-get-header-fields

 -- Scheme Procedure: mu-message-get-header-fields mesg [headers]
     Returns list of headers in the message MESG. optional argument
     HEADERS gives a list of header names to restrict return value to.


   mu-message-set-header-fields

 -- Scheme Procedure: mu-message-set-header-fields mesg list [replace]
     Set headers in the message MESG to those listed in LIST, which is
     a list of conses `(cons HEADER VALUE)'.

     Optional parameter REPLACE specifies whether new header values
     should replace the headers already present in the message.

   mu-message-delete

 -- Scheme Procedure: mu-message-delete mesg [flag]
     Mark message MESG as deleted. Optional argument FLAG allows to
     toggle the deletion mark. The message is deleted if it is `#t' and
     undeleted if it is `#f'.

   mu-message-get-flag

 -- Scheme Procedure: mu-message-get-flag mesg flag
     Return the value of the attribute FLAG of the message MESG.

   mu-message-set-flag

 -- Scheme Procedure: mu-message-set-flag mesg flag [value]
     Set the attribute FLAG in message MESG. If optional VALUE is `#f',
     the attribute is unset.


   mu-message-get-user-flag

 -- Scheme Procedure: mu-message-get-user-flag mesg flag
     Return value of the user-defined attribute FLAG from the message
     MESG.

   mu-message-set-user-flag

 -- Scheme Procedure: mu-message-set-user-flag mesg flag [value]
     Set user-defined attribute FLAG in the message MESG.  If optional
     argumen VALUE is `#f', the attribute is unset.

   mu-message-get-port

 -- Scheme Procedure: mu-message-get-port mesg mode [full]
     Returns a port associated with the message MESG. The MODE is a
     string defining operation mode of the stream. It may contain any
     of the two characters: `r' for reading, `w' for writing.  If
     optional argument FULL is specified, it should be a boolean value.
     If it is `#t' then the returned port will allow access to any part
     of the message (including headers). If it is `#f' then the port
     accesses only the message body (the default).


   mu-message-get-body

 -- Scheme Procedure: mu-message-get-body mesg
     Returns message body for the message MESG.

   mu-message-multipart?

 -- Scheme Procedure: mu-message-multipart? mesg
     Returns `#t' if MESG is a multipart MIME message.

   mu-message-get-num-parts

 -- Scheme Procedure: mu-message-get-num-parts mesg
     Returns number of parts in a multipart MIME message MESG.  Returns
     `#f' if the argument is not a multipart message.

   mu-message-get-part

 -- Scheme Procedure: mu-message-get-part mesg part
     Returns part #PART of a multipart MIME message MESG.

   mu-message-send

 -- Scheme Procedure: mu-message-send mesg [mailer [from [to]]]
     Sends message MESG. Optional MAILER overrides default mailer
     settings. Optional FROM and TO give sender and recever addresses,
     respectively.


   mu-message-get-uid

 -- Scheme Procedure: mu-message-get-uid mesg
     Returns UID of the message MESG


   mu-mime?

 -- Scheme Procedure: mu-mime? scm
     Return `true' if SCM is a Mailutils MIME object.


   mu-mime-create

 -- Scheme Procedure: mu-mime-create [flags [mesg]]
     Creates a new MIME object.  Both arguments are optional.  FLAGS
     specifies the type of the object to create (`0' is a reasonable
     value).  MESG gives the message to create the MIME object from.

   mu-mime-multipart?

 -- Scheme Procedure: mu-mime-multipart? mime
     Returns `#t' if MIME is a multipart object.


   mu-mime-get-num-parts

 -- Scheme Procedure: mu-mime-get-num-parts mime
     Returns number of parts in the MIME object MIME.

   mu-mime-get-part

 -- Scheme Procedure: mu-mime-get-part mime num
     Returns NUMth part from the MIME object MIME.

   mu-mime-add-part

 -- Scheme Procedure: mu-mime-add-part mime mesg
     Adds message MESG to the MIME object MIME.

   mu-mime-get-message

 -- Scheme Procedure: mu-mime-get-message mime
     Converts MIME object MIME to a message.


   mu-openlog

 -- Scheme Procedure: mu-openlog ident option facility
     Opens a connection to the system logger for Guile program.  IDENT,
     OPTION and FACILITY have the same meaning as in openlog(3)

   mu-logger

 -- Scheme Procedure: mu-logger prio text
     Distributes TEXT via the syslog priority PRIO.

   mu-closelog

 -- Scheme Procedure: mu-closelog
     Closes the channel to the system logger opened by `mu-openlog'.

   mu-register-format

 -- 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:

     Argument             Meaning
     -------------------------------------------------------------- 
     `mbox'               Regular UNIX mbox format
     `mh'                 MH mailbox format
     `maildir'            Maildir mailbox format
     `pop'                POP mailbox format
     `imap'               IMAP mailbox format
     `sendmail'           sendmail mailer format
     `smtp'               SMTP mailer format

     If called without arguments, the function registers all available
     formats


   mu-strerror

 -- Scheme Procedure: mu-strerror err
     Return the error message corresponding to ERR, which must be an
     integer value.


   mu-getpwuid

 -- Scheme Procedure: mu-getpwuid user
     Look up an entry in the user database. USER can be an integer, or
     a string, giving the behaviour of `mu_get_auth_by_uid' or
     `mu_get_auth_by_name' respectively.

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