Cloud Mail 2020 Node.js Edition

Questions / Feedback?

Authorization Property

An OAuth Authorization String.

Syntax

 office365.getAuthorization([callback])
 office365.setAuthorization( authorization, [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 getAuthorization([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 setAuthorization([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 is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

Example


Oauth oauth = new Oauth();

oauth.ClientId = "YourClientId";  
oauth.ClientSecret = "YourClientSecret";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;

office365.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

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