• Publicity: Public Only All

tcllib-doc-procs.tcl

API-browser documentation for Tcllib commands used by OpenACS. Only already-provided packages and existing commands are documented. Documentation-only ad_proc declarations do not replace implementations. Declarations stay in this source file, not in interpreter-blueprint data.

Location:
packages/acs-tcl/tcl/tcllib-doc-procs.tcl

Procedures in this file

Detailed information

base64::decode (public)

 base64::decode string

Decode standard Base64 text using Tcllib. Acceptance of malformed input depends on the loaded package version and implementation.

Parameters:
string (required)
Base64-encoded input.
Returns:
Decoded binary data.
See Also:

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

base64::encode (public)

 base64::encode [ args... ]

Encode binary data as standard Base64 using Tcllib.

Returns:
Base64-encoded text.
See Also:

Partial Call Graph (max 5 caller/called nodes):
util_http_file_upload util_http_file_upload (public, deprecated) base64::encode base64::encode util_http_file_upload->base64::encode base64::ADD base64::ADD (private) base64::encode->base64::ADD

Testcases:
No testcase defined.

mime::buildmessage (public)

 mime::buildmessage token

Serialize a Tcllib MIME token, including its headers and body. This command is documented by Tcllib even though some versions do not export it from the mime namespace.

Parameters:
token (required)
MIME token to serialize.
Returns:
The complete MIME message.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::maildir_email_parse acs_mail_lite::maildir_email_parse (private) mime::buildmessage mime::buildmessage acs_mail_lite::maildir_email_parse->mime::buildmessage acs_mail_lite::send_immediately acs_mail_lite::send_immediately (private) acs_mail_lite::send_immediately->mime::buildmessage ad_build_mime_message ad_build_mime_message (public) ad_build_mime_message->mime::buildmessage mime::buildmessageaux mime::buildmessageaux (private) mime::buildmessageaux->mime::buildmessage

Testcases:
No testcase defined.

mime::finalize (public)

 mime::finalize token [ args... ]

Release a Tcllib MIME token and its associated resources.

Parameters:
token (required)
MIME token to release.
Returns:
The empty string.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::parse_email acs_mail_lite::parse_email (private) mime::finalize mime::finalize acs_mail_lite::parse_email->mime::finalize acs_mail_lite::send_immediately acs_mail_lite::send_immediately (private) acs_mail_lite::send_immediately->mime::finalize ad_parse_incoming_email ad_parse_incoming_email (public) ad_parse_incoming_email->mime::finalize mime::initialize mime::initialize (public) mime::initialize->mime::finalize

Testcases:
No testcase defined.

mime::getbody (public)

 mime::getbody token [ args... ]

Read the body of a Tcllib MIME token. The -decode option requests transfer decoding; -command enables callback-based delivery.

Parameters:
token (required)
MIME token to read.
Returns:
The body, or the final callback result when -command is used.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::maildir_email_parse acs_mail_lite::maildir_email_parse (private) mime::getbody mime::getbody acs_mail_lite::maildir_email_parse->mime::getbody acs_mail_lite::parse_email acs_mail_lite::parse_email (private) acs_mail_lite::parse_email->mime::getbody ad_parse_incoming_email ad_parse_incoming_email (public) ad_parse_incoming_email->mime::getbody mime::base64 mime::base64 (private) mime::getbody->mime::base64 mime::getproperty mime::getproperty (public) mime::getbody->mime::getproperty mime::quoted-printable mime::quoted-printable (private) mime::getbody->mime::quoted-printable mime::reversemapencoding mime::reversemapencoding (public) mime::getbody->mime::reversemapencoding

Testcases:
No testcase defined.

mime::getheader (public)

 mime::getheader token [ key ]

Read headers of a Tcllib MIME token. Repeated headers can have multiple values.

Parameters:
token (required)
MIME token to inspect.
key (optional)
Header name, -names for header names, or empty for all headers.
Returns:
Matching header values, header names, or header name/value pairs.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::maildir_email_parse acs_mail_lite::maildir_email_parse (private) mime::getheader mime::getheader acs_mail_lite::maildir_email_parse->mime::getheader acs_mail_lite::parse_email acs_mail_lite::parse_email (private) acs_mail_lite::parse_email->mime::getheader

Testcases:
No testcase defined.

mime::getproperty (public)

 mime::getproperty token [ property ]

Read properties of a Tcllib MIME token, such as content, encoding, params, parts and size.

Parameters:
token (required)
MIME token to inspect.
property (optional)
Property name, -names for property names, or empty for all properties.
Returns:
The property value, property names, or property name/value pairs.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::maildir_email_parse acs_mail_lite::maildir_email_parse (private) mime::getproperty mime::getproperty acs_mail_lite::maildir_email_parse->mime::getproperty acs_mail_lite::parse_email acs_mail_lite::parse_email (private) acs_mail_lite::parse_email->mime::getproperty ad_parse_incoming_email ad_parse_incoming_email (public) ad_parse_incoming_email->mime::getproperty mime::getbody mime::getbody (public) mime::getbody->mime::getproperty mime::getsize mime::getsize (private) mime::getproperty->mime::getsize

Testcases:
No testcase defined.

mime::initialize (public)

 mime::initialize [ args... ]

Create a Tcllib MIME token by parsing a message or constructing a part.

Returns:
A MIME token; release it with mime::finalize when finished.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::maildir_email_parse acs_mail_lite::maildir_email_parse (private) mime::initialize mime::initialize acs_mail_lite::maildir_email_parse->mime::initialize acs_mail_lite::parse_email acs_mail_lite::parse_email (private) acs_mail_lite::parse_email->mime::initialize acs_mail_lite::send_immediately acs_mail_lite::send_immediately (private) acs_mail_lite::send_immediately->mime::initialize acs_mail_lite::utils::build_body acs_mail_lite::utils::build_body (private) acs_mail_lite::utils::build_body->mime::initialize ad_build_mime_message ad_build_mime_message (public) ad_build_mime_message->mime::initialize mime::finalize mime::finalize (public) mime::initialize->mime::finalize mime::initializeaux mime::initializeaux (private) mime::initialize->mime::initializeaux

Testcases:
No testcase defined.

mime::parseaddress (public)

 mime::parseaddress string

Parse an email address list using Tcllib's MIME address parser.

Parameters:
string (required)
Address list to parse.
Returns:
A list of address records represented as name/value lists.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::encode_email_address acs_mail_lite::encode_email_address (private) mime::parseaddress mime::parseaddress acs_mail_lite::encode_email_address->mime::parseaddress mime::parseaddressaux mime::parseaddressaux (private) mime::parseaddress->mime::parseaddressaux

Testcases:
No testcase defined.

mime::parsedatetime (public)

 mime::parsedatetime value property

Extract a property from an email date-time value using Tcllib.

Parameters:
value (required)
Email date-time string, or -now for the current time.
property (required)
Requested property, such as clock, proper, year, mon or zone.
Returns:
The requested date-time property.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::maildir_email_parse acs_mail_lite::maildir_email_parse (private) mime::parsedatetime mime::parsedatetime acs_mail_lite::maildir_email_parse->mime::parsedatetime acs_mail_lite::utils::build_date acs_mail_lite::utils::build_date (private) acs_mail_lite::utils::build_date->mime::parsedatetime

Testcases:
No testcase defined.

mime::reversemapencoding (public)

 mime::reversemapencoding mimeType

Map a MIME charset name to the corresponding Tcl encoding name using Tcllib's case-insensitive mapping table.

Parameters:
mimeType (required)
MIME charset name.
Returns:
The Tcl encoding name, or the empty string if no mapping is known.
See Also:

Partial Call Graph (max 5 caller/called nodes):
mime::getbody mime::getbody (public) mime::reversemapencoding mime::reversemapencoding mime::getbody->mime::reversemapencoding

Testcases:
No testcase defined.

mime::setheader (public)

 mime::setheader token key value [ args... ]

Change a header of a Tcllib MIME token, subject to its restrictions on MIME-managed headers.

Parameters:
token (required)
MIME token to modify.
key (required)
Header name.
value (required)
Header value.
Returns:
Previous values associated with the header.
See Also:

Partial Call Graph (max 5 caller/called nodes):
acs_mail_lite::send_immediately acs_mail_lite::send_immediately (private) mime::setheader mime::setheader acs_mail_lite::send_immediately->mime::setheader

Testcases:
No testcase defined.

mime::uniqueID (public)

 mime::uniqueID

Generate a MIME Content-ID using Tcllib's process ID, clock, hostname and counter. This is not a cryptographic random identifier.

Returns:
An identifier enclosed in angle brackets.
See Also:

Partial Call Graph (max 5 caller/called nodes):
test_acs_mail_lite_inbound_procs_check acs_mail_lite_inbound_procs_check (test acs-mail-lite) mime::uniqueID mime::uniqueID test_acs_mail_lite_inbound_procs_check->mime::uniqueID acs_mail_lite::unique_id_create acs_mail_lite::unique_id_create (private) acs_mail_lite::unique_id_create->mime::uniqueID mime::initializeaux mime::initializeaux (private) mime::initializeaux->mime::uniqueID

Testcases:
acs_mail_lite_inbound_procs_check

uri::join (public)

 uri::join [ args... ]

Construct a URI from Tcllib component name/value pairs. Accepted components and normalization depend on the selected scheme.

Returns:
The constructed URI.
See Also:

Partial Call Graph (max 5 caller/called nodes):
Class ::xo::oauth::Signature Class ::xo::oauth::Signature (public) uri::join uri::join Class ::xo::oauth::Signature->uri::join xo::oauth::Signature proc base_string_from_url xo::oauth::Signature proc base_string_from_url (public) xo::oauth::Signature proc base_string_from_url->uri::join

Testcases:
No testcase defined.

uri::split (public)

 uri::split url [ defaultscheme ]

Split a URI into scheme-dependent component name/value pairs using Tcllib. The result is suitable for array set or dict operations. Parsing follows the package's configured URI quirk options.

Parameters:
url (required)
URI to parse.
defaultscheme (optional, defaults to "http")
Scheme used when the URI has no scheme; defaults to http.
Returns:
Component names and values, including the scheme.
See Also:

Partial Call Graph (max 5 caller/called nodes):
Class ::xo::oauth::Signature Class ::xo::oauth::Signature (public) uri::split uri::split Class ::xo::oauth::Signature->uri::split packages/xooauth/www/admin/lti-test.tcl packages/xooauth/ www/admin/lti-test.tcl packages/xooauth/www/admin/lti-test.tcl->uri::split xo::oauth::Signature proc base_string_from_url xo::oauth::Signature proc base_string_from_url (public) xo::oauth::Signature proc base_string_from_url->uri::split

Testcases:
No testcase defined.
[ show source ]