(Perl) SharePoint -- Recycle File (Move File to Recycle Bin)

Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

#  This requires the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

#  If SharePoint Windows classic authentication is used, then set the
#  Login, Password, LoginDomain, and NtlmAuth properties.
$http->put_Login("SHAREPOINT_USERNAME");
$http->put_Password("SHAREPOINT_PASSWORD");
$http->put_LoginDomain("SHAREPOINT_NTLM_DOMAIN");
$http->put_NtlmAuth(1);

#  The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
#  If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
#  establish the cookie as shown at SharePoint Online Authentication

$req = chilkat::CkHttpRequest->new();
$req->put_HttpVerb("POST");
$req->put_Path("/_api/web/GetFileByServerRelativeUrl('/ChilkatDocLibrary/sample.docx')/recycle");

#  We must add a form digest value in the X-RequestDigest header field.
#  See this example for details on
#  how to get (and cache) a form digest value
$req->AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST");

#  Send the request to move the file to the recycle bin.
$bUseTls = 1;
# resp is a HttpResponse
$resp = $http->SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,$bUseTls,$req);
if ($http->get_LastMethodSuccess() != 1) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$xml = chilkat::CkXml->new();
$xml->LoadXml($resp->bodyStr());

#  A successful response will return the 200 status code.
if ($resp->get_StatusCode() != 200) {
    print "Response status code = " . $resp->get_StatusCode() . "\r\n";
    print $xml->getXml() . "\r\n";
    print "Failed" . "\r\n";

    exit;
}

#  Show the XML response.
print $xml->getXml() . "\r\n";

#  The GUID (identifier) of the item in the recycle bin is just the content
#  of the single-node XML that is returned:
$guid = $xml->content();
print "GUID of recycle item = " . $guid . "\r\n";

print "Success." . "\r\n";

#  A successful XML response looks like this:

#  <?xml version="1.0" encoding="utf-8" ?>
#  <d:Recycle xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
#   xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
#   xmlns:georss="http://www.georss.org/georss"
#   xmlns:gml="http://www.opengis.net/gml"
#   m:type="Edm.Guid">
#      63b9924d-e9c1-4d7b-b1c2-e921ad85aa1c
#  </d:Recycle>