ReturnURL Property

The URL where the user (browser) returns after authenticating.

Syntax

ANSI (Cross Platform)
char* GetReturnURL();
int SetReturnURL(const char* lpszReturnURL);

Unicode (Windows)
LPWSTR GetReturnURL();
INT SetReturnURL(LPCWSTR lpszReturnURL);
@property (nonatomic,readwrite,assign,getter=returnURL,setter=setReturnURL:) NSString* returnURL;
- (NSString*)returnURL;
- (void)setReturnURL:(NSString*)newReturnURL;

#define PID_OAUTH_RETURNURL 37

CLOUDMAIL_EXTERNAL void* CLOUDMAIL_CALL CloudMail_OAuth_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CLOUDMAIL_EXTERNAL int CLOUDMAIL_CALL CloudMail_OAuth_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

When ClientProfile is set to cfApplication this will be automatically set to the address of the local embedded web server. In that case this property can be inspected to determine the URL where the user will be redirected, but does not need to be set.

When calling GetAuthorizationURL, which is common when ClientProfile is set to cfWebBrowser, set this property to the URL on your server where the user will be redirected after authenticating with the authorization server.

This property corresponds to the redirect_uri query string parameter.

Data Type

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