Boundary Property

The boundary separating the MIME parts. Maximum length of 80 bytes.

Syntax

 mime.getBoundary([callback])
 mime.setBoundary( boundary, [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 getBoundary([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 setBoundary([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 contains the boundary separating the MIME parts and has a maximum length of 80 bytes. The class will automatically generate a random boundary value during encoding if no value is given. During decoding this property is filled with the boundary from the actual MIME message.

The class will truncate any string longer than 80 bytes if assigned to Boundary.

Data Type

String