suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documented byte-string extensions

Browse Source 
svn: r3909
This commit is contained in:
John Clements 2006-07-31 14:49:23 +00:00
parent ecd96a68ae
commit 48334f51be
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
collects/net/doc.txt
View File

@ -1265,6 +1265,12 @@ TYPES ----------------------------------------------------------------
(the first one terminates the last field, and the second terminates (the first one terminates the last field, and the second terminates
the header). the header).
OR
A byte-string that is an RFC-822-compliant header. Format is as
prior paragraph. Only specifically noted functions below
work with byte-string headers.
PROCEDURES ----------------------------------------------------------- PROCEDURES -----------------------------------------------------------
> empty-header > empty-header
@ -1277,6 +1283,8 @@ PROCEDURES -----------------------------------------------------------
If the format of `candidate-header-string' matches RFC 822, void is If the format of `candidate-header-string' matches RFC 822, void is
returned, otherwise an exception is raised. returned, otherwise an exception is raised.
This function works when called with a byte-string.
> (extract-field field-string header) -> string or #f > (extract-field field-string header) -> string or #f
Returns the header content for the specified field, or #f if the Returns the header content for the specified field, or #f if the
@ -1290,12 +1298,18 @@ PROCEDURES -----------------------------------------------------------
(extract-field "TO" (insert-field "to" "me@localhost" empty-header)) (extract-field "TO" (insert-field "to" "me@localhost" empty-header))
; => "me@localhost" ; => "me@localhost"
This function works when called with byte-strings for both field-string
and header.
> (extract-all-fields header) -> (list (cons string string)) > (extract-all-fields header) -> (list (cons string string))
Returns an association-list version of the header; the case of the Returns an association-list version of the header; the case of the
field names is preserved, as well as the order and duplicate uses of field names is preserved, as well as the order and duplicate uses of
a field name. a field name.
This function works with a byte-string header. In this case, it returns
a value of the form (list (cons bytes bytes)).
> (remove-field field-string header) -> header > (remove-field field-string header) -> header
Creates a new header by removing the specified field from `header' Creates a new header by removing the specified field from `header'
@ -1303,6 +1317,9 @@ PROCEDURES -----------------------------------------------------------
times). If the field is not in `header', then the return value is times). If the field is not in `header', then the return value is
`header'. `header'.
This function works when called with byte-strings for both
field-string and header
> (insert-field field-string value-string header) -> header > (insert-field field-string value-string header) -> header
Creates a new header by prefixing the given header with the given Creates a new header by prefixing the given header with the given
@ -1310,13 +1327,19 @@ PROCEDURES -----------------------------------------------------------
CRLF, but a multi-line value (perhaps created with CRLF, but a multi-line value (perhaps created with
`data-lines->data') may contain separator CRLFs. `data-lines->data') may contain separator CRLFs.
This function works when all arguments are byte-strings.
> (replace-field field-string value-string header) -> header > (replace-field field-string value-string header) -> header
Replaces or inserts the given field. If value-string is #f, then Replaces or inserts the given field. If value-string is #f, then
the field is simply removed. the field is simply removed.
This function works when all arguments are byte-strings.
> (append-headers a-header another-header) -> header > (append-headers a-header another-header) -> header
This function works when both arguments are byte-strings.
> (standard-message-header from-string to-list-of-strings cc-list-of-strings bcc-list-of-strings subject-string) -> header > (standard-message-header from-string to-list-of-strings cc-list-of-strings bcc-list-of-strings subject-string) -> header
Creates a standard mail header given the sender, various lists of Creates a standard mail header given the sender, various lists of