Skip to content
Toggle navigation
Toggle navigation
This project
Loading...
Sign in
John McEleney
/
mailutils
Go to a project
Toggle navigation
Toggle navigation pinning
Projects
Groups
Snippets
Help
Project
Activity
Repository
Pipelines
Graphs
Issues
0
Merge Requests
0
Wiki
Network
Create a new issue
Builds
Commits
Issue Boards
Files
Commits
Network
Compare
Branches
Tags
Commit
ad83ff38
...
ad83ff3892af8aecfea2ae9a9639c735d0313f8a
authored
2001-01-03 15:49:07 +0000
by
Alain Magloire
Browse Files
Options
Browse Files
Tag
Download
Email Patches
Plain Diff
Patch from shaleh to make the verbs and tense agree.
1 parent
a9a9457d
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
39 additions
and
38 deletions
doc/headers.texi
doc/mailbox.texi
doc/mailer.texi
doc/mailutils.texi
doc/stream.texi
doc/url.texi
doc/headers.texi
View file @
ad83ff3
...
...
@@ -7,15 +7,15 @@ parsed.
@end
deftypefun
@deftypefun
void
header_destroy
(
header_t
*
@var
{
hdr
},
void
*
@var
{
owner
})
The
res
sources
allocate
for
@var
{
hdr
}
are
freed
.
The
res
ources
allocated
for
@var
{
hdr
}
are
freed
.
@end
deftypefun
@deftypefun
int
header_set_value
(
header_t
@var
{
hdr
},
const
char
*
@var
{
fn
},
const
char
*
@var
{
fv
},
size_t
n
,
int
@var
{
replace
})
Set
the
field
-
name
@var
{
fn
}
to
field
-
value
@var
{
fv
}
of
size
@var
{
n
}
in
@var
{
hdr
}.
If
@var
{
replace
}
is
non
-
zero
the
initial
value
is
replace
,
if
zero
it
is
append
.
@var
{
hdr
}.
If
@var
{
replace
}
is
non
-
zero
the
initial
value
is
replace
d
,
if
zero
it
is
append
ed
.
Some
basic
macros
is
already
provided
for
rfc822
.
Some
basic
macros
are
already
provided
for
rfc822
.
@table
@code
@item
MU_HDR_RETURN_PATH
...
...
@@ -73,7 +73,7 @@ MIME-Version
@end
deftypefun
@deftypefun
int
header_get_value
(
header_t
@var
{
hdr
},
const
char
*
fn
,
char
*
fv
,
size_t
len
,
size_t
*
n
)
Value
of
field
-
name
@var
{
fn
}
is
return
in
buffer
@var
{
fv
}
of
size
@var
{
len
}.
Value
of
field
-
name
@var
{
fn
}
is
return
ed
in
buffer
@var
{
fv
}
of
size
@var
{
len
}.
The
number
of
bytes
written
is
put
in
@var
{
n
}.
@end
deftypefun
...
...
doc/mailbox.texi
View file @
ad83ff3
@code
{
#
include
<
mailutils
/
mailbox
.
h
>
}
@deftp
{
Data
Type
}
mailbox_t
The
@code
{
mailbox_t
}
object
is
use
to
hold
information
and
it
is
an
opaque
The
@code
{
mailbox_t
}
object
is
use
d
to
hold
information
and
it
is
an
opaque
data
structure
to
the
user
.
Functions
are
provided
to
retrieve
the
information
.
@end
deftp
@example
...
...
@@ -25,13 +25,13 @@ data structure to the user. Functions are provided to retrieve the information.
@end
example
@deftypefun
int
mailbox_create
(
mailbox_t
*
@var
{
pmbox
},
const
char
*
@var
{
name
},
int
@var
{
id
})
The
funcion
@code
{
mailbox_create
}
allocates
and
initializes
@var
{
pmbox
}.
The
validation
is
base
on
the
scheme
of
the
url
@var
{
name
}
or
@var
{
id
}.
The
func
t
ion
@code
{
mailbox_create
}
allocates
and
initializes
@var
{
pmbox
}.
The
validation
is
base
d
on
the
scheme
of
the
url
@var
{
name
}
or
@var
{
id
}.
The
return
value
is
@code
{
0
}
on
success
and
a
code
number
on
error
conditions
:
@table
@code
@item
EINVAL
The
url
@var
{
name
}
suppl
y
is
invalid
or
not
supported
.
The
url
@var
{
name
}
suppl
ied
is
invalid
or
not
supported
.
@var
{
pmbox
}
is
NULL
.
@item
ENOMEM
Not
enough
memory
to
allocate
resources
.
...
...
@@ -39,7 +39,7 @@ Not enough memory to allocate resources.
@end
deftypefun
@deftypefun
int
mailbox_create_default
(
mailbox_t
*
@var
{
pmbox
},
const
char
*
@var
{
user
})
The
environment
variable
@emph
{
$
MAIL
}
or
the
string
form
by
The
environment
variable
@emph
{
$
MAIL
}
or
the
string
form
ed
by
@emph
{
$
MAILDIR
}
/
@var
{
user
}
" or @emph{$LOGNAME} if @var{user} is null,
for a default mailbox and calls @code{mailbox_create}.
@end deftypefun
...
...
@@ -60,14 +60,14 @@ Set the @var{stream} connection to use for the mailbox.
The return value is @code{0} on success and a code number on error conditions:
@table @code
@item EINVAL
@var{mbox} or @var{stream}
are
NULL.
@var{mbox} or @var{stream}
is
NULL.
@end table
@end deftypefun
@deftypefun int mailbox_open (mailbox_t @var{mbox}, int @var{flag})
A connection is open, if no stream was provided, a stream
is create
base
on the @var{mbox} type. The @var{flag} can be OR'ed.
See @code{stream_create} for @var{flag} description.
is create
d based
on the @var{mbox} type. The @var{flag} can be OR'ed.
See @code{stream_create} for @var{flag}
's
description.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -84,7 +84,7 @@ Not enough memory.
@end deftypefun
@deftypefun int mailbox_close (mailbox_t @var{mbox})
The stream attach to @var{mbox} is close.
The stream attach to @var{mbox} is close
d
.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -94,12 +94,12 @@ The return value is @code{0} on success and a code number on error conditions:
@end deftypefun
@deftypefun void mailbox_destroy (mailbox_t *@var{pmbox})
Destroy
and releases resources ho
ld by @var{pmbox}.
Destroy
s and releases resources he
ld by @var{pmbox}.
@end deftypefun
@deftypefun int mailbox_get_message (mailbox_t @var{mbox}, size_t @var{msgno}, message_t *@var{pmessage})
Retreive message number @var{msgno}, @var{pmessage} is allocate and
initialize.
Retreive message number @var{msgno}, @var{pmessage} is allocate
d
and
initialize
d
.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -111,7 +111,7 @@ Not enough memory.
@end deftypefun
@deftypefun int mailbox_append_message (mailbox_t @var{mbox}, message_t @var{message})
The @var{message} is append to the mailbox @var{mbox}.
The @var{message} is append
ed
to the mailbox @var{mbox}.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -121,7 +121,7 @@ The return value is @code{0} on success and a code number on error conditions:
@end deftypefun
@deftypefun int mailbox_messages_count (mailbox_t @var{mbox}, size_t *@var{pnumber});
Give the number of message
is
@var{mbox}.
Give the number of message
d in
@var{mbox}.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -131,7 +131,7 @@ The return value is @code{0} on success and a code number on error conditions:
@end deftypefun
@deftypefun int mailbox_expunge (mailbox_t @var{mbox})
All
the messages set deleted
are removed.
All
messages marked for deletion
are removed.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -161,7 +161,7 @@ The return value is @code{0} on success and a code number on error conditions:
@end deftypefun
@deftypefun int mailbox_get_auth (mailbox_t @var{mbox}, auth_t *@var{pauth})
Retrieve
r
the @var{*pauth} of the @var{mbox}.
Retrieve the @var{*pauth} of the @var{mbox}.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -171,7 +171,7 @@ The return value is @code{0} on success and a code number on error conditions:
@end deftypefun
@deftypefun int mailbox_set_auth (mailbox_t @var{mbox}, auth_t @var{auth})
Set the type of auth
aurity
for the mailbox.
Set the type of auth
entication
for the mailbox.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
@@ -181,7 +181,7 @@ The return value is @code{0} on success and a code number on error conditions:
@end deftypefun
@deftypefun int mailbox_is_updated (mailbox_t @var{mbox})
Check if the mailbox is up
to
date.
Check if the mailbox is up
-to-
date.
The return value is @code{0} on success and a code number on error conditions:
@table @code
...
...
doc/mailer.texi
View file @
ad83ff3
The API is still shaky and undefine.
The API is still shaky and undefine
d
.
...
...
doc/mailutils.texi
View file @
ad83ff3
...
...
@@ -103,7 +103,7 @@ This document was produced for version @value{VERSION} of @sc{gnu}
@menu
*
Introduction
::
GNU
@sc
{
mailutils
}
*
Mailbox
::
Mailbox
API
.
*
Mailer
::
Protocol
Use
to
Send
Mail
.
*
Mailer
::
Protocol
Use
d
to
Send
Mail
.
*
Message
::
Message
API
.
*
Headers
::
Headers
API
.
*
Body
::
Body
API
.
...
...
@@ -125,8 +125,9 @@ This document was produced for version @value{VERSION} of @sc{gnu}
@chapter
Introduction
@cindex
Introduction
@sc
{
gnu
}
@sc
{
Mailutils
}
offers
a
general
purpose
library
aim
to
provide
a
rich
set
of
functions
for
accessing
different
mailbox
formats
and
mailers
.
@sc
{
gnu
}
@sc
{
Mailutils
}
offers
a
general
purpose
library
whose
aim
is
to
provide
a
rich
set
of
functions
for
accessing
different
mailbox
formats
and
mailers
.
@example
@group
...
...
@@ -139,7 +140,7 @@ a rich set of functions for accessing different mailbox formats and mailers.
-----------
+-----------------+
|
|
...
|
(
jeff
)
+---|-*
message_t
[
0
]
|
|
+-----------+
-----------
|
|
message_t
[
1
]
|
|
(
s
ean
)
|
|
...
|
|
auth_t
(
s
haleh
)
|
|
...
|
|
auth_t
----------
|
+-----------------+
+-->+----------+
|
|
user
|
message_t
|
|
passwd
|
...
...
@@ -155,8 +156,8 @@ a rich set of functions for accessing different mailbox formats and mailers.
@end
group
@end
example
For
example
writing
a
simple
@command
{
from
}
command
that
will
list
@emph
{
From
}
and
@emph
{
Subject
}
of
a
folder
.
For
example
writing
a
simple
@command
{
from
}
command
that
will
list
the
@emph
{
From
}
and
@emph
{
Subject
}
headers
of
every
mail
in
a
folder
.
@example
@include
sfrom
.
c
.
texi
...
...
@@ -256,7 +257,7 @@ Be sure to include the word ``mailutils'' somewhere in the ``Subject:'' field.
In
no
particular
order
,
Jakob
Kaivo
@email
{
jkaivo
@@ndn
.
net
},
Jeff
Bailey
@email
{
jbailey
@@gnu
.
org
},
Sean
Perry
@email
{
shaleh
@@debian
.
org
},
Sean
'
Shaleh
'
Perry
@email
{
shaleh
@@debian
.
org
},
Thomas
Fletcher
@email
{
thomasf
@@qnx
.
com
}.
Dave
Inglis
@email
{
dinglis
@@qnx
.
com
}.
Brian
Edmond
@email
{
briane
@@qnx
.
com
}.
...
...
doc/stream.texi
View file @
ad83ff3
...
...
@@ -13,16 +13,16 @@ The stream is open write only.
The
stream
is
open
read
and
write
.
@item
MU_STREAM_APPEND
@findex
MU_STREAM_APPEND
The
stream
is
open
in
append
mode
for
writ
e
.
The
stream
is
open
in
append
mode
for
writ
ing
.
@item
MU_STREAM_CREAT
@findex
MU_STREAM_CREAT
The
stream
is
create
.
The
stream
is
create
d
.
@item
MU_STREAM_NONBLOCK
@findex
MU_STREAM_NONBLOCK
The
stream
is
set
non
blocking
.
@item
MU_STREAM_NO_CHECK
@findex
MU_STREAM_NO_CHECK
Stream
is
destroy
without
checking
for
the
owner
.
Stream
is
destroy
ed
without
checking
for
the
owner
.
@end
table
@end
deftypefun
...
...
doc/url.texi
View file @
ad83ff3
@comment
See
rfc2368
,
rfc2369
,
rfc2384
A
mailbox
and
mailer
can
be
describe
in
a
URL
,
the
string
will
contain
the
A
mailbox
and
mailer
can
be
describe
d
in
a
URL
,
the
string
will
contain
the
necessary
information
to
initialize
@code
{
mailbox_t
},
or
@code
{
mailer_t
}
properly
.
...
...
@@ -13,7 +13,7 @@ and the authentication mechanism. The general form is
@url
{
pop
:
//obelix;AUTH=+APOP@@village.gaulois.org:2000}
@end
example
If
@emph
{
:
port
}
is
omitted
the
default
value
is
110
.
Different
form
of
If
@emph
{
:
port
}
is
omitted
the
default
value
is
110
.
Different
form
s
of
authentication
can
be
specified
with
@emph
{;
AUTH
=
type
}.
The
special
string
@emph
{;
AUTH
=*
}
indicates
that
the
client
will
use
a
default
scheme
base
on
the
capability
of
the
server
.
...
...
@@ -52,13 +52,13 @@ use @url{file://path} and let the library figure out which one.
@section
Mailto
After
setting
a
mailer
,
@url
{
mailto
:
}
is
use
to
tell
the
mailer
where
After
setting
a
mailer
,
@url
{
mailto
:
}
is
use
d
to
tell
the
mailer
where
and
to
whom
the
message
is
for
.
@example
@url
{
mailto
:
//hostname}
@end
example
Mailto
can
be
use
to
generate
short
messages
for
example
to
subscribe
Mailto
can
be
use
d
to
generate
short
messages
,
for
example
to
subscribe
to
mailing
lists
.
@example
@url
{
mailto
:
//bug-mailutils@@gnu.org?body=subscribe}
...
...
Please
register
or
sign in
to post a comment