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
f3c0fbdc
...
f3c0fbdc796a3d0c834df77810b6b2ee3d0d441d
authored
2002-12-13 15:52:11 +0000
by
Sergey Poznyakoff
Browse Files
Options
Browse Files
Tag
Download
Email Patches
Plain Diff
Updated
1 parent
c197054d
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
69 additions
and
38 deletions
doc/texinfo/framework.texi
doc/texinfo/libsieve.texi
doc/texinfo/mailutils.texi
doc/texinfo/programs.texi
doc/texinfo/framework.texi
View file @
f3c0fbd
...
...
@@ -20,10 +20,11 @@
*
Parse822
::
Parsing
RFC
822
headers
@end
menu
Wherever
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
heteroclite
set
of
objects
that
work
in
aggregation
to
do
operations
on
emails
.
Each
object
do
a
specific
task
and
delegates
non
related
tasks
to
Wherever
the
mail
is
and
whatever
format
it
is
stored
in
,
it
is
operated
upon
using
the
same
set
of
functions
.
To
unified
the
C
API
,
@sc
{
gnu
}
Mailutils
offers
a
heteroclite
set
of
objects
that
work
in
aggregation
to
do
operations
on
emails
.
Each
object
does
a
specific
task
and
delegates
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
..).
...
...
@@ -67,13 +68,15 @@ created, it will indicate the storage format or protocol
@end
group
@end
example
For
example
writing
a
simple
@code
{
from
}
command
that
will
list
the
@emph
{
From
}
and
@emph
{
Subject
}
headers
of
every
mail
in
a
mailbox
.
As
an
example
,
here
is
a
simplified
version
of
@code
{
from
}
command
.
It
lists
the
@samp
{
From
}
and
@samp
{
Subject
}
headers
of
every
mail
in
a
mailbox
.
@example
@include
sfrom
.
inc
@end
example
Here
is
a
sample
output
produced
by
this
program
:
@example
@cartouche
%
MAIL
=
pop
:
//alain@@localhost ./sfrom
...
...
doc/texinfo/libsieve.texi
View file @
f3c0fbd
...
...
@@ -3,7 +3,7 @@
@c
See
file
mailutils
.
texi
for
copying
conditions
.
@comment
*******************************************************************
This
chapter
describes
GNU
Sieve
library
.
This
chapter
describes
@sc
{
gnu
}
Sieve
library
.
@menu
*
Library
Description
::
...
...
@@ -587,7 +587,7 @@ Dump the disassembled code of the sieve machine @var{mach}.
@node
Input
Language
@section
Input
Language
The
input
language
understood
by
the
GNU
Sieve
Library
is
a
superset
of
The
input
language
understood
by
the
@sc
{
gnu
}
Sieve
Library
is
a
superset
of
the
Sieve
language
as
described
in
RFC
3028
.
@menu
...
...
@@ -600,13 +600,13 @@ the Sieve language as described in RFC 3028.
@end
menu
@node
Syntax
@subsection
@subsection
Syntax
@node
Preprocessor
@subsection
Preprocessor
@cindex
Sieve
preprocessor
statements
,
a
GNU
extension
@cindex
Sieve
preprocessor
statements
,
a
@sc
{
gnu
}
extension
The
preprocessor
statements
are
a
GNU
extension
to
the
Sieve
language
.
The
preprocessor
statements
are
a
@sc
{
gnu
}
extension
to
the
Sieve
language
.
The
syntax
for
a
preprocessor
statement
is
similar
to
that
used
in
@code
{
C
}
programming
language
,
i
.
e
.
:
a
pound
character
(
@samp
{
#
})
followed
by
a
preprocessor
directive
and
any
arguments
.
Any
amount
of
...
...
@@ -644,7 +644,7 @@ If @var{filename} starts with a directory separator character
The @code{#searchpath} directive adds its argument to the list of
directories searched for loadable modules. It has the same effect
as @option{-L} command line switch used by
GNU
sieve utility
as @option{-L} command line switch used by
@sc{gnu}
sieve utility
(@pxref{sieve group}).
@node Require Statement
...
...
@@ -672,7 +672,7 @@ Otherwise, the capability is understood as a name of an action to be
used.
The @code{require} statement, if present, must be used before any other
statement that is using the required capability. As an extension, the
GNU
statement that is using the required capability. As an extension, the
@sc{gnu}
sieve allows the @code{require} and any other statements to be
interspersed.
...
...
@@ -695,7 +695,7 @@ require "fileinto";
require "
comparator
-
i
;
ascii
-
numeric
";
@end example
When processing arguments for @code{require} statement,
GNU
libsieve
When processing arguments for @code{require} statement,
@sc{gnu}
libsieve
uses the following algorithm:
@enumerate 1
...
...
@@ -765,7 +765,7 @@ source for the required action NAME is not available
@node Comparators
@subsection Comparators
GNU
libsieve supports the following built-in comparators:
@sc{gnu}
libsieve supports the following built-in comparators:
@table @code
@item i;octet
...
...
@@ -784,7 +784,7 @@ be explicitly required prior to use.
@node Tests
@subsection Tests
This section describes the built-in tests supported by
GNU
libsieve.
This section describes the built-in tests supported by
@sc{gnu}
libsieve.
In the discussion below the following macro-notations are used:
@table @var
...
...
@@ -961,7 +961,7 @@ If the argument is @samp{:under}, and the size of the message is less than
the @var{number}, the test is true; otherwise, it is false.
Otherwise, the test is true only if the size of the message equals
exactly @var{number}. This is a
GNU
extension.
exactly @var{number}. This is a
@sc{gnu}
extension.
The size of a message is defined to be the number of octets from the
initial header until the last character in the message body.
...
...
@@ -1036,7 +1036,7 @@ if not exists ["From","Date"]
@end example
@end deffn
@deffn header [@var{comparator}] [@var{match-type}] [:mime] @var{header-names} @var{key-list}
@deffn
Test
header [@var{comparator}] [@var{match-type}] [:mime] @var{header-names} @var{key-list}
@sp 1
@noindent
Tagged arguments:
...
...
@@ -1112,7 +1112,7 @@ If the tagged argument is not given, @samp{:over} is assumed.
@node Actions
@subsection Actions
The
GNU
libsieve supports the following default actions:
The
@sc{gnu}
libsieve supports the following default actions:
@itemize
@item stop
...
...
@@ -1273,7 +1273,7 @@ the old message in a new one.
@node Extensions
@section Extensions
This section summarizes the
GNU
extensions to the sieve language
This section summarizes the
@sc{gnu}
extensions to the sieve language
@enumerate 1
...
...
@@ -1281,7 +1281,7 @@ This section summarizes the GNU extensions to the sieve language
@itemize
@item According to the RFC an error must occur if a @code{require} appears
after a command other than @code{require}. The
GNU
sieve library allows
after a command other than @code{require}. The
@sc{gnu}
sieve library allows
interspersing the @code{require} and other statements. The only
requirement is that @code{require} must occur before a statement that is
using the required capability (@pxref{Require Statement}).
...
...
@@ -1309,7 +1309,7 @@ may disappear from the subsequent releases.
@item Match type optional argument.
Along with the usual @code{:is}, @code{:matches} and @code{contains}
matching type,
GNU
sieve library understands @code{:regex} type. This
matching type,
@sc{gnu}
sieve library understands @code{:regex} type. This
matching type toggles POSIX Extended Regular Expression matching.
@end enumerate
...
...
@@ -1318,7 +1318,7 @@ matching type toggles POSIX Extended Regular Expression matching.
@section Writing Loadable Commands
This section contains an example of how to write external loadable
commands for
GNU
libsieve.
commands for
@sc{gnu}
libsieve.
@example
@include numaddr.inc
...
...
doc/texinfo/mailutils.texi
View file @
f3c0fbd
...
...
@@ -40,8 +40,9 @@
*
pop3d
:
(
mailutils
)
pop3d
.
POP3
daemon
*
readmsg
:
(
mailutils
)
readmsg
.
Extract
messages
from
a
folder
*
sieve
:
(
mailutils
)
sieve
.
Mail
filtering
utility
*
mailutils
-
config
:
(
mailutils
)
mailutils
-
config
.
Get
the
information
about
the
Mailutils
build
.
@end
direntry
This
file
documents
@sc
{
mailutils
}
,
library
API
.
This
file
documents
Mailutils
,
library
API
.
Published
by
the
Free
Software
Foundation
,
...
...
@@ -75,13 +76,13 @@ by the Foundation.
@setchapternewpage
off
@titlepage
@title
m
ailutils
,
SDK
.
@title
M
ailutils
,
SDK
.
@subtitle
version
@value
{
VERSION
},
@value
{
UPDATED
}
@author
Alain
Magloire
et
al
.
@page
@vskip
0
pt
plus
1
filll
Copyright
@copyright
{}
1999
,
2000
,
2001
Free
Software
Foundation
,
Inc
.
Copyright
@copyright
{}
1999
,
2000
,
2001
,
2002
Free
Software
Foundation
,
Inc
.
@sp
2
Published
by
the
Free
Software
Foundation
,
@
*
...
...
@@ -113,21 +114,22 @@ by the Foundation.
@ifinfo
This
document
was
produced
for
version
@value
{
VERSION
}
of
@sc
{
gnu
}
@sc
{
mailutils
}
.
Mailutils
.
@end
ifinfo
@menu
*
Introduction
::
GNU
@sc
{
mailutils
}
*
Introduction
::
GNU
Mailutils
@comment
*
Concrete
API
::
Concrete
API
.
*
Framework
::
Framework
.
*
Authentication
Library
::
*
Sieve
Library
::
*
Authentication
Library
::
Auxiliary
library
for
authenticating
users
.
*
Sieve
Library
::
GNU
implementation
of
Sieve
mail
filtering
.
*
Programs
::
Programs
.
*
Reporting
Bugs
::
Reporting
Bugs
.
*
Reporting
Bugs
::
How
to
report
a
bug
.
*
News
::
Where
to
get
information
about
@sc
{
gnu
}
Mailutils
*
Acknowledgement
::
Thanks
and
Credits
.
Indices
*
Function
Index
::
All
@sc
{
Mailutils
}
Functions
.
*
Program
Index
::
All
@sc
{
Mailutils
}
Programs
.
*
Function
Index
::
All
Mailutils
Functions
.
*
Program
Index
::
All
Mailutils
Programs
.
*
Concept
Index
::
Index
of
Concepts
.
@end
menu
...
...
@@ -137,7 +139,7 @@ Indices
@chapter
Introduction
@cindex
Introduction
@sc
{
gnu
}
@sc
{
Mailutils
}
offers
a
general
purpose
library
whose
aim
is
to
@sc
{
gnu
}
Mailutils
offers
a
general
purpose
library
whose
aim
is
to
provide
a
rich
set
of
functions
for
accessing
different
mailbox
formats
and
mailers
.
...
...
@@ -290,15 +292,39 @@ Notifications}
@include
programs
.
texi
@page
@node
Reporting
Bugs
,
Acknowledgement
,
Programs
,
Top
@node
Reporting
Bugs
,
News
,
Programs
,
Top
@comment
node
-
name
,
next
,
previous
,
up
@chapter
Reporting
Bugs
@cindex
Reporting
Bugs
Email
bug
reports
to
@email
{
bug
-
mailutils
@@gnu
.
org
}.
Be
sure
to
include
the
word
``
mailutils
''
somewhere
in
the
``
Subject
:
''
field
.
Be
sure
to
include
the
word
``
mailutils
''
somewhere
in
the
``
Subject
:
''
field
.
@node
Acknowledgement
,
Function
Index
,
Reporting
Bugs
,
Top
As
the
purpose
of
bug
reporting
is
to
improve
software
,
please
be
sure
to
include
maximum
information
when
reporting
a
bug
.
The
information
needed
is
:
@itemize
@item
Version
of
the
package
you
are
using
.
@item
Compilation
options
used
when
configuring
the
package
.
@item
Conditions
under
which
the
bug
appears
.
@end
itemize
The
archives
of
bug
-
mailutils
mailing
list
are
available
from
@url
{
http
:
//mail.gnu.org/mailman/listinfo/bug-mailutils}.
@node
News
,
Acknowledgement
,
Reporting
Bugs
,
Top
@chapter
Getting
news
about
@sc
{
gnu
}
mailutils
The
two
places
to
look
for
any
news
regarding
@sc
{
gnu
}
Mailutils
are
the
Mailutils
homepage
at
@url
{
http
:
//www.gnu.org/software/mailutils}, and the
project
page
at
@url
{
http
:
//savannah.gnu.org/projects/mailutils}.
The
updated
versions
of
this
manual
are
available
online
from
@url
{
http
:
//www.gnu.org/software/mailutils/manual}.
@node
Acknowledgement
,
Function
Index
,
News
,
Top
@comment
node
-
name
,
next
,
previous
,
up
@chapter
Acknowledgement
@cindex
Acknowledgement
...
...
@@ -324,6 +350,8 @@ Sam Roberts @email{sroberts@@uniserve.com},
Sergey
Poznyakoff
@email
{
gray
@@Mirddin
.
farlep
.
net
},
@item
Fran
@
,{
c
}
ois
Pinard
@email
{
pinard
@@IRO
.
UMontreal
.
CA
}.
@item
Jordi
Mallach
@email
{
jordi
@@sindominio
.
net
}
@end
itemize
@page
...
...
@@ -331,7 +359,7 @@ Fran@,{c}ois Pinard @email{pinard@@IRO.UMontreal.CA}.
@comment
node
-
name
,
next
,
previous
,
up
@unnumbered
Function
Index
This
is
an
alphabetical
list
of
all
@sc
{
mailutils
}
functions
.
This
is
an
alphabetical
list
of
all
Mailutils
functions
.
@printindex
fn
@page
...
...
doc/texinfo/programs.texi
View file @
f3c0fbd
This diff is collapsed.
Click to expand it.
Please
register
or
sign in
to post a comment