Skip to content

Syncplify.me Server v8

Main Navigation www.syncplify.com

Appearance

Sidebar Navigation

Manual & Docs

READ THIS FIRST

General concepts

BREAKING CHANGES

Glossary

Single Sign On (OIDC)

High Availability (HA)

Passkeys (WebAuthn)

Keeping the server current

The SSH Shell subsystem

Command line reference

Importing users and migrating from other servers

Protected files on a node

Running the services under dedicated accounts

The SyngoDB service

Logical structure

Log levels

Shield, safe list, allow list

Variables (parametric stuff)

Installation and Setup

System requirements

Download the installer

Install on Windows

Install on Linux

Deploy with Docker

HA Cluster Setup

First-run Setup Wizard

Choosing the setup type

Choosing the node ID

Creating the first SuperAdmin account

Two-factor authentication

Completing the setup

Joining a high-availability cluster

Administration (Web UI)

SuperAdmin UI

Signing in

Dashboard

Virtual Sites

Editing a virtual site

SuperAdmins

Cluster

Global Configuration

Shield

Certificates

Backup & Restore

Updates

License

Settings

Notifications

Admin UI

Signing in

Dashboard

Storage

Virtual File Systems

R2FS!

Quotas

Shared objects

Access & Identity

Users

LDAP / OIDC

Shield

Access enforcement

Protocol Handlers

SFTP / SSH

FTP (E/S)

HTTPS / WebClient!

Automation

Scripts

Event Handlers

Secrets

System

SMTP

Logging

Speed limits

Connections & Sessions

Certificates & Keys

Reporting

Notifications

Settings

Administration (REST API)

OpenAPI definitions

Scripting/Event-Handling

Event-Handlers

Shield events

VS Code Extension and MCP Servers

Server!-specific SyncJS

Helper functions

Exit()

GetCurrentVFS()

EventHandler()

ScriptID()

ScriptName()

HandlerPriority()

CtxRelPath()

CtxRelTargetPath()

CtxVFSName()

CtxUsername()

CtxVirtualSite()

ExecutionTimeout()

EventCtx()

ExecutionTimeLeft()

MakeTOTP()

ValidateTOTP()

Terminate (disconnect the session)

The "Session" object

GetID()

GetUser()

GetUserID()

GetVirtualSite()

GetRemoteAddress()

GetClientVersion()

GetProtocol()

GetStartTime()

GetLastActivity()

BlockOperation()

AddCustomData()

GetCustomData()

GetAllCustomData()

AddQuestion()

AddQuestionPassword()

AddQuestionTOTP()

AuthenticateUserFromScript()

GetAbsPath()

GetAbsTargetPath()

GetRelPath()

GetRelTargetPath()

RemoveFromDirList()

GetLastCommand / GetLastCommandWithParm

GetLastCommandTime()

GetLastError()

GetLastErrorTime()

The "User" object

GetID()

The "VFS" object

Response types

VFS Constructors

GetCurrentVFS()

Stat() and Lstat()

ReadDir()

Mkdir()

MkdirAll()

Rmdir()

Rename()

Remove()

RemoveAll()

TreeSize()

Symlink()

Chown()

Chmod()

Chtimes()

Truncate()

ReadFileAsText()

ReadFileAsHex()

ReadFileAsBytes()

WriteFileAsText()

WriteFileAsHex()

WriteFileAsBytes()

ImportFile()

ExportFile()

CopyToVFS()

MoveToVFS()

The SyncJS language

SyncJS types

Directory list items

Global constants

Local file-system functions

ListDir (list a directory)

ListDirR (recursive ListDir)

CopyFile (copy a file)

MoveFile (move/rename a file)

DelFile (delete a file)

SecureErase (secure file deletion)

MakeDir (create a directory)

DelDir (delete an empty directory)

DelTree (delete directory-tree)

ReadTextFile (read a text file)

ReadFileAsHex (read file bytes)

Write text to file (2 ways)

Zip (compress files)

Unzip (extract an archive)

FileType (identify MIME-type)

StatFileSystemObject (file/dir)

FileExists (check for file)

HashFile (file hashing)

DirExists (check for directory)

GetTempFileName (temp file path)

Chown (change file owner)

FileAgeSecs (file age in seconds)

FileSizeOf (file size)

WaitForFile (wait until a file appears)

SplitFileByLines (split text file into chunks)

SplitFileBySize (split file into fixed-size chunks)

GzipFile / GunzipFile (gzip compression)

Web (HTTP/HTTPS) functions

Configuration methods

HTTP(S) verbs

HttpRes response object

SQL database functions

Supported database servers

Configuring SqlCli

Connecting to a DB server

Querying a dataset

Insert/Update/Delete

AMQP message queue protocol

AMQP object properties

Connecting to an AMQP queue

Monitoring a queue

Processing messages

Posting messages to a queue

Cloud and integration functions

Send to Slack (webhook)

SendToTeamsWebHook (Microsoft Teams)

Send SMS via Twilio

Messaging functions

SendMail (sending emails)

NotifyViaTelegramBot

Process management

Run (execute a process)

RunAsync (async execution)

RunCapture (run and capture output)

Encoding, hashing, and data functions

Base64Encode / Base64Decode

HashString (hash a string)

HmacSign / HmacVerify (HMAC signatures)

ParseCSV / FormatCSV (CSV data)

ParseXML (parse XML data)

TcpConnect (TCP connectivity check)

Image processing

JPEGResample (resize a JPG)

PNGResample (resize a PNG)

JPEGMetadata (extract EXIF)

PNGMetadata (PNG info)

Remote client objects

Client constructors and connection fields

Configure() — URL + payload setup

ClientOptions (transfer settings)

Operations reference

Security/encryption functions

GetSecret

Generate a PGP key-pair

PGP encrypt file

PGP decrypt file

PGPSignFile (create a detached signature)

PGPVerifyFile (verify a detached signature)

Miscellaneous functions

Log (custom log line)

Sleep (pause execution)

Extract file path

Extract file name

Extract file extension

Num-to-string (padded)

Unique IDs (UUID)

ToDate()

FormatDateTime (date/time formatting)

Exit (stop script execution)

ScriptID / ScriptName (script identity)

ExecutionTimeout / ExecutionTimeLeft

More (cool) stuff

Requiring a Node.js module

The "underscore.js" library

WebClient

Signing in

The file manager

Sharing

Managing your shares

Shared links

Settings

On this page

Messaging functions

This section documents the SyncJS functions used to send emails and communicate or exchange messages with third-party services.

Last updated:

Pager

Previous pageSend SMS via Twilio

Next pageSendMail (sending emails)