[mml document details]

Documentation: Document Details

Syntax

mml document details ?-flags? ?-switches? document_id ?attributes?

Flags

-flush (Optional)

Ignores any cached-data from a previous lookup and fetches the information from the MOL system again.

-nocomplain (Optional)

If specified, and attributes are listed by name, an error will not be thrown if a given attribute is not in the attributes returned by the MOL system.

Switches

-debug filename (Optional)

If specified, the XML generated and sent to the MOL system, as well as the XML reply from the MOL system, will be appended to filename.

Positional Arguments

document_id

The opaque identifier assigned to the document by the MOL system. This value is initially obtained from upload document, and is later available from list documents.

?arguments | argument ...? (Optional)

The list of attribute(s) to return details about.

Return Value

If a specific list of attribute(s) is not specified then all attributes will be returned as a list of key/value pairs, suitable for use with the Tcl [array set] command.

If one attribute is specified it's value is returned.

If multiple attributes are specified their values are returned as a Tcl list in the same order they were given. Multiple attributes can either be given as separate arguments or as a list of arguments. That is, either as [mml document details $document_id foo bar baz] or as [mml document details $document_id details $attributes] where $attributes is a Tcl list containing {foo bar baz}.

An error will be returned if the document details cannot be retrieved. Possible causes under which an error could be raised include: transient network outages, MOL processor internal errors, referencing a deleted or invalid document_id, specifying invalid attributes (without the -nocomplain flag), etc.

Notes

For a list of specific attributes, consult the Mail Management Language Definition.