Skip to content

John McEleney / mailutils

Go to a project
Toggle navigation
Toggle navigation pinning
Commit 8453ccd7 8453ccd7fb2e09248e7f0b8f3a54b5fd89324d3b by Sergey Poznyakoff
Options

Include snarfed files.

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