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 خود
را همیشه به آخرین نسخه بهروزرسانی کنید.
پشتیبانی
برای دریافت پشتیبانی، لطفاً با مدیر سرور خود تماس بگیرید.