InputFile Property

The file to process.

Syntax

 smime.getInputFile([callback])
 smime.setInputFile( inputFile, [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 getInputFile([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 setInputFile([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

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Encrypt and/or Sign

When encrypting or signing this may be set to a file containing content that will be encrypted and/or signed.

Decrypt and/or Verify

When decrypting or verifying a signature this may be set to a file containing the fully encoded S/MIME message.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

InputFile
InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.

Data Type

String