[mml upload return_address]

Documentation: Uploading Return Addresses

Syntax

mml upload return_addresses ?-flags? ?-switches? return_address_name

Flags

-only_if_not_found (Optional)

This flag indicates that the document should only be uploaded if an existing return address with the same $return_address_name does not exist.

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.

-title title (Optional)

The title (i.e., Dr., Mr., Mrs., Ms., Miss, etc.) of the return addressee.

-prefix prefix (Optional)

The prefix for the return addressee.

-fullname fullname (Required Alt.)

The full name of the return addressee. This switch must be provided unless -firstname and -lastname are specified instead.

-firstname firstname (Required Alt.)

The first name of the return addressee. This switch must be provided, along with -lastname, unless the -fullname switch is specified instead.

-middlename middlename (Optional)

The middle name of the return addressee. Only valid in combination with -firstname and -lastname.

-lastname lastname (Required Alt.)

The last name of the return addressee. This switch must be provided, along with -firstname, unless the -fullname switch is specified instead.

-suffix suffix (Optional)

The suffix (i.e. Jr., Sr., Esq., III, etc.) of the return addressee.

-company company (Optional)

The company name of the return addressee.

-addressline1 addressline1 (Required)

The first address line of the return address.

-address1 address1 (Synonym)

An alternate syntax for -addressline1.

-addressline2 addressline2 (Optional)

The second adress line of the return address.

-address2 address2 (Synonym)

An alternate syntax for -addressline2.

-urbancode urbancode (Puerto Rico)

This switch is required for return addresses located in Puerto Rico. It is not needed for other locations.

-city city (Required)

The city of the return address.

-state state (Required)

The state (or province) of the return address.

-postcode postcode (Required)

The postal code (Zip Code in the US) of the return address.

-zipcode zipcode (Synonym)

An alternate syntax for -postcode.

-country country (Optional)

The country of the return address. Defaults to the United States if not specified otherwise.

-email email (Optional)

An email address for the return addressee. Though the MOL system currently accepts this field, it does not know how to do anything with it.

Positional Arguments

return_address_name

This is an arbitrary text string used to name the return address. The MOL system requires return_address_name to be unique; however, if a duplicate is used, MOL (appears to) append a counter suffix of sorts.

Return Value

If successful the mailing_list_id assigned by the MOL system is returned. This is an opaque value used to identify the return_address in subsequent actions (i.e., return_address details, delete return_address, and upload order).

An error will be returned if the return address upload was not succesful. Possible causes under which an error could be raised include: transient network outages, MOL processor internal errors, failure to specify the minimum required portions of a return address, etc.