CustomsFormFile Property

Filename where the customs form required to mail to destination country can be saved to (optional).

Syntax

 uspsshipintl.getCustomsFormFile([callback])
 uspsshipintl.setCustomsFormFile( customsFormFile, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCustomsFormFile([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCustomsFormFile([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

When this property is set to a valid path and filename, and the GetFormCN22 method is called, the returned image is written to disk.

However, if GetFormCP72 is called, each page of the form (from index 1 to 5) is written to it's own file, using the following format:

If CustomsFormFile equals "path\filename.ext", then each page will be saved to "path\filename.pageN.ext" where "N" is "1" to "5".

For example, if CustomsFormFile is set to "C:\labels\cp72.pdf", the following files will be saved:

The file extension should correspond to the format defined by the value of LabelImageType property.

Data Type

String