Cloud Mail 2020 Node.js Edition

Questions / Feedback?

AutoDecodeParts Property

Determines whether to automatically decode message parts.

Syntax

 gmail.getAutoDecodeParts([callback])
 gmail.setAutoDecodeParts( autoDecodeParts, [callback])

Default Value

FALSE

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 getAutoDecodeParts([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 setAutoDecodeParts([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 determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received.

Data Type

Boolean

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]