30 |
@node Address Functions |
@node Address Functions |
31 |
@section Address Functions |
@section Address Functions |
32 |
|
|
33 |
@deffn Function mu-address-get-personal ADDRESS NUM |
@deffn {Scheme Function} mu-address-get-personal ADDRESS NUM |
34 |
Return personal part of an email address. |
Return personal part of an email address. |
35 |
@end deffn |
@end deffn |
36 |
|
|
37 |
@deffn Function mu-address-get-comments ADDRESS NUM |
@deffn {Scheme Function} mu-address-get-comments ADDRESS NUM |
38 |
@end deffn |
@end deffn |
39 |
|
|
40 |
@deffn Function mu-address-get-email ADDRESS NUM |
@deffn {Scheme Function} mu-address-get-email ADDRESS NUM |
41 |
Return email part of an email address. |
Return email part of an email address. |
42 |
@end deffn |
@end deffn |
43 |
|
|
44 |
@deffn Function mu-address-get-domain ADDRESS NUM |
@deffn {Scheme Function} mu-address-get-domain ADDRESS NUM |
45 |
Return domain part of an email address |
Return domain part of an email address |
46 |
@end deffn |
@end deffn |
47 |
|
|
48 |
@deffn Function mu-address-get-local ADDRESS NUM |
@deffn {Scheme Function} mu-address-get-local ADDRESS NUM |
49 |
Return local part of an email address. |
Return local part of an email address. |
50 |
@end deffn |
@end deffn |
51 |
|
|
52 |
@deffn Function mu-address-get-count ADDRESS |
@deffn {Scheme Function} mu-address-get-count ADDRESS |
53 |
Return number of parts in email address. |
Return number of parts in email address. |
54 |
@end deffn |
@end deffn |
55 |
|
|
56 |
@node Mailbox Functions |
@node Mailbox Functions |
57 |
@section Mailbox Functions |
@section Mailbox Functions |
58 |
|
|
59 |
@deffn Function mu-mailbox-open URL MODE |
@deffn {Scheme Function} mu-mailbox-open URL MODE |
60 |
Opens a mailbox specified by URL. |
Opens a mailbox specified by URL. |
61 |
@end deffn |
@end deffn |
62 |
|
|
63 |
@deffn Function mu-mailbox-close MBOX |
@deffn {Scheme Function} mu-mailbox-close MBOX |
64 |
Closes mailbox MBOX |
Closes mailbox MBOX |
65 |
@end deffn |
@end deffn |
66 |
|
|
67 |
@deffn Function mu-mailbox-get-url MBOX |
@deffn {Scheme Function} mu-mailbox-get-url MBOX |
68 |
Returns the URL of the mailbox. |
Returns the URL of the mailbox. |
69 |
@end deffn |
@end deffn |
70 |
|
|
71 |
@deffn Function mu-mailbox-get-port MBOX MODE |
@deffn {Scheme Function} mu-mailbox-get-port MBOX MODE |
72 |
Returns a port associated with the contents of the MBOX. |
Returns a port associated with the contents of the MBOX. |
73 |
MODE is a string defining operation mode of the stream. It may |
MODE is a string defining operation mode of the stream. It may |
74 |
contain any of the two characters: @samp{r} for reading, @samp{w} for |
contain any of the two characters: @samp{r} for reading, @samp{w} for |
75 |
writing. |
writing. |
76 |
@end deffn |
@end deffn |
77 |
|
|
78 |
@deffn Function mu-mailbox-get-message MBOX MSGNO |
@deffn {Scheme Function} mu-mailbox-get-message MBOX MSGNO |
79 |
Retrieve from MBOX message # MSGNO. |
Retrieve from MBOX message # MSGNO. |
80 |
@end deffn |
@end deffn |
81 |
|
|
82 |
@deffn Function mu-mailbox-messages-count MBOX |
@deffn {Scheme Function} mu-mailbox-messages-count MBOX |
83 |
Returns number of messages in the mailbox. |
Returns number of messages in the mailbox. |
84 |
@end deffn |
@end deffn |
85 |
|
|
86 |
@deffn Function mu-mailbox-expunge MBOX |
@deffn {Scheme Function} mu-mailbox-expunge MBOX |
87 |
Expunges deleted messages from the mailbox. |
Expunges deleted messages from the mailbox. |
88 |
@end deffn |
@end deffn |
89 |
|
|
90 |
@deffn Function mu-mailbox-url MBOX |
@deffn {Scheme Function} mu-mailbox-url MBOX |
91 |
Returns the URL of the mailbox |
Returns the URL of the mailbox |
92 |
@end deffn |
@end deffn |
93 |
|
|
94 |
@deffn Function mu-mailbox-append-message MBOX MESG |
@deffn {Scheme Function} mu-mailbox-append-message MBOX MESG |
95 |
Appends the message to the mailbox |
Appends the message to the mailbox |
96 |
@end deffn |
@end deffn |
97 |
|
|
98 |
@node Message Functions |
@node Message Functions |
99 |
@section Message Functions |
@section Message Functions |
100 |
|
|
101 |
@deffn Function mu-message-copy MESG |
@deffn {Scheme Function} mu-message-copy MESG |
102 |
Creates the copy of the given message. |
Creates the copy of the given message. |
103 |
@end deffn |
@end deffn |
104 |
|
|
105 |
@deffn Function mu-message-set-header MESG HEADER VALUE REPLACE |
@deffn {Scheme Function} mu-message-set-header MESG HEADER VALUE REPLACE |
106 |
Sets new VALUE to the header HEADER of the message MESG. |
Sets new VALUE to the header HEADER of the message MESG. |
107 |
If the HEADER is already present in the message its value |
If the HEADER is already present in the message its value |
108 |
is replaced with the supplied one if the optional REPLACE is |
is replaced with the supplied one if the optional REPLACE is |
109 |
#t. Otherwise new header is created and appended. |
#t. Otherwise new header is created and appended. |
110 |
@end deffn |
@end deffn |
111 |
|
|
112 |
@deffn Function mu-message-get-size MESG |
@deffn {Scheme Function} mu-message-get-size MESG |
113 |
Returns the size of the given message. |
Returns the size of the given message. |
114 |
@end deffn |
@end deffn |
115 |
|
|
116 |
@deffn Function mu-message-get-lines MESG |
@deffn {Scheme Function} mu-message-get-lines MESG |
117 |
Returns number of lines in the given message. |
Returns number of lines in the given message. |
118 |
@end deffn |
@end deffn |
119 |
|
|
120 |
@deffn Function mu-message-get-sender MESG |
@deffn {Scheme Function} mu-message-get-sender MESG |
121 |
Returns the sender email address for the message MESG. |
Returns the sender email address for the message MESG. |
122 |
@end deffn |
@end deffn |
123 |
|
|
124 |
@deffn Function mu-message-get-header MESG HEADER |
@deffn {Scheme Function} mu-message-get-header MESG HEADER |
125 |
Returns the header value of the HEADER in the MESG. |
Returns the header value of the HEADER in the MESG. |
126 |
@end deffn |
@end deffn |
127 |
|
|
128 |
@deffn Function mu-message-get-header-fields MESG HEADERS |
@deffn {Scheme Function} mu-message-get-header-fields MESG HEADERS |
129 |
Returns the list of headers in the MESG. If optional HEADERS is |
Returns the list of headers in the MESG. If optional HEADERS is |
130 |
specified it should be a list of header names to restrict return |
specified it should be a list of header names to restrict return |
131 |
value to. |
value to. |
132 |
@end deffn |
@end deffn |
133 |
|
|
134 |
@deffn Function mu-message-set-header-fields MESG LIST REPLACE |
@deffn {Scheme Function} mu-message-set-header-fields MESG LIST REPLACE |
135 |
Set the headers in the message MESG from LIST |
Set the headers in the message MESG from LIST |
136 |
LIST is a list of (cons HEADER VALUE) |
LIST is a list of (cons HEADER VALUE) |
137 |
Optional parameter REPLACE specifies whether the new header |
Optional parameter REPLACE specifies whether the new header |
139 |
message. |
message. |
140 |
@end deffn |
@end deffn |
141 |
|
|
142 |
@deffn Function mu-message-delete MESG FLAG |
@deffn {Scheme Function} mu-message-delete MESG FLAG |
143 |
Mark given message as deleted. Optional FLAG allows to toggle deleted mark |
Mark given message as deleted. Optional FLAG allows to toggle deleted mark |
144 |
The message is deleted if it is #t and undeleted if it is #f |
The message is deleted if it is #t and undeleted if it is #f |
145 |
@end deffn |
@end deffn |
146 |
|
|
147 |
@deffn Function mu-message-get-flag MESG FLAG |
@deffn {Scheme Function} mu-message-get-flag MESG FLAG |
148 |
Return value of the attribute FLAG. |
Return value of the attribute FLAG. |
149 |
@end deffn |
@end deffn |
150 |
|
|
151 |
@deffn Function mu-message-set-flag MESG FLAG VALUE |
@deffn {Scheme Function} mu-message-set-flag MESG FLAG VALUE |
152 |
Set the given attribute of the message. If optional VALUE is #f, the |
Set the given attribute of the message. If optional VALUE is #f, the |
153 |
attribute is unset. |
attribute is unset. |
154 |
@end deffn |
@end deffn |
155 |
|
|
156 |
@deffn Function mu-message-get-user-flag MESG FLAG |
@deffn {Scheme Function} mu-message-get-user-flag MESG FLAG |
157 |
Returns value of the user attribute FLAG. |
Returns value of the user attribute FLAG. |
158 |
@end deffn |
@end deffn |
159 |
|
|
160 |
@deffn Function mu-message-set-user-flag MESG FLAG VALUE |
@deffn {Scheme Function} mu-message-set-user-flag MESG FLAG VALUE |
161 |
Set the given user attribute of the message. If optional VALUE is |
Set the given user attribute of the message. If optional VALUE is |
162 |
#f, the attribute is unset. |
#f, the attribute is unset. |
163 |
@end deffn |
@end deffn |
164 |
|
|
165 |
@deffn Function mu-message-get-port MESG MODE FULL |
@deffn {Scheme Function} mu-message-get-port MESG MODE FULL |
166 |
Returns a port associated with the given MESG. MODE is a string |
Returns a port associated with the given MESG. MODE is a string |
167 |
defining operation mode of the stream. It may contain any of the |
defining operation mode of the stream. It may contain any of the |
168 |
two characters: @samp{r} for reading, @samp{w} for writing. |
two characters: @samp{r} for reading, @samp{w} for writing. |
172 |
accesses only the message body (the default). |
accesses only the message body (the default). |
173 |
@end deffn |
@end deffn |
174 |
|
|
175 |
@deffn Function mu-message-get-body MESG |
@deffn {Scheme Function} mu-message-get-body MESG |
176 |
Returns the message body for the message MESG. |
Returns the message body for the message MESG. |
177 |
@end deffn |
@end deffn |
178 |
|
|
179 |
@deffn Function mu-message-send MESG MAILER |
@deffn {Scheme Function} mu-message-send MESG MAILER |
180 |
Sends the message MESG. Optional MAILER overrides default |
Sends the message MESG. Optional MAILER overrides default |
181 |
mailer settings in mu-mailer. |
mailer settings in mu-mailer. |
182 |
@end deffn |
@end deffn |
184 |
@node MIME Functions |
@node MIME Functions |
185 |
@section MIME Functions |
@section MIME Functions |
186 |
|
|
187 |
@deffn Function mu-mime-create FLAGS MESG |
@deffn {Scheme Function} mu-mime-create FLAGS MESG |
188 |
Creates a new MIME object. |
Creates a new MIME object. |
189 |
@end deffn |
@end deffn |
190 |
|
|
191 |
@deffn Function mu-mime-multipart? MIME |
@deffn {Scheme Function} mu-mime-multipart? MIME |
192 |
Returns #t if MIME is a multipart object. |
Returns #t if MIME is a multipart object. |
193 |
@end deffn |
@end deffn |
194 |
|
|
195 |
@deffn Function mu-mime-get-num-parts MIME |
@deffn {Scheme Function} mu-mime-get-num-parts MIME |
196 |
Returns number of parts in a MIME object. |
Returns number of parts in a MIME object. |
197 |
@end deffn |
@end deffn |
198 |
|
|
199 |
@deffn Function mu-mime-get-part MIME PART |
@deffn {Scheme Function} mu-mime-get-part MIME PART |
200 |
Returns part number PART from a MIME object. |
Returns part number PART from a MIME object. |
201 |
@end deffn |
@end deffn |
202 |
|
|
203 |
@deffn Function mu-mime-add-part MIME MESG |
@deffn {Scheme Function} mu-mime-add-part MIME MESG |
204 |
Adds MESG to the MIME object. |
Adds MESG to the MIME object. |
205 |
@end deffn |
@end deffn |
206 |
|
|
207 |
@deffn Function mu-mime-get-message MIME |
@deffn {Scheme Function} mu-mime-get-message MIME |
208 |
Converts MIME object to a message. |
Converts MIME object to a message. |
209 |
@end deffn |
@end deffn |
210 |
|
|
211 |
@node Log Functions |
@node Log Functions |
212 |
@section Log Functions |
@section Log Functions |
213 |
|
|
214 |
@deffn Function mu-openlog IDENT OPTION FACILITY |
@deffn {Scheme Function} mu-openlog IDENT OPTION FACILITY |
215 |
Opens a connection to the system logger for Guile program. |
Opens a connection to the system logger for Guile program. |
216 |
@end deffn |
@end deffn |
217 |
|
|
218 |
@deffn Function mu-logger PRIO TEXT |
@deffn {Scheme Function} mu-logger PRIO TEXT |
219 |
Generates a log message to be distributed via syslogd. |
Generates a log message to be distributed via syslogd. |
220 |
@end deffn |
@end deffn |
221 |
|
|
222 |
@deffn Function mu-closelog |
@deffn {Scheme Function} mu-closelog |
223 |
Closes the channel to the system logger open by mu-openlog. |
Closes the channel to the system logger open by mu-openlog. |
224 |
@end deffn |
@end deffn |
225 |
|
|