Commit 60ff7f3f 60ff7f3fce1f4d10bbae1bad431e0bb26d4a33c5 by Sergey Poznyakoff

Add to the repo

1 parent 05a52ebe
1 @c snarfed from "mu_address.c":79
2 @deffn {Scheme procedure} mu-address-get-personal address num
3 Return personal part of the @var{num}th email address from @var{address}.
4
5 @end deffn
6
7 @c snarfed from "mu_address.c":89
8 @deffn {Scheme procedure} mu-address-get-comments address num
9 Return comment part of the @var{num}th email address from @var{address}.
10
11 @end deffn
12
13 @c snarfed from "mu_address.c":99
14 @deffn {Scheme procedure} mu-address-get-email address num
15 Return email part of the @var{num}th email address from @var{address}.
16
17 @end deffn
18
19 @c snarfed from "mu_address.c":109
20 @deffn {Scheme procedure} mu-address-get-domain address num
21 Return domain part of the @var{num}th email address from @var{address}.
22
23 @end deffn
24
25 @c snarfed from "mu_address.c":119
26 @deffn {Scheme procedure} mu-address-get-local address num
27 Return local part of the @var{num}th email address from @var{address}.
28
29 @end deffn
30
31 @c snarfed from "mu_address.c":129
32 @deffn {Scheme procedure} mu-address-get-count address
33 Return number of parts in email address @var{address}.
34
35 @end deffn
36
37 @c snarfed from "mu_address.c":153
38 @deffn {Scheme procedure} mu-username->email name
39 Deduce user's email address from his username. If @var{name} is omitted,
40 current username is assumed
41
42 @end deffn
43
1 @c snarfed from "mu_body.c":106
2 @deffn {Scheme procedure} mu-body-read-line body
3 Read next line from the @var{body}.
4 @end deffn
5
6 @c snarfed from "mu_body.c":167
7 @deffn {Scheme procedure} mu-body-write body text
8 Append @var{text} to message @var{body}.
9 @end deffn
10
1 @c snarfed from "mu_logger.c":26
2 @deffn {Scheme procedure} mu-openlog ident option facility
3 Opens a connection to the system logger for Guile program.
4 @var{ident}, @var{option} and @var{facility} have the same meaning as in openlog(3)
5 @end deffn
6
7 @c snarfed from "mu_logger.c":61
8 @deffn {Scheme procedure} mu-logger prio text
9 Distributes @var{text} via syslogd priority @var{prio}.
10 @end deffn
11
12 @c snarfed from "mu_logger.c":83
13 @deffn {Scheme procedure} mu-closelog
14 Closes the channel to the system logger opened by @code{mu-openlog}.
15 @end deffn
16
1 @c snarfed from "mu_mailbox.c":110
2 @deffn {Scheme procedure} mu-mail-directory url
3 If @var{url} is given, sets it as a name of the user's mail directory.
4 Returns the current value of the mail directory.
5 @end deffn
6
7 @c snarfed from "mu_mailbox.c":125
8 @deffn {Scheme procedure} mu-folder-directory url
9 If @var{url} is given, sets it as a name of the user's folder directory.
10 Returns the current value of the folder directory.
11 @end deffn
12
13 @c snarfed from "mu_mailbox.c":149
14 @deffn {Scheme procedure} mu-mailbox-open url mode
15 Opens the mailbox specified by @var{url}. @var{mode} is a string, consisting of
16 the characters described below, giving the access mode for the mailbox
17
18 @multitable @columnfractions 0.20 0.70
19 @headitem @var{mode} @tab Meaning
20 @item r @tab Open for reading.
21 @item w @tab Open for writing.
22 @item a @tab Open for appending to the end of the mailbox.
23 @item c @tab Create the mailbox if it does not exist.
24 @end multitable
25
26 @end deffn
27
28 @c snarfed from "mu_mailbox.c":201
29 @deffn {Scheme procedure} mu-mailbox-close mbox
30 Closes mailbox @var{mbox}.
31 @end deffn
32
33 @c snarfed from "mu_mailbox.c":216
34 @deffn {Scheme procedure} mu-mailbox-get-url mbox
35 Returns url of the mailbox @var{mbox}.
36 @end deffn
37
38 @c snarfed from "mu_mailbox.c":240
39 @deffn {Scheme procedure} mu-mailbox-get-port mbox mode
40 Returns a port associated with the contents of the @var{mbox}.
41 @var{mode} is a string defining operation mode of the stream. It may
42 contain any of the two characters: @samp{r} for reading, @samp{w} for
43 writing.
44
45 @end deffn
46
47 @c snarfed from "mu_mailbox.c":262
48 @deffn {Scheme procedure} mu-mailbox-get-message mbox msgno
49 Retrieve from message #@var{msgno} from the mailbox @var{mbox}.
50 @end deffn
51
52 @c snarfed from "mu_mailbox.c":288
53 @deffn {Scheme procedure} mu-mailbox-messages-count mbox
54 Returns number of messages in the mailbox @var{mbox}.
55 @end deffn
56
57 @c snarfed from "mu_mailbox.c":309
58 @deffn {Scheme procedure} mu-mailbox-expunge mbox
59 Expunges deleted messages from the mailbox @var{mbox}.
60 @end deffn
61
62 @c snarfed from "mu_mailbox.c":328
63 @deffn {Scheme procedure} mu-mailbox-append-message mbox mesg
64 Appends message @var{mesg} to the mailbox @var{mbox}.
65 @end deffn
66
1 @c snarfed from "mu_message.c":184
2 @deffn {Scheme procedure} mu-message-create
3 Creates an empty message.
4
5 @end deffn
6
7 @c snarfed from "mu_message.c":196
8 @deffn {Scheme procedure} mu-message-copy mesg
9 Creates the copy of the message @var{mesg}.
10
11 @end deffn
12
13 @c snarfed from "mu_message.c":257
14 @deffn {Scheme procedure} mu-message-destroy mesg
15 Destroys the message @var{mesg}.
16 @end deffn
17
18 @c snarfed from "mu_message.c":274
19 @deffn {Scheme procedure} mu-message-set-header mesg header value replace
20 Sets new @var{value} to the header @var{header} of the message @var{mesg}.
21 If @var{header} is already present in the message its value
22 is replaced with the suplied one iff the optional @var{replace} is
23 #t. Otherwise, a new header is created and appended.
24 @end deffn
25
26 @c snarfed from "mu_message.c":314
27 @deffn {Scheme procedure} mu-message-get-size mesg
28 Returns the size of the message @var{mesg}
29 .
30 @end deffn
31
32 @c snarfed from "mu_message.c":328
33 @deffn {Scheme procedure} mu-message-get-lines mesg
34 Returns number of lines in the given message.
35
36 @end deffn
37
38 @c snarfed from "mu_message.c":349
39 @deffn {Scheme procedure} mu-message-get-sender mesg
40 Returns email address of the sender of the message @var{mesg}.
41
42 @end deffn
43
44 @c snarfed from "mu_message.c":376
45 @deffn {Scheme procedure} mu-message-get-header mesg header
46 Returns value of the header @var{header} from the message @var{mesg}.
47
48 @end deffn
49
50 @c snarfed from "mu_message.c":433
51 @deffn {Scheme procedure} mu-message-get-header-fields mesg headers
52 Returns the list of headers in the message @var{mesg}. Optional argument
53 @var{headers} gives a list of header names to restrict return value to.
54
55 @end deffn
56
57 @c snarfed from "mu_message.c":510
58 @deffn {Scheme procedure} mu-message-set-header-fields mesg list replace
59 Set the headers in the message @var{mesg} from @var{list}
60 @var{list} is a list of conses (cons HEADER VALUE). The function sets
61 these headers in the message @var{mesg}.
62 Optional parameter @var{replace} specifies whether the new header
63 values should replace the headers already present in the
64 message.
65 @end deffn
66
67 @c snarfed from "mu_message.c":564
68 @deffn {Scheme procedure} mu-message-delete mesg flag
69 Mark the message @var{mesg} as deleted. Optional argument @var{flag} allows to toggle
70 deletion mark. The message is deleted if it is @code{#t} and undeleted if
71 it is @code{#f}
72 @end deffn
73
74 @c snarfed from "mu_message.c":600
75 @deffn {Scheme procedure} mu-message-get-flag mesg flag
76 Return value of the attribute @var{flag} of the message @var{mesg}.
77 @end deffn
78
79 @c snarfed from "mu_message.c":662
80 @deffn {Scheme procedure} mu-message-set-flag mesg flag value
81 Set the attribute @var{flag} of the message @var{mesg}. If optional @var{value} is #f, the
82 attribute is unset.
83 @end deffn
84
85 @c snarfed from "mu_message.c":760
86 @deffn {Scheme procedure} mu-message-get-user-flag mesg flag
87 Return the value of the user attribute @var{flag} from the message @var{mesg}.
88 @end deffn
89
90 @c snarfed from "mu_message.c":783
91 @deffn {Scheme procedure} mu-message-set-user-flag mesg flag value
92 Set the given user attribute @var{flag} in the message @var{mesg}. If optional argumen
93 @var{value} is @samp{#f}, the attribute is unset.
94 @end deffn
95
96 @c snarfed from "mu_message.c":823
97 @deffn {Scheme procedure} mu-message-get-port mesg mode full
98 Returns a port associated with the given @var{mesg}. @var{mode} is a string
99 defining operation mode of the stream. It may contain any of the
100 two characters: @samp{r} for reading, @samp{w} for writing.
101 If optional argument @var{full} is specified, it should be a boolean value.
102 If it is @samp{#t} then the returned port will allow access to any
103 part of the message (including headers). If it is @code{#f} then the port
104 accesses only the message body (the default).
105
106 @end deffn
107
108 @c snarfed from "mu_message.c":870
109 @deffn {Scheme procedure} mu-message-get-body mesg
110 Returns the message body for the message @var{mesg}.
111 @end deffn
112
113 @c snarfed from "mu_message.c":888
114 @deffn {Scheme procedure} mu-message-multipart? mesg
115 Returns @code{#t} if @var{mesg} is a multipart @acronym{MIME} message.
116 @end deffn
117
118 @c snarfed from "mu_message.c":904
119 @deffn {Scheme procedure} mu-message-get-num-parts mesg
120 Returns number of parts in a multipart @acronym{MIME} message. Returns
121 @code{#f} if the argument is not a multipart message.
122 @end deffn
123
124 @c snarfed from "mu_message.c":929
125 @deffn {Scheme procedure} mu-message-get-part mesg part
126 Returns part #@var{part} from a multipart @acronym{MIME} message @var{mesg}.
127 @end deffn
128
129 @c snarfed from "mu_message.c":957
130 @deffn {Scheme procedure} mu-message-send mesg mailer from to
131 Sends the message @var{mesg}. Optional @var{mailer} overrides default mailer settings
132 in mu-mailer. Optional @var{from} and @var{to} give sender and recever addresses.
133
134 @end deffn
135
136 @c snarfed from "mu_message.c":1025
137 @deffn {Scheme procedure} mu-message-get-uid mesg
138 Returns uid of the message @var{mesg}
139
140 @end deffn
141
1 @c snarfed from "mu_mime.c":95
2 @deffn {Scheme procedure} mu-mime-create flags mesg
3 Creates a new @acronym{MIME} object. Both arguments are optional.
4 @var{flags} specifies the type of the object to create (@samp{0} is a reasonable
5 value). @var{mesg} gives the message to create the @acronym{MIME} object from.
6 @end deffn
7
8 @c snarfed from "mu_mime.c":131
9 @deffn {Scheme procedure} mu-mime-multipart? mime
10 Returns @code{#t} if @var{mime} is a multipart object.
11
12 @end deffn
13
14 @c snarfed from "mu_mime.c":141
15 @deffn {Scheme procedure} mu-mime-get-num-parts mime
16 Returns number of parts in the @sc{mime} object @var{mime}.
17 @end deffn
18
19 @c snarfed from "mu_mime.c":160
20 @deffn {Scheme procedure} mu-mime-get-part mime num
21 Returns @var{num}th part from the @sc{mime} object @var{mime}.
22 @end deffn
23
24 @c snarfed from "mu_mime.c":182
25 @deffn {Scheme procedure} mu-mime-add-part mime mesg
26 Adds @var{mesg} to the @sc{mime} object @var{mime}.
27 @end deffn
28
29 @c snarfed from "mu_mime.c":208
30 @deffn {Scheme procedure} mu-mime-get-message mime
31 Converts @sc{mime} object @var{mime} to a message.
32
33 @end deffn
34
1 @c snarfed from "mu_scm.c":130
2 @deffn {Scheme procedure} mu-register-format rest
3 Registers desired mailutils formats. Any number of arguments can be given.
4 Each argument must be one of the following strings:
5
6 @multitable @columnfractions 0.3 0.6
7 @headitem Argument @tab Meaning
8 @item @samp{mbox} @tab Regular UNIX mbox format
9 @item @samp{mh} @tab @acronym{MH} mailbox format
10 @item @samp{maildir} @tab @i{Maildir} mailbox format
11 @item @samp{pop} @tab @acronym{POP} mailbox format
12 @item @samp{imap} @tab @acronym{IMAP} mailbox format
13 @item @samp{sendmail} @tab @i{sendmail} mailer format
14 @item @samp{smtp} @tab @acronym{SMTP} mailer format
15 @end multitable
16
17 If called without arguments, the function registers all available formats
18
19 @end deffn
20
21 @c snarfed from "mu_scm.c":163
22 @deffn {Scheme procedure} mu-strerror err
23 Return the error message corresponding to @var{err}, which must be
24 an integer value.
25
26 @end deffn
27