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
c5fe2fd2
...
c5fe2fd2670a170f0f907cef692297f49bcdf596
authored
2001-06-03 15:34:10 +0000
by
Alain Magloire
Browse Files
Options
Browse Files
Tag
Download
Email Patches
Plain Diff
A bunch of typo correction from Thomas.
1 parent
2e878c30
Show whitespace changes
Inline
Side-by-side
Showing
21 changed files
with
97 additions
and
92 deletions
doc/address.texi
doc/attribute.texi
doc/auth.texi
doc/body.texi
doc/envelope.texi
doc/framework.texi
doc/headers.texi
doc/imap4.texi
doc/iterator.texi
doc/locker.texi
doc/mailbox.texi
doc/maildir.texi
doc/mailer.texi
doc/mailutils.texi
doc/mbox.texi
doc/mh.texi
doc/nntp.texi
doc/parse822.texi
doc/pop3.texi
doc/sendmail.texi
doc/smtp.texi
doc/address.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{address_} is reserve */
}
@code
{
/* Prefix @emph{address_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
address
.
h
>
}
@end
example
...
...
@@ -91,7 +91,7 @@ The @var{addr} is destroyed.
@deftypefun
int
address_get_email
(
address_t
*
@var{
addr
}
,
size_t
@var{
no
}
,
char
*
@var{
buf
}
,
size_t
@var{
len
}
,
size_t
*
@var{
n
}
)
Acesses
the
@var{
no
}
th
email
address
component
of
the
address
list
.
This
Ac
c
esses
the
@var{
no
}
th
email
address
component
of
the
address
list
.
This
address
is
the
plain
email
address
,
correctly
quoted
,
suitable
for
using
in
an
smtp
dialog
,
for
example
,
or
as
the
address
part
of
a
contact
book
entry
.
...
...
@@ -105,7 +105,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun
int
address_get_personal
(
address_t
*
@var
{
addr
},
size_t
@var
{
no
},
char
*
@var
{
buf
},
size_t
@var
{
len
},
size_t
*
@var
{
n
})
Acesses
the
display
-
name
describing
the
@var
{
no
}
th
email
address
.
This
Ac
c
esses
the
display
-
name
describing
the
@var
{
no
}
th
email
address
.
This
display
-
name
is
optional
,
so
may
not
be
present
.
If
it
is
not
present
,
but
there
is
an
RFC822
comment
after
the
address
,
that
comment
will
be
returned
as
the
personal
phrase
,
as
this
is
a
common
usage
of
the
comment
...
...
@@ -127,7 +127,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun
int
address_get_comments
(
address_t
*
@var
{
addr
},
size_t
@var
{
no
},
char
*
@var
{
buf
},
size_t
@var
{
len
},
size_t
*
@var
{
n
})
Acesses
the
comments
extracted
while
parsing
the
@var
{
no
}
th
email
address
.
Ac
c
esses
the
comments
extracted
while
parsing
the
@var
{
no
}
th
email
address
.
These
comments
have
no
defined
meaning
,
and
are
not
currently
collected
.
The
return
value
is
@code
{
0
}
on
success
and
a
code
number
on
error
conditions
:
...
...
@@ -140,7 +140,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun
int
address_get_email
(
address_t
*
@var
{
addr
},
size_t
@var
{
no
},
char
*
@var
{
buf
},
size_t
@var
{
len
},
size_t
*
@var
{
n
})
Acesses
the
email
addr
-
spec
extracted
while
Ac
c
esses
the
email
addr
-
spec
extracted
while
parsing
the
@var
{
no
}
th
email
address
.
This
will
be
@code
{
0
}
length
for
a
unix
-
mbox
.
...
...
@@ -153,7 +153,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun
int
address_get_local_part
(
address_t
*
@var
{
addr
},
size_t
@var
{
no
},
char
*
@var
{
buf
},
size_t
@var
{
len
},
size_t
*
@var
{
n
})
Acesses
the
local
-
part
of
an
email
addr
-
spec
extracted
while
Ac
c
esses
the
local
-
part
of
an
email
addr
-
spec
extracted
while
parsing
the
@var
{
no
}
th
email
address
.
The
return
value
is
@code
{
0
}
on
success
and
a
code
number
on
error
conditions
:
...
...
@@ -165,7 +165,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun
int
address_get_domain
(
address_t
*
@var
{
addr
},
size_t
@var
{
no
},
char
*
@var
{
buf
},
size_t
@var
{
len
},
size_t
*
@var
{
n
})
Acesses
the
domain
of
an
email
addr
-
spec
extracted
while
Ac
c
esses
the
domain
of
an
email
addr
-
spec
extracted
while
parsing
the
@var
{
no
}
th
email
address
.
This
will
be
@code
{
0
}
length
for
a
unix
-
mbox
.
...
...
@@ -178,7 +178,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun
int
address_get_route
(
address_t
*
@var
{
addr
},
size_t
@var
{
no
},
char
*
@var
{
buf
},
size_t
@var
{
len
},
size_t
*
@var
{
n
})
Acesses
the
route
of
an
email
addr
-
spec
extracted
while
Ac
c
esses
the
route
of
an
email
addr
-
spec
extracted
while
parsing
the
@var
{
no
}
th
email
address
.
This
is
a
rarely
used
RFC822
address
syntax
,
but
is
legal
in
SMTP
as
well
.
The
entire
route
is
returned
as
a
string
,
those
wishing
to
parse
it
should
look
at
<
mailutils
/
parse822
.
h
>
.
...
...
doc/attribute.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{attribute_} is reserve */
}
@code
{
/* Prefix @emph{attribute_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
attribute
.
h
>
}
@end
example
...
...
doc/auth.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{auth_} is reserve */
}
@code
{
/* Prefix @emph{auth_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
auth
.
h
>
}
@end
example
There
are
many
ways
to
authenticate
to
a
server
,
t
o
be
flexible
the
There
are
many
ways
to
authenticate
to
a
server
.
T
o
be
flexible
the
authentication
process
is
provided
by
two
objects
@code
{
auth_t
}
and
@code
{
ticket_t
}.
The
@code
{
auth_t
}
can
implement
different
protocol
like
APOP
,
MD5
-
AUTH
,
One
Time
Passwd
etc
..
By
default
if
a
mailbox
does
not
understand
or
know
how
to
authenticate
it
falls
back
to
user
/
passwd
authentication
.
The
@code
{
ticket_t
}
is
a
way
to
user
/
passwd
authentication
.
The
@code
{
ticket_t
}
is
a
way
for
Mailboxes
and
Mailers
provide
a
way
to
authenticate
when
the
URL
does
not
contain
enough
information
.
The
default
action
is
to
call
function
@code
{
auth_authenticate
}
wh
o
will
get
the
@emph
{
user
}
and
@emph
{
passwd
}
if
not
set
,
this
function
can
be
override
by
a
custom
method
.
contain
enough
information
.
The
default
action
is
to
call
the
function
@code
{
auth_authenticate
}
wh
ich
will
get
the
@emph
{
user
}
and
@emph
{
passwd
}
if
not
set
,
this
function
can
be
override
n
by
a
custom
method
.
@deftypefun
int
auth_create
(
auth_t
*
@var
{
pauth
},
void
*
@var
{
owner
})
@end
deftypefun
...
...
doc/body.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{body_} is reserve */
}
@code
{
/* Prefix @emph{body_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
body
.
h
>
}
@end
example
...
...
doc/envelope.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{envelope_} is reserve */
}
@code
{
/* Prefix @emph{envelope_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
envelope
.
h
>
}
@end
example
...
...
doc/framework.texi
View file @
c5fe2fd
...
...
@@ -16,10 +16,10 @@
@end
menu
Where
ever
the
mail
is
and
whatever
format
it
is
store
in
,
the
same
operations
Where
ever
the
mail
is
and
whatever
format
it
is
stored
in
,
the
same
operations
to
manipulate
emails
are
common
.
To
unified
the
C
API
,
GNU
mailutils
offers
a
n
heteroclite
set
of
objects
that
work
in
aggregation
to
do
operations
on
emails
.
Each
object
do
a
specific
task
and
delegate
non
related
tasks
to
a
heteroclite
set
of
objects
that
work
in
aggregation
to
do
operations
on
emails
.
Each
object
do
a
specific
task
and
delegate
s
non
related
tasks
to
others
.
The
object
comes
alive
by
specifying
a
@emph
{
URL
}
parameter
when
created
,
it
will
indicate
the
storage
format
or
protocol
(
POP3
,
IMAP4
,
MH
,
MAILDIR
,
etc
..).
...
...
doc/headers.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{header_} is reserve */
}
@code
{
/* Prefix @emph{header_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
header
.
h
>
}
@end
example
...
...
doc/imap4.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{imap4_} is reserve */
}
@code
{
/* Prefix @emph{imap4_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
imap4
.
h
>
}
@end
example
...
...
doc/iterator.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{iterator_} is reserve */
}
@code
{
/* Prefix @emph{iterator_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
iterator
.
h
>
}
@end
example
...
...
doc/locker.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{locker_} is reserve */
}
@code
{
/* Prefix @emph{locker_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
locker
.
h
>
}
@end
example
...
...
doc/mailbox.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{mailbox_} is reserve */
}
@code
{
/* Prefix @emph{mailbox_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
mailbox
.
h
>
}
@end
example
@deftp
{
Data
Type
}
mailbox_t
The
@code
{
mailbox_t
}
object
is
used
to
hold
information
and
it
is
an
opaque
data
structure
to
the
user
.
Functions
are
provided
to
retrieve
the
information
.
data
structure
to
the
user
.
Functions
are
provided
to
retrieve
information
from
the
data
structure
.
@end
deftp
@example
@group
...
...
@@ -64,9 +65,9 @@ Not enough memory to allocate resources.
@end
deftypefun
@deftypefun
int
mailbox_create_default
(
mailbox_t
*
@var
{
pmbox
},
const
char
*
@var
{
name
})
The
environment
variable
@emph
{
$
MAIL
}
or
the
string
formed
by
Create
a
mailbox
with
@code
{
mailbox_create
()}
based
on
the
environment
variable
@emph
{
$
MAIL
}
or
the
string
formed
by
@emph
{
_PATH_MAILDIR
}
/
@var
{
user
}
" or @emph{$LOGNAME} if @var{user} is null,
for a default mailbox and calls @code{mailbox_create}.
@end deftypefun
@deftypefun void mailbox_destroy (mailbox_t *@var{pmbox})
...
...
doc/maildir.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{maildir_} is reserve */
}
@code
{
/* Prefix @emph{maildir_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
maildir
.
h
>
}
@end
example
...
...
doc/mailer.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{mailer_} is reserve */
}
@code
{
/* Prefix @emph{mailer_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
mailer
.
h
>
}
@end
example
...
...
doc/mailutils.texi
View file @
c5fe2fd
...
...
@@ -104,7 +104,7 @@ This document was produced for version @value{VERSION} of @sc{gnu}
@end
ifinfo
@menu
*
Introduction
::
GNU
@sc
{
mailutils
}
*
C
API
::
C
API
.
*
C
oncrete
API
::
Concrete
API
.
*
Framework
::
Framework
.
*
Programs
::
Programs
.
*
Reporting
Bugs
::
Reporting
Bugs
.
...
...
@@ -114,7 +114,7 @@ This document was produced for version @value{VERSION} of @sc{gnu}
@end
menu
@node
Introduction
,
C
API
,
Top
,
Top
@node
Introduction
,
C
oncrete
API
,
Top
,
Top
@comment
node
-
name
,
next
,
previous
,
up
@chapter
Introduction
@cindex
Introduction
...
...
@@ -217,14 +217,14 @@ Misc
@cite
{
Internet
Email
Protocols
a
Developer
'
s
Guide
by
Kevin
Johnson
}
@end
itemize
@node
C
API
,
Framework
,
Introduction
,
Top
@node
C
oncrete
API
,
Framework
,
Introduction
,
Top
@comment
node
-
name
,
next
,
previous
,
up
@chapter
C
API
@cindex
C
API
@chapter
C
oncrete
API
@cindex
C
oncrete
API
@include
c
-
api
.
texi
@node
Framework
,
Programs
,
C
API
,
Top
@node
Framework
,
Programs
,
C
oncrete
API
,
Top
@comment
node
-
name
,
next
,
previous
,
up
@chapter
Framework
@cindex
Framework
...
...
doc/mbox.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{mbox_} is reserve */
}
@code
{
/* Prefix @emph{mbox_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
mbox
.
h
>
}
@end
example
...
...
doc/mh.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{mh_} is reserve */
}
@code
{
/* Prefix @emph{mh_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
mh
.
h
>
}
@end
example
...
...
doc/nntp.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{nntp_} is reserve */
}
@code
{
/* Prefix @emph{nntp_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
nntp
.
h
>
}
@end
example
...
...
doc/parse822.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{parse822_} is reserve */
}
@code
{
/* Prefix @emph{parse822_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
parse822
.
h
>
}
@end
example
...
...
doc/pop3.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{pop3_} is reserve */
}
@code
{
/* Prefix @emph{pop3_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
pop3
.
h
>
}
@end
example
The
Post
Office
Protocol
Version
3
(
POP3
)
purpose
is
to
permit
a
client
to
download
a
maildrop
from
a
remote
server
.
It
does
not
provide
complex
e
or
download
a
maildrop
from
a
remote
server
.
It
does
not
provide
complex
or
extensive
operation
on
the
maildrop
.
@example
...
...
@@ -45,7 +45,7 @@ Capa (extension)
Auth
(
extension
)
@end
itemize
When
the
client
successfully
authenticate
the
server
acquires
an
exclusive
When
the
client
successfully
authenticate
s
the
server
acquires
an
exclusive
access
lock
on
the
mailbox
and
holds
it
the
entire
duration
of
the
session
.
The
POP3
session
enters
The
TRANSACTION
State
and
the
client
may
issues
commands
to
access
the
mailbox
:
...
...
@@ -80,36 +80,36 @@ and closes the TCP connection.
@cindex
pop3_t
An
opaque
structure
@emph
{
pop3_t
}
is
use
as
a
handle
for
the
session
,
it
is
allocate
and
initiliaze
by
calling
@code
{
pop3_create
()}.
All
Functions
will
allocate
d
and
initiliazed
by
calling
@code
{
pop3_create
()}.
All
Functions
will
wait
for
a
reply
from
the
POP3
server
before
returning
.
The
duration
of
the
wait
ing
can
be
set
by
calling
@code
{
pop3_set_timeout
()},
the
default
the
wait
can
be
set
by
calling
@code
{
pop3_set_timeout
()},
the
default
is
10
minutes
@footnote
{
@strong
{
Caution
:
}
Although
the
@cite
{
RFC
1939
}
specifies
that
the
minimum
default
timeout
is
ten
minutes
many
servers
has
shorter
idle
period
,
care
should
be
taken
to
at
least
send
a
@code
{
pop3_noop
()}
between
lengthy
period
of
times
.}.
Once
a
succesfull
connection
is
establish
with
@code
{
pop3_open
()},
two
builtin
authentications
connection
is
establish
ed
with
@code
{
pop3_open
()},
two
builtin
authentications
are
provided
@code
{
pop3_apop
()}
or
@code
{
pop3_user
()},
@code
{
pop3_pass
()}.
The
@code
{
pop3_stat
()}
and
@code
{
pop3_list
()}
functions
can
be
use
to
get
the
messages
count
and
sizes
.
Downloading
of
messages
are
done
via
a
stream
number
and
size
of
messages
.
Downloading
of
messages
is
done
via
a
stream
provided
by
@code
{
pop3_retr
()}
or
@code
{
pop3_top
()}
@footnote
{
@strong
{
Caution
:
}
Some
Internet
Service
Providers
do
not
permit
to
leave
mail
on
server
and
the
message
will
be
deleted
once
downloaded
.}.
The
@code
{
stream_t
}
should
be
destroy
to
indicate
to
the
library
that
the
action
is
finish
.
POP3
only
provide
a
single
channel
for
operation
,
it
means
only
one
operation
can
be
done
at
a
time
,
all
the
functions
will
return
MU_ERROR_OPERATION_IN_PROGRESS
if
call
during
another
operation
.
The
functions
@code
{
pop3_list_all
()},
@code
{
pop3_uidl_all
()}
and
@code
{
pop3_capa
()}
give
an
@code
{
iterator_t
},
when
iterating
@code
{
iterator_current
()}
will
give
an
object
that
should
be
cast
appropriatly
and
@code
{
free
()}
by
the
caller
,
the
@code
{
iterator_t
}
must
also
be
destroy
,
@code
{
iterator_destroy
()}.
The
@code
{
stream_t
}
should
be
destroyed
to
indicate
to
the
library
that
the
action
is
finished
.
POP3
only
provide
a
single
channel
for
operation
,
it
means
only
one
operation
can
be
done
at
a
time
,
all
the
functions
will
return
MU_ERROR_OPERATION_IN_PROGRESS
if
call
during
another
operation
.
The
functions
@code
{
pop3_list_all
()},
@code
{
pop3_uidl_all
()}
and
@code
{
pop3_capa
()}
return
an
@code
{
iterator_t
},
when
iterating
@code
{
iterator_current
()}
will
return
an
object
that
should
be
cast
appropriatly
and
@code
{
free
()}
'
ed
by
the
caller
,
the
@code
{
iterator_t
}
must
also
be
destroy
ed
,
@code
{
iterator_destroy
()}.
@subsubsection
Initialisation
@cindex
POP3
Initialisation
@deftypefun
int
pop3_create
(
pop3_t
*
)
A
valid
@code
{
pop3_t
}
handle
must
be
create
first
.
A
valid
@code
{
pop3_t
}
handle
must
be
create
d
first
.
@table
@code
@item
MU_ERROR_NO_MEMORY
...
...
@@ -119,15 +119,15 @@ A valid @code{pop3_t} handle must be create first.
@deftypefun
void
pop3_destroy
(
pop3_t
*
)
When
the
POP3
session
is
finished
,
the
structure
must
be
free
to
reclaim
When
the
POP3
session
is
finished
,
the
structure
must
be
@code
{
free
()}
'
ed
to
reclaim
memory
.
@end
deftypefun
@deftypefun
int
pop3_open
(
pop3_t
,
const
char
*
@var
{
host
},
unsigned
port
,
int
@var
{
flags
})
A
connection
is
establish
by
calling
@code
{
pop3d_open
()}.
If
non
-
blocking
the
function
should
be
recall
until
the
return
value
is
no
MU_ERROR_TRY_AGAIN
or
MU_ERROR_IN_PROGRESS
.
A
connection
is
establish
ed
by
calling
@code
{
pop3d_open
()}.
If
non
-
blocking
the
function
should
be
recall
ed
until
the
return
value
is
not
MU_ERROR_TRY_AGAIN
or
MU_ERROR_IN_PROGRESS
.
@table
@code
@item
MU_ERROR_NO_MEMORY
...
...
@@ -141,10 +141,10 @@ or MU_ERROR_IN_PROGRESS.
@end
table
@end
deftypefun
@deftypefun
int
pop3_set_
carrier
(
pop3_t
,
stream_t
@var
{
carrier
});
@deftypefun
int
pop3_set_
stream
(
pop3_t
,
stream_t
@var
{
carrier
});
A
connection
may
have
been
started
elsewhere
,
in
this
case
the
@code{
stream_t
}
object
is
set
o
n
the
@code{
pop3_t
}
handle
.
object
is
set
i
n
the
@code{
pop3_t
}
handle
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -152,6 +152,10 @@ object is set on the @code{pop3_t} handle.
@end
deftypefun
@deftypefun
int
pop3_get_carrier
(
pop3_t
,
stream_t
*
@var{
carrier
}
)
;
Fill
in
the
@code{
stream_t
}
object
with
the
stream
form
the
@code{
pop3_t
}
handle
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
@item
MU_ERROR_NO_MEMORY
...
...
@@ -168,7 +172,7 @@ use of POP3, for example checking for new mail, it is the prefered
authentication
.
It
reduces
the
risk
of
passwd
capture
.
The
@var{
user
}
and
the
shared
@var{
secret
}
are
pass
to
@code{
pop3_apop
()
}
,
the
MD5
digest
is
calculated
by
applying
the
timestamp
given
by
the
server
in
the
greeting
followed
by
the
@var{
secret
}
and
a
@emph{
APOP
user
digest
}
command
is
send
.
followed
by
the
@var{
secret
}
and
@emph{
APOP
user
digest
}
command
is
send
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -185,8 +189,8 @@ followed by the @var{secret} and a @emph{APOP user digest} command is send.
@deftypefun
int
pop3_auth
(
pop3_t
,
const
char
*
@var{
auth
}
)
To
allow
the
use
of
mechanism
such
as
@emph{
SASL
}
,
@cite{
RFC
2449
}
,
extended
POP3
mechanism
w
h
ith
AUTH
.
It
permits
the
client
to
choose
an
alternate
way
of
authenticat
e
.
@strong{
Caution
:}
The
@code
{
pop_auth
()}
is
a
simple
POP3
mechanism
with
AUTH
.
It
permits
the
client
to
choose
an
alternate
way
of
authenticat
ing
.
@strong{
Caution
:}
The
@code
{
pop_auth
()}
is
a
simple
cover
function
that
sends
@emph
{
AUTH
auth
},
functions
@code
{
pop3_sendline
},
@code
{
pop3_readline
},
@code
{
pop3_response
}
or
the
pop3
stream
@code
{
pop3_get_carrier
()}
should
be
use
appropriately
to
deal
with
the
...
...
@@ -204,13 +208,13 @@ challenges.
@subsubsection
Capa
@cindex
POP3
Capa
@deftypefun
int
pop3_capa
(
pop3_t
,
iterator_t
*
)
@deftypefun
int
pop3_capa
(
pop3_t
,
iterator_t
*
@var
{
iterator
}
)
The
CAPA
command
is
send
to
the
sever
and
the
list
of
capabilities
is
return
in
an
@var
{
iterator
}.
The
@code
{
iterator_current
()}
should
be
cast
to
a
@code
{
char
**
}
and
the
string
should
be
free
by
the
caller
.
to
a
@code
{
char
**
}
and
the
string
should
be
@code
{
free
()}
'
ed
by
the
caller
.
@strong
{
Caution
:
}
The
iterator
must
be
destroy
after
use
,
it
will
discard
any
remaining
response
from
CAPA
and
clear
the
way
for
new
operations
.
any
remaining
response
s
from
CAPA
and
clear
the
way
for
new
operations
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -247,12 +251,12 @@ void print_capabilities (pop3_t pop3)
@end
deftypefun
@subsubsection
D
ele
@cindex
POP3
D
ele
@subsubsection
D
ELE
@cindex
POP3
D
ELE
@deftypefun
int
pop3_dele
(
pop3_t
,
unsigned
@var
{
msgno
})
Sends
A
Dele
to
the
servers
who
will
mark
the
@var
{
msgno
}
for
deletion
.
Sends
a
DELE
to
the
servers
who
will
mark
the
@var
{
msgno
}
for
deletion
.
The
@var
{
msgno
}
may
not
refer
to
a
message
already
marked
deleted
.
If
successfull
any
future
reference
to
@var
{
msgno
}
in
other
operations
will
be
an
error
,
unless
unmarked
by
RSET
.
...
...
@@ -267,13 +271,13 @@ be an error, unless unmarked by RSET.
@end
deftypefun
@subsubsection
L
ist
@cindex
POP3
L
ist
@subsubsection
L
IST
@cindex
POP3
L
IST
@cindex
struct
pop3_list
@deftypefun
int
pop3_list
(
pop3_t
,
unsigned
@var
{
msgno
},
size_t
*
@var
{
size
})
Sends
a
L
ist
for
a
specific
@var
{
msgno
}
and
returns
the
@var
{
size
}.
Sends
a
L
IST
for
a
specific
@var
{
msgno
}
and
returns
the
@var
{
size
}.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -284,12 +288,12 @@ Sends a List for a specific @var{msgno} and returns the @var{size}.
@end
table
@end
deftypefun
@deftypefun
int
pop3_list_all
(
pop3_t
,
unsigned
@var
{
msgno
},
iterator_t
*
)
@deftypefun
int
pop3_list_all
(
pop3_t
,
unsigned
@var
{
msgno
},
iterator_t
*
@var
{
iterator
}
)
Sends
A
LIST
with
no
argument
to
the
server
.
The
@var
{
iterator
}
must
be
destroy
after
use
,
it
will
discard
any
remaining
response
from
LIST
and
clear
the
way
for
new
operations
.
The
@code
{
iterator_current
()}
returns
a
@code
{
struct
pop3_list
*
}
that
must
be
@code
{
free
()}.
a
@code
{
struct
pop3_list
*
}
that
must
be
@code
{
free
()}
'
ed
.
@example
struct
pop3_list
...
...
@@ -371,7 +375,7 @@ Sends the PASS, to authenticate after the USER command.
@deftypefun
int
pop3_quit
(
pop3_t
)
Enter
the
UPDATE
state
.
The
server
will
delet
all
me
sages
marked
Enter
the
UPDATE
state
.
The
server
will
delet
e
all
mes
sages
marked
deleted
before
closing
the
connection
.
@table
@code
...
...
@@ -388,9 +392,9 @@ deleted before closing the connection.
@deftypefun
int
pop3_retr
(
pop3_t
,
unsigned
@var
{
msgno
},
stream_t
*
)
If
successfull
a
@code
{
stream_t
}
is
created
to
allow
dowloading
of
the
message
,
If
successfull
a
@code
{
stream_t
}
is
created
to
allow
dow
n
loading
of
the
message
,
byte
-
stuff
lines
or
handle
internally
,
CRLFs
are
converted
to
LF
.
All
other
operations
will
fail
ed
until
the
stream
is
destroyed
by
the
caller
.
operations
will
fail
until
the
stream
is
destroyed
by
the
caller
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -406,7 +410,7 @@ operations will failed until the stream is destroyed by the caller.
@deftypefun
int
pop3_rset
(
pop3_t
)
Sends
a
RSET
to
unmark
ed
the
messages
maked
deleted
.
Sends
a
RSET
to
unmark
the
messages
marked
as
deleted
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -422,8 +426,8 @@ Sends a RSET to unmarked the messages maked deleted.
@deftypefun
int
pop3_stat
(
pop3_t
,
unsigned
@var
{
msgno
},
unsigned
*
@var
{
msg_count
},
size_t
*
@var
{
size
})
Call
a
drop
listing
for
the
maildrop
.
The
number
of
messages
in
the
mailbox
and
the
size
of
the
mailbox
in
octets
.
@strong
{
Caution
:
}
The
size
is
in
RFC
The
number
of
messages
in
the
mailbox
and
the
size
of
the
mailbox
in
octets
.
@strong
{
Caution
:
}
The
size
is
in
RFC
822
where
line
termination
is
CRLF
,
messages
marked
as
deleted
are
not
counted
in
either
total
.
...
...
@@ -459,8 +463,8 @@ operations will failed until the stream is destroyed by the caller.
@deftypefun
int
pop3_uidl
(
pop3_t
,
unsigned
@var
{
msgno
},
char
**
@var
{
uidl
})
The
Uniq
Identifier
is
return
in
@var
{
uidl
},
the
string
must
be
free
,
by
the
caller
.
The
Uniq
Identifier
is
return
in
@var
{
uidl
},
the
string
must
be
@code
{
free
()}
'
ed
,
by
the
caller
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -474,8 +478,8 @@ by the caller.
@deftypefun
int
pop3_uidl_all
(
pop3_t
,
iterator_t
*
)
An
@code
{
iterator_t
}
object
is
return
to
iterate
through
the
response
and
must
be
destroy
by
the
caller
.
The
@code
{
iterator_current
()}
is
a
@code
{
char
**
}
that
must
be
@code
{
free
()}
by
the
caller
.
must
be
destroy
ed
by
the
caller
.
The
@code
{
iterator_current
()}
is
a
@code
{
char
**
}
that
must
be
@code
{
free
()}
'
ed
by
the
caller
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -507,7 +511,7 @@ Sends the User command.
@deftypefun
int
pop3_writeline
(
pop3_t
,
const
char
*
@var
{
format
},
...);
Copy
in
the
internal
buffer
of
@code
{
pop3_t
}
the
string
,
@code
{
pop3_send
()}
should
be
call
later
to
flush
the
string
to
POP3
server
.
should
be
call
ed
later
to
flush
the
string
to
the
POP3
server
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
@@ -545,7 +549,7 @@ int pop3_sendline (pop3_t pop3, const char *line)
@deftypefun
int
pop3_send
(
pop3_t
,
const
char
*
@var
{
cmd
});
Flushes
out
the
strings
in
t
the
@code
{
pop3_t
}
internal
buffer
to
the
channel
.
Flushes
out
the
strings
in
the
@code
{
pop3_t
}
internal
buffer
to
the
channel
.
@table
@code
@item
MU_ERROR_INVALID_PARAMETER
...
...
doc/sendmail.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{sendmail_} is reserve */
}
@code
{
/* Prefix @emph{sendmail_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
sendmail
.
h
>
}
@end
example
Spawning
Sedmail
daemon
to
deliver
mail
.
Not
implemented
.
Spawning
Se
n
dmail
daemon
to
deliver
mail
.
Not
implemented
.
...
...
doc/smtp.texi
View file @
c5fe2fd
@example
@code
{
/* Prefix @emph{smtp_} is reserve */
}
@code
{
/* Prefix @emph{smtp_} is reserve
d
*/
}
@code
{
#
include
<
mailutils
/
smtp
.
h
>
}
@end
example
...
...
Please
register
or
sign in
to post a comment