CreateAndEmailLink Method

Creates a link for specified items and emails it.

Syntax

QString CreateAndEmailLink(const QString& qsItemIds, const QString& qsemails, const QString& qssubject, const QString& qsnote);

Remarks

This method will create a new 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 link. After doing so it will also send the emails with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note is added as a note within the body of the email. 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 ItemIds 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

// Creates a folder, places two files into the folder, and creates/emails a link to download the two files. 
string ParentId = shareFile.CreateFolder(name, "home");

shareFile.LocalFile = "./test.txt";
string id1 = shareFile.UploadFile("test.txt", ParentId);

shareFile.LocalFile = "./test_data.zip";
string id2 = shareFile.UploadFile("test_data.zip", ParentId);

string link = shareFile.CreateAndEmailLink(id1 + "," + id2, example@example.com, "ShareFile Download Link", "");

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]