This document describes version 0.4d1 of Vicare/libESMTP, a distribution of C and Scheme libraries for Vicare Scheme, an R6RS compliant Scheme implementation; it provides bindings for the libESMTP C language library.
The package is distributed under the terms of the GNU General Public License (GPL) and can be downloaded from:
development takes place at:
and as backup at:
libESMTP is available at:
Copyright © 2013, 2015, 2017 by Marco Maggi marco.maggi.ipsu@poste.it
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with Invariant Sections being “GNU Free Documentation License” and “GNU General Public License”, no Front–Cover Texts, and no Back–Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
| • overview: | Overview of the package. | |
| • version: | Libesmtp version informations. | |
| • plain: | Plain programming interface. | |
Appendices | ||
|---|---|---|
| • Package License: | GNU General Public License. | |
| • Documentation License: | GNU Free Documentation License. | |
| • references: | Bibliography and references. | |
Indexes | ||
| • concept index: | An entry for each concept. | |
| • function index: | An entry for each function. | |
| • variable index: | An entry for each variable. | |
| • type index: | An entry for each type. | |
Vicare Scheme is an R6RS compliant Scheme language implementation in the form of a native compiler for x86 architectures, officially supporting GNU+Linux systems. Vicare/libESMTP is a distribution of C language and Scheme language libraries for Vicare Scheme; it provides bindings for the libESMTP C language library.
The last time the author bothered to update this paragraph, he had tested libESMTP version 1.0.7rc1; the libESMTP library is available at:
The package installs a C language library implementing wrapper C
functions for the C language libESMTP library; on top of this, the
Scheme library (vicare email libesmtp) exports one binding for
each libESMTP public function; additionally the library
(vicare email libesmtp constants) exports one binding for each
constant value defined in the C language header libesmtp.h.
The following Scheme libraries are installed:
(vicare email libesmtp)It exports one binding for each libESMTP public function. All the
Scheme function names are directly derived from the C function names by
replacing underscore characters ‘_’ with dash characters ‘-’;
so smtp_version() becomes smtp-version.
(vicare email libesmtp unsafe-capi)It exports one syntax binding for each libESMTP public function. All
the Scheme syntax names are directly derived from the C function names
by replacing underscore characters ‘_’ with dash characters
‘-’; so smtp_version() becomes smtp-version.
These syntaxes expand to a direct call to the C language wrapper functions in the Vicare/libESMTP library; they are not meant to be called in normal usage of the package.
(vicare email libesmtp constants)It exports one binding for each constant value defined in the C language header libesmtp.h.
(vicare email libesmtp features)It exports one identifier syntax binding for each HAVE_ constant
defined by the configure script, expanding to #t or
#f.
The installed C library follows version numbering as established by the GNU Autotools. For an explanation of interface numbers as managed by GNU Libtool See Libtool’s versioning system in Shared library support for GNU.
The following bindings are exported by the library (vicare email
libesmtp).
Return a fixnum representing a version number.
Return a Scheme string representing the version number.
Return a Scheme string representing the version number of libESMTP.
In the very unlikely case that this function fails: #f is
returned.
Next: Package License, Previous: version, Up: Top [Contents][Index]
| • plain examples: | Usage examples. | |
| • plain structs: | Data structures. | |
| • plain errors: | Library errors. | |
| • plain sessions: | Session management. | |
| • plain messages: | Message management. | |
| • plain recipients: | Recipient management. | |
| • plain headers: | Headers management. | |
| • plain status: | Session results. | |
| • plain constants: | Converting constants to symbols. | |
| • plain data: | Application data. | |
| • plain extensions: | SMTP extensions. |
Next: plain structs, Up: plain [Contents][Index]
| • plain examples simple: | Simple message mailing. | |
| • plain examples cb: | Simple message mailing using the full message callback. | |
| • plain examples debug: | Simple message mailing with debug callbacks. |
Next: plain examples cb, Up: plain examples [Contents][Index]
The following program sends a message with no frills; make use of
smtp-set-message-str to feed the message to libESMTP:
#!r6rs
(import (rnrs)
(only (vicare language-extensions)
pretty-print
fprintf)
(prefix (vicare email libesmtp) esmtp.)
(prefix (vicare email libesmtp constants) esmtp.)
(prefix (vicare ffi) ffi.))
(define local-hostname
"localhost")
(define smtp-server
"localhost:smtp")
(define sender-mailbox
"marco@localhost")
(define recipient-mailbox
"marco@localhost")
(define message-text
"From: <marco@localhost>\r\n\
To: <marco@localhost>\r\n\
Subject: demo of vicare/libesmtp\r\n\
\r\n\
This is the text.\r\n")
(let* ((sex (esmtp.smtp-create-session))
(msg (esmtp.smtp-add-message sex))
(rec (esmtp.smtp-add-recipient msg recipient-mailbox))
(cstr (ffi.string->cstring message-text)))
(unwind-protect
(begin
(esmtp.smtp-set-server sex smtp-server)
(esmtp.smtp-set-reverse-path msg sender-mailbox)
(esmtp.smtp-set-hostname sex local-hostname)
(esmtp.smtp-set-message-str msg cstr)
(esmtp.smtp-start-session sex)
(fprintf (current-error-port)
"recipient complete? ~a\n"
(esmtp.smtp-recipient-check-complete rec)))
(esmtp.smtp-destroy-session sex)))
Next: plain examples debug, Previous: plain examples simple, Up: plain examples [Contents][Index]
The following program sends a message with no frills; make use of
smtp-set-messagecb to feed the message to libESMTP:
#!r6rs
(import (rnrs)
(only (vicare language-extensions)
pretty-print
fprintf)
(prefix (vicare email libesmtp) esmtp.)
(prefix (vicare email libesmtp constants) esmtp.)
(prefix (vicare ffi) ffi.))
(define local-hostname
"localhost")
(define smtp-server
"localhost:smtp")
(define sender-mailbox
"marco@localhost")
(define recipient-mailbox
"marco@localhost")
(define message-text
"From: <marco@localhost>\r\n\
To: <marco@localhost>\r\n\
Subject: demo of vicare/libesmtp\r\n\
\r\n\
This is the text.\r\n")
(define (make-message-cb message-text)
(let ((cstr.ptr #f)
(cstr.len #f))
(lambda (unused len.ptr)
(cond ((ffi.pointer-null? len.ptr)
;;If LEN.PTR is set to NULL: this call is to ask the
;;application to rewind the message; the return value
;;is not used, but it must be a pointer.
(set! cstr.ptr (ffi.string->cstring message-text))
(set! cstr.len (ffi.strlen cstr.ptr))
(ffi.null-pointer))
(cstr.len
;;If LEN.PTR is not NULL: this callback must return a
;;pointer to the start of the next message chunk and
;;set the location referenced by LEN.PTR to the number
;;of octets of data in the buffer.
(ffi.pointer-set-c-signed-int! len.ptr 0 cstr.len)
(set! cstr.len #f)
cstr.ptr)
(else
;;The callback is called repeatedly until the entire
;;message has been processed. When all the message
;;data has been read the callback must return NULL.
(ffi.pointer-set-c-signed-int! len.ptr 0 0)
(ffi.null-pointer))))))
(let* ((sex (esmtp.smtp-create-session))
(msg (esmtp.smtp-add-message sex))
(rec (esmtp.smtp-add-recipient msg recipient-mailbox))
(mcb (esmtp.make-smtp-messagecb
(make-message-cb message-text))))
(unwind-protect
(begin
(esmtp.smtp-set-server sex smtp-server)
(esmtp.smtp-set-reverse-path msg sender-mailbox)
(esmtp.smtp-set-hostname sex local-hostname)
(esmtp.smtp-set-messagecb msg mcb)
(esmtp.smtp-start-session sex)
(fprintf (current-error-port)
"recipient complete? ~a\n"
(esmtp.smtp-recipient-check-complete rec)))
(esmtp.smtp-destroy-session sex)
(ffi.free-c-callback mcb)))
Previous: plain examples cb, Up: plain examples [Contents][Index]
The following program sends a message and shows debugging callbacks;
make use of smtp-set-message-str to feed the message to
libESMTP:
#!r6rs
(import (rnrs)
(only (vicare language-extensions)
pretty-print
fprintf)
(prefix (vicare email libesmtp) esmtp.)
(prefix (vicare email libesmtp constants) esmtp.)
(prefix (vicare ffi) ffi.))
(define local-hostname
"localhost")
(define smtp-server
"localhost:smtp")
(define sender-mailbox
"marco@localhost")
(define recipient-mailbox
"marco@localhost")
(define message-text
"From: <marco@localhost>\r\n\
To: <marco@localhost>\r\n\
Subject: demo of vicare/libesmtp\r\n\
\r\n\
This is the text.\r\n")
(define (monitor-cb buf.ptr buf.len writing)
(fprintf (current-error-port)
"monitor: ~a, ~a"
(esmtp.smtp-cb->symbol writing)
(ffi.cstring->string buf.ptr buf.len)))
(define (event-cb session event-no)
(fprintf (current-error-port)
"event: ~a\n"
(esmtp.smtp-event->symbol event-no)))
(let* ((sex (esmtp.smtp-create-session))
(msg (esmtp.smtp-add-message sex))
(rec (esmtp.smtp-add-recipient msg recipient-mailbox))
(cstr (ffi.string->cstring message-text))
(mcb (esmtp.make-smtp-monitorcb monitor-cb))
(ecb (esmtp.make-smtp-eventcb event-cb)))
(unwind-protect
(begin
(esmtp.smtp-set-monitorcb sex mcb #t)
(esmtp.smtp-set-eventcb sex ecb)
(esmtp.smtp-set-server sex smtp-server)
(esmtp.smtp-set-reverse-path msg sender-mailbox)
(esmtp.smtp-set-hostname sex local-hostname)
(esmtp.smtp-set-message-str msg cstr)
(esmtp.smtp-start-session sex)
(fprintf (current-error-port)
"recipient complete? ~a\n"
(esmtp.smtp-recipient-check-complete rec)))
(esmtp.smtp-destroy-session sex)
(ffi.free-c-callback mcb)
(ffi.free-c-callback ecb)))
Next: plain errors, Previous: plain examples, Up: plain [Contents][Index]
| • plain structs session: | Session data structures. | |
| • plain structs message: | Message data structures. | |
| • plain structs recipient: | Recipient data structures. | |
| • plain structs etrn node: | ETRN node data structures. | |
| • plain structs auth ctx: | AUTH context structures. | |
| • plain structs status: | Status data structures. |
Next: plain structs message, Up: plain structs [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
An opaque Scheme structure holding an instance of the C language type
smtp_session_t, it references a session.
When instances of this type are used as arguments to functions: this documentation identifies them as session.
There are two categories of smtp-session instances: those who own
the underlying SMTP session and those who merely reference it.
smtp-session instances returned by smtp-create-session do
own the session. When instances of this category are garbage collected
or when smtp-destroy-session is applied to them: the session is
closed, all the associated data is finalised; any error is ignored in
this procedure.
Return #t if obj is an instance of smtp-session;
otherwise return #f.
Return #t if obj is an instance of smtp-session and
the smtp_session_t it represents is open; otherwise return
#f.
Retrieve or set a destructor function associated to the session.
Whenever the session is closed, either explicitly with
smtp-destroy-session or implicitly by the garbage collector,
func is applied to session before the internal state of
session is finalised.
Notice that func can do anything, not only destroy some state associated to session; if we do:
(define session ...)
(set-smtp-session-custom-destructor! session
(let ((state (make-some-data-struct)))
(case-lambda
((sex)
(destroy state))
(()
state))))
(let ((state ((smtp-session-custom-destructor session))))
(do-something-with session state))
we can easily associate values to session.
The following bindings are meant to be used along the library
(vicare arguments validation).
Succeed if obj satisfies the predicate smtp-session?; the
second clause also accepts #f.
Succeed if obj satisfies the predicate smtp-session?/alive;
the second clause also accepts #f.
Next: plain structs recipient, Previous: plain structs session, Up: plain structs [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
An opaque Scheme structure holding an instance of the C language type
smtp_message_t, it references a message associated to an SMTP
session.
When instances of this type are used as arguments to functions: this documentation identifies them as message.
Instances of type smtp-message never own the underlying message;
when these instances are garbage collected or when
smtp-destroy-session is applied to the owning session: the
message is closed, all the associated data is finalised; any error is
ignored in this procedure.
Return #t if obj is an instance of smtp-message;
otherwise return #f.
Return #t if obj is an instance of smtp-message and
the smtp_message_t it represents is open; otherwise return
#f.
Retrieve or set a destructor function associated to the message.
Whenever the message is finalised: func is applied to message before the internal state of message is finalised.
Notice that func can do anything, not only destroy some state associated to message; if we do:
(define connection ...)
(set-smtp-message-custom-destructor! connection
(let ((state (make-some-data-struct)))
(case-lambda
((conn)
(destroy state))
(()
state))))
(let ((state ((smtp-message-custom-destructor connection))))
(do-something-with connection state))
we can easily associate values to message.
The following bindings are meant to be used along the library
(vicare arguments validation).
Succeed if obj satisfies the predicate smtp-message?; the
second clause also accepts #f.
Succeed if obj satisfies the predicate smtp-message?/alive;
the second clause also accepts #f.
Next: plain structs etrn node, Previous: plain structs message, Up: plain structs [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
An opaque Scheme structure holding an instance of the C language type
smtp_recipient_t, it references a message recipient associated to
a message.
When instances of this type are used as arguments to functions: this documentation identifies them as recipient.
Instances of type smtp-recipient never own the underlying
recipient; when these instances are garbage collected or when
smtp-destroy-session is applied to the session owning the
associated message: the recipient is closed, all the associated data is
finalised; any error is ignored in this procedure.
Return #t if obj is an instance of smtp-recipient;
otherwise return #f.
Return #t if obj is an instance of smtp-recipient and
the smtp_recipient_t it represents is open; otherwise return
#f.
Retrieve or set a destructor function associated to the recipient.
Whenever the recipient is finalised: func is applied to recipient before the internal state of recipient is finalised.
Notice that func can do anything, not only destroy some state associated to recipient; if we do:
(define connection ...)
(set-smtp-recipient-custom-destructor! connection
(let ((state (make-some-data-struct)))
(case-lambda
((conn)
(destroy state))
(()
state))))
(let ((state ((smtp-recipient-custom-destructor connection))))
(do-something-with connection state))
we can easily associate values to recipient.
The following bindings are meant to be used along the library
(vicare arguments validation).
Succeed if obj satisfies the predicate smtp-recipient?; the
second clause also accepts #f.
Succeed if obj satisfies the predicate
smtp-recipient?/alive; the second clause also accepts #f.
Next: plain structs auth ctx, Previous: plain structs recipient, Up: plain structs [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
An opaque Scheme structure holding an instance of the C language type
smtp_etrn_node_t, it references an ETRN node associated to a
session.
When instances of this type are used as arguments to functions: this documentation identifies them as etrn-node.
Instances of type smtp-etrn-node never own the underlying ETRN
node structure; when these instances are garbage collected or when
smtp-destroy-session is applied to the session owning the
associated message: the ETRN node is closed, all the associated data
is finalised; any error is ignored in this procedure.
Return #t if obj is an instance of smtp-etrn-node;
otherwise return #f.
Return #t if obj is an instance of smtp-etrn-node and
the smtp_etrn_node_t it represents is open; otherwise return
#f.
Retrieve or set a destructor function associated to the etrn-node.
Whenever the etrn-node is finalised: func is applied to etrn-node before the internal state of etrn-node is finalised.
Notice that func can do anything, not only destroy some state associated to etrn-node; if we do:
(define connection ...)
(set-smtp-etrn-node-custom-destructor! connection
(let ((state (make-some-data-struct)))
(case-lambda
((conn)
(destroy state))
(()
state))))
(let ((state ((smtp-etrn-node-custom-destructor connection))))
(do-something-with connection state))
we can easily associate values to etrn-node.
The following bindings are meant to be used along the library
(vicare arguments validation).
Succeed if obj satisfies the predicate smtp-etrn-node?; the
second clause also accepts #f.
Succeed if obj satisfies the predicate
smtp-etrn-node?/alive; the second clause also accepts #f.
Next: plain structs status, Previous: plain structs etrn node, Up: plain structs [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
An opaque Scheme structure holding an instance of the C language type
auth_context_t, it references an AUTH context data structure.
When instances of this type are used as arguments to functions: this documentation identifies them as auth-ctx.
There are two categories of auth-context instances: those
who own the underlying AUTH context and those who merely reference
it.
auth-context instances returned by auth-create-context do
own the context. When instances of this category are garbage collected
or when auth-destroy-context is applied to them: the context is
closed, all the associated data is finalised; any error is ignored in
this procedure.
Return #t if obj is an instance of auth-context;
otherwise return #f.
Return #t if obj is an instance of auth-context and
the auth_context_t it represents is open; otherwise return
#f.
Retrieve or set a destructor function associated to the auth-ctx.
Whenever the auth-ctx is finalised: func is applied to auth-ctx before the internal state of auth-ctx is finalised.
Notice that func can do anything, not only destroy some state associated to auth-ctx; if we do:
(define connection ...)
(set-auth-context-custom-destructor! connection
(let ((state (make-some-data-struct)))
(case-lambda
((conn)
(destroy state))
(()
state))))
(let ((state ((auth-context-custom-destructor connection))))
(do-something-with connection state))
we can easily associate values to auth-ctx.
The following bindings are meant to be used along the library
(vicare arguments validation).
Succeed if obj satisfies the predicate auth-context?; the
second clause also accepts #f.
Succeed if obj satisfies the predicate auth-context?/alive;
the second clause also accepts #f.
Previous: plain structs auth ctx, Up: plain structs [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Type of data structure mirroring the C language type
smtp_status_t. It has the following fields:
codeExact integer in the range of the C language type signed int;
SMTP protocol status code.
textScheme string; text from the server.
enh-classenh-subjectenh-detailExact integers in the range of the C language type signed int;
RFC 2034 enhanced status code triplet.
Build and return a new instance of smtp-status.
Return #t if obj is an instance of smtp-status;
otherwise return #f.
Accessors for the fields of smtp-status instances.
Mutators for the fields of smtp-status instances.
The following bindings are meant to be used along the library
(vicare arguments validation).
Succeed if obj satisfies the predicate smtp-status?; the
second clause also accepts #f.
Next: plain sessions, Previous: plain structs, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Return an exact integer representing the error code for the most recent
libESMTP API call. The returned value represents one the of the
SMTP_ERR_ constants or zero if no error occurred.
Given the return value of a call to errno: return a Scheme string
representing the error description. If an error occurs: return
#f.
Next: plain messages, Previous: plain errors, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Build and return a new instance of type smtp-session. If an
error occurs: return #f.
Finalise the session releasing all the associated resources; return unspecified values. SMTP AUTH and GSASL contexts are automatically unregistered from session.
Run an SMTP protocol session. If successful return #t,
otherwise return #f.
Set local-hostname as local hostname for session; if
successful return #t, else return #f.
The optional local-hostname must be #f or a general C buffer
argument holding an ASCIIZ string; when #f or not given:
NULL is handed to the libESMTP function. (vicare-scheme)Introduction to generalised C strings
Set remote-server as remote server specification for
session; if successful return #t, else return #f.
local-hostname must be a general C buffer argument holding an ASCIIZ string. (vicare-scheme)Introduction to generalised C strings
Set the timeouts for session. If successful return #t, else
return #f.
which must be an exact integer in the range of the C language type
signed int, selecting the timeout to set; the integer must
represent a constant among:
Timeout_GREETING Timeout_ENVELOPE Timeout_DATA Timeout_TRANSFER Timeout_DATA2
the constant can be optionally combined with a bitwise inclusive OR with
the constant Timeout_OVERRIDE_RFC2822_MINIMUM.
value must be an exact integer in the range of the C language type
signed long representing a number of milliseconds.
Register a callback to notify the application about events. If
successful return #t, else return #f.
c-callback must be the return value of a call to
make-smtp-eventcb.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp_eventcb_t callback; the returned pointer must be released
with a call to free-c-callback from (vicare ffi).
user-scheme-callback must accept 2 arguments:
smtp-session referencing the invoking session.
This instance does not own the underlying session.
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns (void) to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Set a callback for tracing the SMTP protocol session. If successful
return #t, otherwise return #f.
c-callback must be the return value of a call to
make-smtp-monitorcb.
headers can be any object: when true the callback is used to display the message headers.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp_monitorcb_t callback; the returned pointer must be released
with a call to free-c-callback from (vicare ffi).
user-scheme-callback must accept 3 arguments:
signed int,
representing the number of characters in the buffer.
SMTP_CB_READING SMTP_CB_WRITING SMTP_CB_HEADERS
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns (void) to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Next: plain recipients, Previous: plain sessions, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Add a new message to session to be delivered to the remote server.
If successful: return a new instance of smtp-message; else return
#f.
For each smtp_message_t in the smtp_session_t referenced
by session: call the c-callback function. Return
unspecified values.
c-callback must be the return value of a call to
make-smtp-enumerate-messagecb.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp_enumerate_messagecb_t callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
user-scheme-callback must accept 1 argument:
smtp-message referencing a message in the invoking
session. This instance is not an object returned by
smtp-add-message.
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns (void) to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Apply scheme-callback to each smtp-message registered in
session; return unspecified values. The order of application is
undefined.
scheme-callback must be a Scheme procedure accepting a single
argument: an instance of smtp-message registered in
session. The smtp-message instances handed to
scheme-callback are the same returned by smtp-add-message.
Set the reverse path mailbox for message; this mailbox is the
sender address. If successful return #t, else return #f.
The optional mailbox must be #f or a general C buffer
argument holding an ASCIIZ string; when #f or not given:
NULL is handed to the libESMTP function. (vicare-scheme)Introduction to generalised C strings
Set the callback to read the message from an application. If successful
return #t, otherwise return #f.
c-callback must be the return value of a call to
make-smtp-messagecb.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp__messagecb_t callback; the returned pointer must be released
with a call to free-c-callback from (vicare ffi).
user-scheme-callback must accept 2 arguments:
void *; to be
used by the callback function for its optional buffer.
NULL or referencing a location of type
signed int; the referenced integer is the number of bytes
available in the message.
user-scheme-callback must return a pointer object representing
NULL of the next byte of the message.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns a pointer object representing NULL to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Select a FILE * from which the message will be read. If
successful return #t, otherwise return #f.
file-pointer must be a pointer to FILE *.
Set the message from a general C buffer. If successful return #t,
otherwise return #f.
string must be a general C buffer argument holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings
Next: plain headers, Previous: plain messages, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Add a new recipient to message to be delivered to the remote
server. If successful: return a new instance of smtp-recipient;
else return #f.
The optional mailbox must be a general C buffer argument holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings
For each smtp_recipient_t in the smtp_message_t referenced
by message: call the c-callback function. If successful
return #t, else return #f.
c-callback must be the return value of a call to
make-smtp-enumerate-recipientcb.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp_enumerate_recipientcb_t callback; the returned pointer must
be released with a call to free-c-callback from (vicare
ffi).
user-scheme-callback must accept 2 arguments:
smtp-recipient referencing a recipient in the
invoking message. This instance is not an object returned by
smtp-add-recipient.
cstring->string from (vicare ffi).
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns (void) to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Apply scheme-callback to each smtp-recipient registered in
message; return unspecified values. The order of application is
undefined.
scheme-callback must be a Scheme procedure accepting a single
argument: an instance of smtp-recipient registered in
message. The smtp-recipient instances handed to
scheme-callback are the same returned by smtp-add-recipient.
Set or unset failing of message delivery if one recipient cannot be
served. If successful return #t, otherwise return #f.
If obj is true: message delivery will fail if at least one
recipient cannot be served; if obj is #f message delivery
will not fail.
Next: plain status, Previous: plain recipients, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Set a header in the message. If successful return #t, else
return #f.
header-name must be a Scheme string representing a header name, without the trailing colon character. Some headers are specially recognised by libESMTP:
DateRequires value1 to be an exact integer in the range of the C
language type signed long; internally this value is converted to
time_t. value2 is ignored.
Message-IdRequires value1 to be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings. value2 is ignored.
FromDisposition-Notification-ToRequire both value1 and value2 to be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings.
ToCcBccReply-ToSenderRequire both value1 and value2 to be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings.
If header-name is not specially recognised by libESMTP, value1 must be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings. value2 is ignored.
Select options for message header processing. If successful return
#t, else return #f.
header-name must be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings.
option must be one of the constants: Hdr_OVERRIDE,
Hdr_PROHIBIT.
Set or unset special processing for headers which have a Resent-
variation. If successful return #t, else return #f.
Next: plain constants, Previous: plain headers, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Return a struct instance of type smtp-status representing the
delivery status for message; if no status informations are
available: return #f.
Return a struct instance of type smtp-status representing the
reverse path status for message; if no status informations are
available: return #f.
Reset the message status to the state it would have before
smtp-start-session is called for the first time on the containing
session. If successful return #t, otherwise return #f.
Return an instance of smtp-status representing the recipient
success/failure status from a previous SMTP session. If no status
informations are available: return #f.
Check whether processing is complete for the specified recipient of the
message. If complete return #t, otherwise return #f.
Reset the recipient status to the state it would have before
smtp-start-session is called for the first time on the containing
session. If successful return #t, otherwise return #f.
Next: plain data, Previous: plain status, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Given an exact integer representing one of the SMTP_EV_
constants, return the corresponding symbol.
Given an exact integer representing one of the SMTP_ERR_
constants, return the corresponding symbol.
Given an exact integer representing one of the Timeout_
constants, return the corresponding symbol.
Given an exact integer representing one of the SMTP_CB_
constants, return the corresponding symbol.
Given an exact integer representing one of the Hdr_ constants,
return the corresponding symbol.
Given an exact integer representing one of the Notify_ constants,
return the corresponding symbol.
Given an exact integer representing one of the E8bitmime_
constants, return the corresponding symbol.
Given an exact integer representing one of the By_ constants,
return the corresponding symbol.
Given an exact integer representing one of the Starttls_
constants, return the corresponding symbol.
Given an exact integer representing one of the Ret_ constants,
return the corresponding symbol.
Given an exact integer representing one of the AUTH_ constants,
return the corresponding symbol.
Given an exact integer representing one of the AUTH_PLUGIN_
constants, return the corresponding symbol.
Next: plain extensions, Previous: plain constants, Up: plain [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Register a pointer object as application data associated to session. Return a pointer object.
Return a pointer object referencing the application data associated to session.
Register a pointer object as application data associated to message. Return a pointer object.
Return a pointer object referencing the application data associated to message.
Register a pointer object as application data associated to recipient. Return a pointer object.
Return a pointer object referencing the application data associated to recipient.
Previous: plain data, Up: plain [Contents][Index]
| • plain extensions auth: | AUTH extension. | |
| • plain extensions starttls: | StartTLS extension. | |
| • plain extensions deliver by: | Deliver By extension. | |
| • plain extensions dsn: | Deliver Status Notification extension. | |
| • plain extensions size: | Size extension. | |
| • plain extensions 8bit: | 8bit-MIME Transport extension. | |
| • plain extensions etrn: | Remote Message Queue Starting (ETRN) extension. |
Next: plain extensions starttls, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Enable or disable SMTP AUTH for session. If successful
return #t, else return #f.
If gsasl-context is #f: AUTH is disabled and the previous
AUTH context, if any, is unregistered from session. Else
gsasl-context must be a pointer object referencing a Gsasl
data structure.
This function is deprecated.
Enable or disable SMTP AUTH for session. If successful
return #t, else return #f.
If auth-context is #f: AUTH is disabled and the previous
AUTH context, if any, is unregistered from session. Else
auth-context must be an instance of auth-context.
Next: plain extensions deliver by, Previous: plain extensions auth, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Enable or disable SMTP STARTTLS for session. If
successful return #t, else return #f.
how must be an exact integer representing one of the
Starttls_ constants.
Register an OpenSSL context in session. If successful return
#t, else return #f.
ssl-context must be a pointer object referencing a foreign data
structure of type SSL_CTX.
Register a single callback function to be used every time a password is
requested for OpenSSL operations. If successful return #t, else
return #f.
c-callback must be NULL or the return value of a call to
make-smtp-starttls-passwordcb. Notice that this callback is
handed to SSL_CTX_set_default_passwd_cb() provided by the OpenSSL
library; (*manpages*)set passwd callback for
encrypted PEM file handling.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp_starttls_passwordcb_t callback; the returned pointer must be
released with a call to free-c-callback from (vicare
ffi).
user-scheme-callback must accept 3 arguments:
signed int,
representing the number of bytes available in the buffer.
#t if the callback is used for reading/decryption,
#f if the callback is used for writing/encryption.
user-scheme-callback must return an exact integer, in the range of
the C language type signed int, representing the actual length of
the password.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns 0 to the caller. user-scheme-callback
should take care of handling its own exceptions.
Next: plain extensions dsn, Previous: plain extensions starttls, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Enable the Deliver By extension for message. If successful return
#t, else return #f.
time must be an exact integer, in the range of the C language type
signed long.
by-mode must be an exact integer representing one of the constants
By_.
trace must be an exact integer, in the range of the C language
type signed int.
Next: plain extensions size, Previous: plain extensions deliver by, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Instruct the reporting MTA whether to include the full content
of the original message in the Delivery Status Notification, or just the
headers. If successful return #t, else return #f.
flags must be an exact integer representing one of the constants
Ret_.
Set the envelope identifier; this value is returned in the DSN
and may be used by the MUA to associate the DSN with
the message that caused it to be generated. If successful return
#t, else return #f.
envelope-identifier must be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings.
Set the DSN notify options. If successful return #t,
else return #f.
flags must be an exact integer represneting the
Notify_NOTSET or Notify_NEVER or the bitwise OR
combination of any of Notify_SUCCESS, Notify_FAILURE and
Notify_DELAY.
Set the DSN ORCPT option. If successful return
#t, else return #f.
address-type and address must be general C buffers holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings.
Next: plain extensions 8bit, Previous: plain extensions dsn, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Set an estimate of the size of the message to be transferred. If
successful return #t, else return #f.
size must be an exact integer, in the range of the C language type
unsigned long, representing the message size.
Next: plain extensions etrn, Previous: plain extensions size, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Specify the body type. If successful return #t, else return
#f.
body must be an exact integer representing one of the constants
E8bitmime_.
Previous: plain extensions 8bit, Up: plain extensions [Contents][Index]
The following bindings are exported by the library (vicare email
libesmtp).
Add an ETRN node to the SMTP session. If successful return an
instance of smtp-etrn-node, else return #f.
node must be a general C buffer holding an ASCIIZ string; (vicare-scheme)Introduction to generalised C strings.
For each smtp_etrn_node_t in the smtp_sesssion_t
referenced by session: call the c-callback function. If
successful return #t, else return #f.
c-callback must be the return value of a call to
make-smtp-etrn-enumerate-nodecb.
Wrap a user supplied Scheme function and return a pointer object
referencing a callback function suitable to be used as
smtp_etrn_enumerate_nodecb_t callback; the returned pointer must
be released with a call to free-c-callback from (vicare
ffi).
user-scheme-callback must accept 3 arguments:
smtp-etrn-node referencing a node. This instance
is not an object returned by smtp-etrn-add-node.
signed int,
representing the option argument.
cstring->string
from (vicare ffi).
user-scheme-callback can return unspecified values.
user-scheme-callback is wrapped in an internally generated Scheme function which does the following:
guard from
(vicare); when an exception is catched: it is discarded and the
callback returns (void) to the caller.
user-scheme-callback should take care of handling its own
exceptions.
Apply scheme-callback to each smtp-etrn-node registered in
session; return unspecified values. The order of application is
undefined.
scheme-callback must be a Scheme procedure accepting a single
argument: an instance of smtp-etrn-node registered in
session. The smtp-etrn-node instances handed to
scheme-callback are the same returned by
smtp-etrn-add-node.
Retrieve the ETRN node success/failure status from a previous SMTP
session. If successful return a smtp-status instance, otherwise
return #f.
Associate a pointer object to an ETRN node structure.
Return the data pointer associated to an ETRN node structure.
Next: Documentation License, Previous: plain, Up: Top [Contents][Index]
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program's name and a brief idea of what it does. Copyright (C) year name of author This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
program Copyright (C) year name of author This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.
Next: references, Previous: Package License, Up: Top [Contents][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Next: concept index, Previous: Documentation License, Up: Top [Contents][Index]
The documentation of Vicare/libESMTP is available online:
the latest version of this package can be downloaded from:
development takes place at:
and as backup at:
the home page of the Vicare project is at:
libESMTP can be found here:
Next: function index, Previous: references, Up: Top [Contents][Index]
| Jump to: | (
A E F L M R S |
|---|
| Jump to: | (
A E F L M R S |
|---|
Next: variable index, Previous: concept index, Up: Top [Contents][Index]
| Jump to: | A F M S V |
|---|
| Jump to: | A F M S V |
|---|
Next: type index, Previous: function index, Up: Top [Contents][Index]
Previous: variable index, Up: Top [Contents][Index]
| Jump to: | A S |
|---|
| Jump to: | A S |
|---|