General Documentation
Welcome to the general documentation for the Madmail server.
Introduction to Madmail
Madmail is a powerful email application built on top of the Maddy project.
It runs as a single Go (Golang) binary and its main goal is to create
a secure and fast communication platform.
DeltaChat Messenger Integration
The most important feature of Madmail is that it creates an End-to-End Encrypted
chat server for you.
You can use this service with the popular DeltaChat application and
enjoy a modern messenger experience on a completely private and decentralized platform.
Simple and Instant Registration (JIT)
One of the smart features of Madmail is support for instant registration,
or Just-In-Time Registration.
This means you don't need to go through lengthy registration steps; upon the first login attempt
with new credentials, your account is automatically created if this feature is enabled. You can also use
the registration button on the main page to quickly get a QR Code with your settings.
Voice and Video Calls (TURN)
One of the standout features of this server is having a dedicated TURN service to improve
call quality in DeltaChat.
This service acts as a relay so that if two users cannot connect directly (P2P),
the call is routed through the server with high stability.
Storage Quota
To ensure fair resource distribution, the server enforces storage limits. You can
view your usage and quota through any email client that supports the QUOTA extension.
Server Management (Admin API)
Since version v0.15.3, a control API (Admin API) is embedded within the server
that allows easy server management.
The Admin API path and the admin token are configurable and can be set
statically in the server configuration file.
To get the default token for authentication, run the command maddy admin-token on your server.
In addition to this API, the Web Admin project has been developed for graphical server management.
The source code is available at github.com/themadorg/madmail-admin-web and is automatically
built and deployed at
https://admin.madmail.chat/.
Visit this link and enter your server address and token to easily manage your server.
Security Recommendations
Message Security: This service is very secure by default. To ensure communication
privacy in DeltaChat, note that the presence of a grey icon next to
messages means encryption is disabled; therefore, sensitive messages should not have this indicator.
Updates: To maintain security and benefit from the latest features, always keep your
DeltaChat application updated to the latest version.
Support
For support, please contact your server administrator.
Ù
Ø³ØªÙØ¯Ø§Øª عÙ
ÙÙ
Û
ب٠بخش Ù
Ø³ØªÙØ¯Ø§Øª عÙ
ÙÙ
Û Ø³Ø±ÙØ± Madmail Ø®ÙØ´ Ø¢Ù
Ø¯ÛØ¯.
Ù
عرÙÛ Ø³Ø±ÙÛØ³ Madmail
سرÙÛØ³ Madmail ÛÚ© اپÙÛÚ©ÛØ´Ù اÛÙ
ÛÙ ÙØ¯Ø±ØªÙ
ÙØ¯ است ک٠بر پاÛ٠پرÙÚÙ Maddy ØªÙØ³Ø¹Ù ÛØ§Ùت٠است.
اÛ٠سرÙÛØ³ Ø¨Ù ØµÙØ±Øª ÛÚ© باÛÙØ±Û زبا٠Go (Golang) اجرا Ù
ÛâØ´ÙØ¯ Ù ÙØ¯Ù اصÙÛ Ø¢Ù Ø§ÛØ¬Ø§Ø¯
ÛÚ© بستر Ø§Ø±ØªØ¨Ø§Ø·Û Ø§Ù
Ù Ù Ø³Ø±ÛØ¹ است.
Ù¾ÛØ§Ù
âØ±Ø³Ø§Ù Ù
تص٠ب٠DeltaChat
Ù
ÙÙ
âØªØ±ÛÙ ÙÛÚÚ¯Û Madmail اÛ٠است Ú©Ù ÛÚ© Ø³Ø±ÙØ± ÚØª End-to-End Encrypted (رÙ
زÙگارÛ
شد٠از Ù
بدا تا Ù
ÙØµØ¯) Ø¨Ø±Ø§Û Ø´Ù
ا Ø§ÛØ¬Ø§Ø¯ Ù
ÛâÚ©ÙØ¯.
Ø´Ù
ا Ù
ÛâØªÙØ§ÙÛØ¯ از اÛ٠سرÙÛØ³ در اپÙÛÚ©ÛØ´Ù Ù
ØØ¨Ùب DeltaChat Ø§Ø³ØªÙØ§Ø¯Ù Ú©ÙÛØ¯ Ù
تجربÙâØ§Û Ù
Ø´Ø§Ø¨Ù Ù¾ÛØ§Ù
âØ±Ø³Ø§ÙâÙØ§Û Ù
در٠اÙ
ا در Ø¨Ø³ØªØ±Û Ú©Ø§Ù
ÙØ§Ù Ø®ØµÙØµÛ Ù ØºÛØ±Ù
تÙ
رکز Ø¯Ø§Ø´ØªÙ Ø¨Ø§Ø´ÛØ¯.
ثبتâÙØ§Ù
ساد٠٠آÙÛ (JIT)
ÛÚ©Û Ø§Ø² ÙØ§Ø¨ÙÛØªâÙØ§Û ÙÙØ´Ù
ÙØ¯ MadmailØ Ù¾Ø´ØªÛØ¨Ø§ÙÛ Ø§Ø² ثبتâÙØ§Ù
Ø¢ÙÛ ÛØ§ Just-In-Time Registration است.
اÛ٠ب٠اÛÙ Ù
Ø¹ÙØ§Ø³Øª Ú©Ù Ø´Ù
ا ÙÛØ§Ø²Û Ø¨Ù Ø·Û Ú©Ø±Ø¯Ù Ù
راØÙ Ø·ÙÙØ§ÙÛ Ø«Ø¨ØªâÙØ§Ù
ÙØ¯Ø§Ø±ÛØ¯Ø Ø¨Ù Ù
ØØ¶ اÙÙÛÙ ØªÙØ§Ø´ Ø¨Ø±Ø§Û ÙØ±Ùد با ÛÚ©
Ù
شخصات Ø¬Ø¯ÛØ¯Ø ØØ³Ø§Ø¨ Ø´Ù
ا در ØµÙØ±Øª ÙØ¹Ø§Ù Ø¨ÙØ¯Ù اÛÙ ÙØ§Ø¨ÙÛØª Ø¨Ù ØµÙØ±Øª Ø®ÙØ¯Ú©Ø§Ø± ساخت٠Ù
ÛâØ´ÙØ¯. ÙÙ
ÚÙÛÙ Ù
ÛâØªÙØ§ÙÛØ¯ از دکÙ
Ù
ثبتâÙØ§Ù
در ØµÙØÙ Ø§ØµÙÛ Ø¨Ø±Ø§Û Ø¯Ø±ÛØ§Ùت Ø³Ø±ÛØ¹ QR Code ØªÙØ¸ÛÙ
ات Ø§Ø³ØªÙØ§Ø¯Ù Ú©ÙÛØ¯.
تÙ
اسâÙØ§Û ØµÙØªÛ ٠تصÙÛØ±Û (TURN)
ÛÚ©Û Ø§Ø² ÙÛÚÚ¯ÛâÙØ§Û برجست٠اÛÙ Ø³Ø±ÙØ±Ø داشت٠سرÙÛØ³ TURN Ø§Ø®ØªØµØ§ØµÛ Ø¨Ø±Ø§Û Ø¨ÙØ¨Ùد Ú©ÛÙÛØª
تÙ
اسâÙØ§ در DeltaChat است.
اÛ٠سرÙÛØ³ ب٠عÙÙØ§Ù ÛÚ© ÙØ§Ø³Ø· (Relay) عÙ
Ù Ù
ÛâÚ©ÙØ¯ تا در ØµÙØ±ØªÛ ک٠د٠کاربر ÙØªÙاÙÙØ¯ Ø¨Ù ØµÙØ±Øª Ù
ستÙÛÙ
(P2P) ب٠ÙÙ
Ù
تص٠شÙÙØ¯Ø تÙ
اس از طرÛÙ Ø³Ø±ÙØ± با Ù¾Ø§ÛØ¯Ø§Ø±Û Ø¨Ø§ÙØ§ Ø¨Ø±ÙØ±Ø§Ø± Ø´ÙØ¯.
سÙÙ
ÛÙ ÙØ¶Ø§Û Ø°Ø®ÛØ±ÙâØ³Ø§Ø²Û
Ø³Ø±ÙØ± Ø¨Ø±Ø§Û Ø§Ø·Ù
ÛÙØ§Ù از ØªÙØ²Ûع Ø¹Ø§Ø¯ÙØ§ÙÙ Ù
ÙØ§Ø¨Ø¹Ø Ù
ØØ¯ÙØ¯ÛØªâÙØ§ÛÛ Ø¨Ø±Ø§Û ÙØ¶Ø§Û Ø°Ø®ÛØ±ÙâØ³Ø§Ø²Û Ø§Ø¹Ù
ا٠Ù
ÛâÚ©ÙØ¯. Ø´Ù
ا Ù
ÛâØªÙØ§ÙÛØ¯
Ù
ÛØ²Ø§Ù Ù
صر٠٠سÙÙ Ù
جاز Ø®ÙØ¯ را از طرÛÙ ÙØ± Ø¨Ø±ÙØ§Ù
٠اÛÙ
ÛÙÛ Ú©Ù Ø§Ø² Ø§ÙØ²ÙÙÙ QUOTA Ù¾Ø´ØªÛØ¨Ø§ÙÛ Ù
ÛâÚ©ÙØ¯Ø Ù
Ø´Ø§ÙØ¯Ù Ú©ÙÛØ¯.
Ù
Ø¯ÛØ±Ûت Ø³Ø±ÙØ± (Admin API)
از ÙØ³Ø®Ù v0.15.3 Ø¨Ù Ø¨Ø¹Ø¯Ø ÛÚ© API Ú©ÙØªØ±ÙÛ (Admin API) درÙÙ Ø®ÙØ¯ Ø³Ø±ÙØ± تعبÛ٠شد٠است
ک٠اÙ
کا٠Ù
Ø¯ÛØ±Ûت Ø¢Ø³Ø§Ù Ø³Ø±ÙØ± را ÙØ±Ø§ÙÙ
Ù
ÛâÚ©ÙØ¯.
Ù
Ø³ÛØ± Ø¯Ø³ØªØ±Ø³Û Ø¨Ù Ø§ÛÙ API Ù ÙÙ
ÚÙÛ٠تÙÚ©Ù Ù
Ø¯ÛØ±ÛØªÛ (Admin Token) ÙØ§Ø¨Ù تغÛÛØ± ÙØ³ØªÙد Ù Ù
ÛâØªÙØ§ÙÛØ¯ Ø¢ÙâÙØ§ را Ø¨Ù ØµÙØ±Øª
استاتÛÚ© در ÙØ§ÛÙ ØªÙØ¸ÛÙ
ات Ø³Ø±ÙØ± ÙØ±Ø§Ø± دÙÛØ¯.
Ø¨Ø±Ø§Û Ø¯Ø±ÛØ§Ùت تÙÚ©Ù Ù¾ÛØ´âÙØ±Ø¶ Ø¬ÙØª Ø§ØØ±Ø§Ø² ÙÙÛØªØ Ù
ÛâØªÙØ§ÙÛØ¯ Ø¯Ø³ØªÙØ± maddy admin-token را در Ø³Ø±ÙØ± Ø®ÙØ¯ اجرا
Ú©ÙÛØ¯.
در Ú©ÙØ§Ø± اÛÙ APIØ Ù¾Ø±ÙÚÙ Web Admin ÙÛØ² Ø¨Ø±Ø§Û Ù
Ø¯ÛØ±Ûت گراÙÛÚ©Û Ø³Ø±ÙØ± ØªÙØ³Ø¹Ù داد٠شدÙ
است.
Ø³ÙØ±Ø³âکد اÛ٠پرÙÚ٠در github.com/themadorg/madmail-admin-web ÙØ±Ø§Ø± دارد Ù Ø¨Ù Ø·ÙØ± Ø®ÙØ¯Ú©Ø§Ø±
بÛÙØ¯ ٠در آدرس
https://admin.madmail.chat/
Ù
Ø³ØªÙØ± (Deploy) Ù
ÛâØ´ÙØ¯. با Ù
راجع٠ب٠اÛÙ ÙÛÙÚ© Ù ÙØ§Ø±Ø¯ کرد٠آدرس Ø³Ø±ÙØ± ٠تÙÚ©Ù Ø®ÙØ¯Ø Ø¨Ù Ø±Ø§ØØªÛ Ø³Ø±ÙØ±ØªØ§Ù را Ù
Ø¯ÛØ±Ûت
Ú©ÙÛØ¯.
ØªÙØµÛÙâÙØ§Û اÙ
ÙÛØªÛ
اÙ
ÙÛØª Ù¾ÛØ§Ù
âÙØ§: اÛ٠سرÙÛØ³ Ø¨Ù ØµÙØ±Øª Ù¾ÛØ´âÙØ±Ø¶ Ø¨Ø³ÛØ§Ø± اÙ
٠است. Ø¨Ø±Ø§Û Ø§Ø·Ù
ÛÙØ§Ù از Ù
ØØ±Ù
اÙÚ¯Û
ارتباطات در DeltaChatØ ØªÙØ¬Ù Ø¯Ø§Ø´ØªÙ Ø¨Ø§Ø´ÛØ¯ Ú©Ù ÙØ¬Ùد Ø¢ÛÚ©ÙÙ Ø®Ø§Ú©Ø³ØªØ±Û Ø¯Ø± Ú©ÙØ§Ø±
Ù¾ÛØ§Ù
âÙØ§ ب٠Ù
Ø¹ÙØ§Û ØºÛØ±ÙØ¹Ø§Ù Ø¨ÙØ¯Ù رÙ
زÙÚ¯Ø§Ø±Û Ø§Ø³ØªØ ÙØ°Ø§ Ù¾ÛØ§Ù
âÙØ§Û ØØ³Ø§Ø³ Ø¨Ø§ÛØ¯ ÙØ§Ùد اÛÙ ÙØ´Ø§Ù Ø¨Ø§Ø´ÙØ¯.
بÙâØ±ÙØ²Ø±Ø³Ø§ÙÛ: Ø¨Ø±Ø§Û ØÙظ اÙ
ÙÛØª Ù Ø¨ÙØ±ÙâÙ
ÙØ¯Û از آخرÛÙ ÙÛÚÚ¯ÛâÙØ§Ø ØØªÙ
ا٠اپÙÛÚ©ÛØ´Ù DeltaChat Ø®ÙØ¯
را ÙÙ
ÛØ´Ù ب٠آخرÛÙ ÙØ³Ø®Ù بÙâØ±ÙØ²Ø±Ø³Ø§ÙÛ Ú©ÙÛØ¯.
Ù¾Ø´ØªÛØ¨Ø§ÙÛ
Ø¨Ø±Ø§Û Ø¯Ø±ÛØ§Ùت Ù¾Ø´ØªÛØ¨Ø§ÙÛØ ÙØ·Ùا٠با Ù
Ø¯ÛØ± Ø³Ø±ÙØ± Ø®ÙØ¯ تÙ
اس Ø¨Ú¯ÛØ±Ûد.