Commit 60ff7f3f 60ff7f3fce1f4d10bbae1bad431e0bb26d4a33c5 by Sergey Poznyakoff

Add to the repo

1 parent 05a52ebe
@c snarfed from "mu_address.c":79
@deffn {Scheme procedure} mu-address-get-personal address num
Return personal part of the @var{num}th email address from @var{address}.
@end deffn
@c snarfed from "mu_address.c":89
@deffn {Scheme procedure} mu-address-get-comments address num
Return comment part of the @var{num}th email address from @var{address}.
@end deffn
@c snarfed from "mu_address.c":99
@deffn {Scheme procedure} mu-address-get-email address num
Return email part of the @var{num}th email address from @var{address}.
@end deffn
@c snarfed from "mu_address.c":109
@deffn {Scheme procedure} mu-address-get-domain address num
Return domain part of the @var{num}th email address from @var{address}.
@end deffn
@c snarfed from "mu_address.c":119
@deffn {Scheme procedure} mu-address-get-local address num
Return local part of the @var{num}th email address from @var{address}.
@end deffn
@c snarfed from "mu_address.c":129
@deffn {Scheme procedure} mu-address-get-count address
Return number of parts in email address @var{address}.
@end deffn
@c snarfed from "mu_address.c":153
@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
@c snarfed from "mu_body.c":106
@deffn {Scheme procedure} mu-body-read-line body
Read next line from the @var{body}.
@end deffn
@c snarfed from "mu_body.c":167
@deffn {Scheme procedure} mu-body-write body text
Append @var{text} to message @var{body}.
@end deffn
@c snarfed from "mu_logger.c":26
@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
@c snarfed from "mu_logger.c":61
@deffn {Scheme procedure} mu-logger prio text
Distributes @var{text} via syslogd priority @var{prio}.
@end deffn
@c snarfed from "mu_logger.c":83
@deffn {Scheme procedure} mu-closelog
Closes the channel to the system logger opened by @code{mu-openlog}.
@end deffn
@c snarfed from "mu_mailbox.c":110
@deffn {Scheme procedure} mu-mail-directory url
If @var{url} is given, sets it as a name of the user's mail directory.
Returns the current value of the mail directory.
@end deffn
@c snarfed from "mu_mailbox.c":125
@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
@c snarfed from "mu_mailbox.c":149
@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
@c snarfed from "mu_mailbox.c":201
@deffn {Scheme procedure} mu-mailbox-close mbox
Closes mailbox @var{mbox}.
@end deffn
@c snarfed from "mu_mailbox.c":216
@deffn {Scheme procedure} mu-mailbox-get-url mbox
Returns url of the mailbox @var{mbox}.
@end deffn
@c snarfed from "mu_mailbox.c":240
@deffn {Scheme procedure} mu-mailbox-get-port mbox mode
Returns a port associated with the contents of the @var{mbox}.
@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.
@end deffn
@c snarfed from "mu_mailbox.c":262
@deffn {Scheme procedure} mu-mailbox-get-message mbox msgno
Retrieve from message #@var{msgno} from the mailbox @var{mbox}.
@end deffn
@c snarfed from "mu_mailbox.c":288
@deffn {Scheme procedure} mu-mailbox-messages-count mbox
Returns number of messages in the mailbox @var{mbox}.
@end deffn
@c snarfed from "mu_mailbox.c":309
@deffn {Scheme procedure} mu-mailbox-expunge mbox
Expunges deleted messages from the mailbox @var{mbox}.
@end deffn
@c snarfed from "mu_mailbox.c":328
@deffn {Scheme procedure} mu-mailbox-append-message mbox mesg
Appends message @var{mesg} to the mailbox @var{mbox}.
@end deffn
@c snarfed from "mu_message.c":184
@deffn {Scheme procedure} mu-message-create
Creates an empty message.
@end deffn
@c snarfed from "mu_message.c":196
@deffn {Scheme procedure} mu-message-copy mesg
Creates the copy of the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":257
@deffn {Scheme procedure} mu-message-destroy mesg
Destroys the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":274
@deffn {Scheme procedure} mu-message-set-header mesg header value replace
Sets new @var{value} to the header @var{header} of the message @var{mesg}.
If @var{header} is already present in the message its value
is replaced with the suplied one iff the optional @var{replace} is
#t. Otherwise, a new header is created and appended.
@end deffn
@c snarfed from "mu_message.c":314
@deffn {Scheme procedure} mu-message-get-size mesg
Returns the size of the message @var{mesg}
.
@end deffn
@c snarfed from "mu_message.c":328
@deffn {Scheme procedure} mu-message-get-lines mesg
Returns number of lines in the given message.
@end deffn
@c snarfed from "mu_message.c":349
@deffn {Scheme procedure} mu-message-get-sender mesg
Returns email address of the sender of the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":376
@deffn {Scheme procedure} mu-message-get-header mesg header
Returns value of the header @var{header} from the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":433
@deffn {Scheme procedure} mu-message-get-header-fields mesg headers
Returns the 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
@c snarfed from "mu_message.c":510
@deffn {Scheme procedure} mu-message-set-header-fields mesg list replace
Set the headers in the message @var{mesg} from @var{list}
@var{list} is a list of conses (cons HEADER VALUE). The function sets
these headers in the message @var{mesg}.
Optional parameter @var{replace} specifies whether the new header
values should replace the headers already present in the
message.
@end deffn
@c snarfed from "mu_message.c":564
@deffn {Scheme procedure} mu-message-delete mesg flag
Mark the message @var{mesg} as deleted. Optional argument @var{flag} allows to toggle
deletion mark. The message is deleted if it is @code{#t} and undeleted if
it is @code{#f}
@end deffn
@c snarfed from "mu_message.c":600
@deffn {Scheme procedure} mu-message-get-flag mesg flag
Return value of the attribute @var{flag} of the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":662
@deffn {Scheme procedure} mu-message-set-flag mesg flag value
Set the attribute @var{flag} of the message @var{mesg}. If optional @var{value} is #f, the
attribute is unset.
@end deffn
@c snarfed from "mu_message.c":760
@deffn {Scheme procedure} mu-message-get-user-flag mesg flag
Return the value of the user attribute @var{flag} from the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":783
@deffn {Scheme procedure} mu-message-set-user-flag mesg flag value
Set the given user attribute @var{flag} in the message @var{mesg}. If optional argumen
@var{value} is @samp{#f}, the attribute is unset.
@end deffn
@c snarfed from "mu_message.c":823
@deffn {Scheme procedure} mu-message-get-port mesg mode full
Returns a port associated with the given @var{mesg}. @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
@c snarfed from "mu_message.c":870
@deffn {Scheme procedure} mu-message-get-body mesg
Returns the message body for the message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":888
@deffn {Scheme procedure} mu-message-multipart? mesg
Returns @code{#t} if @var{mesg} is a multipart @acronym{MIME} message.
@end deffn
@c snarfed from "mu_message.c":904
@deffn {Scheme procedure} mu-message-get-num-parts mesg
Returns number of parts in a multipart @acronym{MIME} message. Returns
@code{#f} if the argument is not a multipart message.
@end deffn
@c snarfed from "mu_message.c":929
@deffn {Scheme procedure} mu-message-get-part mesg part
Returns part #@var{part} from a multipart @acronym{MIME} message @var{mesg}.
@end deffn
@c snarfed from "mu_message.c":957
@deffn {Scheme procedure} mu-message-send mesg mailer from to
Sends the message @var{mesg}. Optional @var{mailer} overrides default mailer settings
in mu-mailer. Optional @var{from} and @var{to} give sender and recever addresses.
@end deffn
@c snarfed from "mu_message.c":1025
@deffn {Scheme procedure} mu-message-get-uid mesg
Returns uid of the message @var{mesg}
@end deffn
@c snarfed from "mu_mime.c":95
@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
@c snarfed from "mu_mime.c":131
@deffn {Scheme procedure} mu-mime-multipart? mime
Returns @code{#t} if @var{mime} is a multipart object.
@end deffn
@c snarfed from "mu_mime.c":141
@deffn {Scheme procedure} mu-mime-get-num-parts mime
Returns number of parts in the @sc{mime} object @var{mime}.
@end deffn
@c snarfed from "mu_mime.c":160
@deffn {Scheme procedure} mu-mime-get-part mime num
Returns @var{num}th part from the @sc{mime} object @var{mime}.
@end deffn
@c snarfed from "mu_mime.c":182
@deffn {Scheme procedure} mu-mime-add-part mime mesg
Adds @var{mesg} to the @sc{mime} object @var{mime}.
@end deffn
@c snarfed from "mu_mime.c":208
@deffn {Scheme procedure} mu-mime-get-message mime
Converts @sc{mime} object @var{mime} to a message.
@end deffn
@c snarfed from "mu_scm.c":130
@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
@c snarfed from "mu_scm.c":163
@deffn {Scheme procedure} mu-strerror err
Return the error message corresponding to @var{err}, which must be
an integer value.
@end deffn