Added some text to the envelope docs, still incomplete.
Showing
1 changed file
with
27 additions
and
7 deletions
1 | @example | 1 | @example |
2 | @code{/* Prefix @emph{envelope_} is reserved */} | 2 | @code{/* Prefix @emph{envelope_} is reserved */} |
3 | @code{#include <mailutils/envelope.h>} | 3 | @code{#include <mailutils/envelope.h>} |
4 | |||
5 | @end example | 4 | @end example |
6 | 5 | ||
7 | @deftypefun int envelope_create (envelope_t *, void *); | 6 | @deftypefun int envelope_date (envelope_t, char *, size_t, size_t *); |
7 | |||
8 | Get the date that the message was delivered to the mailbox, in | ||
9 | something close to ANSI ctime() format: Mon Jul 05 13:08:27 1999. | ||
10 | |||
8 | @end deftypefun | 11 | @end deftypefun |
9 | 12 | ||
10 | @deftypefun void envelope_destroy (envelope_t *, void *); | 13 | @deftypefun int envelope_sender (envelope_t, char *, size_t, size_t *); |
14 | |||
15 | Get the address that this message was reportedly received from. This | ||
16 | would be the "mail from" argument if the message was delivered | ||
17 | or received via SMTP, for example. | ||
18 | |||
11 | @end deftypefun | 19 | @end deftypefun |
12 | 20 | ||
13 | @deftypefun int envelope_get_message (envelope_t, message_t *); | 21 | @deftypefun int envelope_get_message (envelope_t, message_t *); |
14 | @end deftypefun | 22 | @end deftypefun |
15 | 23 | ||
16 | @deftypefun int envelope_set_sender (envelope_t, int (*_sender) __P ((envelope_t, char *, size_t, size_t*)), void *); | 24 | @deftypefun int envelope_create (envelope_t *, void *); |
25 | Primarily for internal use. | ||
17 | @end deftypefun | 26 | @end deftypefun |
18 | 27 | ||
19 | @deftypefun int envelope_sender (envelope_t, char *, size_t, size_t *); | 28 | @deftypefun void envelope_destroy (envelope_t *, void *); |
29 | Primarily for internal use. | ||
20 | @end deftypefun | 30 | @end deftypefun |
21 | 31 | ||
22 | @deftypefun int envelope_set_date (envelope_t, int (*_date) __P ((envelope_t, char *, size_t, size_t *)), void *); | 32 | @deftypefun int envelope_set_sender (envelope_t, int (*_sender) __P ((envelope_t, char *, size_t, size_t*)), void *); |
33 | |||
34 | Primarily for internal use. The implementation of envelope_t depends | ||
35 | on the mailbox type, this allows the function which actually gets | ||
36 | the sender to be set by the creator of an envelope_t. | ||
37 | |||
23 | @end deftypefun | 38 | @end deftypefun |
24 | 39 | ||
25 | @deftypefun int envelope_date (envelope_t, char *, size_t, size_t *); | 40 | @deftypefun int envelope_set_date (envelope_t, int (*_date) __P ((envelope_t, char *, size_t, size_t *)), void *); |
41 | |||
42 | Primarily for internal use. The implementation of envelope_t depends | ||
43 | on the mailbox type, this allows the function which actually gets | ||
44 | the date to be set by the creator of an envelope_t. | ||
45 | |||
26 | @end deftypefun | 46 | @end deftypefun | ... | ... |
-
Please register or sign in to post a comment