From 5de35dff3a8efece6f911eacb7cb2c7ee028763b Mon Sep 17 00:00:00 2001
From: Maarten <3752035+the-djmaze@users.noreply.github.com>
Date: Sun, 14 Apr 2024 02:01:03 +0200
Subject: [PATCH] Created API (markdown)

---
 API.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 0000000..1245a40
--- /dev/null
+++ b/API.md
@@ -0,0 +1,37 @@
+```php
+<php
+
+$_ENV['SNAPPYMAIL_INCLUDE_AS_API'] = true;
+require_once '/path/to/snappymail_root/index.php';
+// or with specific version
+//require_once '/path/to/snappymail_root/snappymail/v/2.36.1/include.php';
+
+// returns instance of \RainLoop\Actions
+\RainLoop\Api::Actions();
+
+// returns instance of \RainLoop\Config\Application
+\RainLoop\Api::Config();
+
+// returns instance of \SnappyMail\HTTP\CSP
+\RainLoop\Api::getCSP(string $sScriptNonce = null);
+
+// returns instance of \MailSo\Log\Logger
+\RainLoop\Api::Logger();
+
+// returns string or null
+\RainLoop\Api::CreateUserSsoHash(
+	string $sEmail,
+	#[\SensitiveParameter]
+	string $sPassword,
+	array $aAdditionalOptions = array(), bool $bUseTimeout = true
+)
+
+// returns bool
+\RainLoop\Api::ClearUserSsoHash(string $sSsoHash);
+
+// returns bool
+\RainLoop\Api::ClearUserData(string $sEmail);
+
+// returns bool
+\RainLoop\Api::LogoutCurrentLogginedUser();
+```
\ No newline at end of file