CreateAndEmailRequestLink Method

Creates a new request link and emails it to the specified emails.

Syntax

QString CreateAndEmailRequestLink(const QString& qsFolderId, const QString& qsemails, const QString& qssubject, const QString& qsnote);

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Link* properties (clearing any previously-held items in the process) with the new request link. After doing so it will also send the emails with the new request link. FolderId is the ID of the directory where the files will be uploaded in ShareFile. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note id added as a note within the body of the email. The CreateLinkOptions* properties can be used to specify the different options for the newly created link.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

  • favorites
  • allshared
  • connectors
  • box
  • top

string FolderId = shareFile.CreateFolder("Incoming Files", "home");
string Link = shareFile.CreateAndEmailRequestLink(FolderId, example@example.com, "ShareFile Request", "");

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Qt Edition - Version 20.0 [Build 8265]