Documentation: Overview
[ Home | Docs | FAQ | Download | CVS | Mailing Lists | Bug Tracker | USPS's MOL Site ]
package require TclMML
mml::connect -url url username password
The TclMML package implements one public command,
mml::connect
. This command is used to create
an instance connection to either the staging or production
MOL server (depending on the value given to the -url
switch). Consult the MML documentation
for the current URL(s).
The mml::connect
command creates a new command
(similar to how Tk widgets do). A specific command_name
can be specified. Otherwise, a command is created within the
mml
namespace, and the name of this command is returned.
For example:
mml::connect -url https://... mml username password
set mml [mml::connect https://... username password]
Which style you use is mostly a matter of taste. For the
rest of our examples we'll assume the former syntax (where
the command_name is specified) is used (with a value of
mml for the command_name
).
There are four main nouns & four main verbs, along with a couple of minor ones. The four main nouns are:
The four main verbs are:
Besides the principal nouns & verbs there are a few minor ones:
Our newly created mml
command takes a number of combinations
of verbs and nouns, and usually some additional
-switches & -flags, and sometimes one or more
positional parameters. We'll call these combinations of
verbs and nouns "actions".
Actions can be specified as either verb noun or noun verb. Use whichever seems most natural to you. For example:
mml list documents
mml documents list
|
mml upload document
mml upload mailing_list
mml upload return_address
mml upload order
mml list documents
mml list mailing_lists
mml list return_addresses
mml list orders
mml document details
mml mailing_list details
mml return_address details
mml order details
mml delete document
mml delete mailing_list
mml delete return_address
mml retrieve defaults
mml retrieve handle
mml retrieve content
mml retrieve errorInfo
mml retrieve url
mml map mailing_list
mml commit mailing_list
mml configure defaults
mml configure
billing_address