MailPlusServer
Overview
Synology MailPlus Server API client.
Manages MailPlus Server configuration, SMTP/IMAP settings, security policies, audit logs, and mail queue monitoring via the SYNO.MailPlusServer.* WebAPI endpoints.
Requires MailPlus Server installed on the target NAS.
Methods
mailplus_info
Get core MailPlus Server settings.
Internal API
SYNO.MailPlusServer.MailPlus
Returns
dict[str, object] or str
Settings including SMTP sender name, DSM access,
mail export, PGP, and POP3 toggles.
mailplus_server_list
List MailPlus servers in the cluster.
Internal API
SYNO.MailPlusServer.ServerList
Returns
dict[str, object] or str
{"data": {"server_list": [...], "balancer_enabled": ..., "cluster_syncing": ...}, "success": true}.
mailplus_smtp_general
Get SMTP general configuration.
Internal API
SYNO.MailPlusServer.SMTP.General
Returns
dict[str, object] or str
SMTP settings including banner, hostname,
max hops, recipients, and auth settings.
mailplus_smtp_security
Get SMTP security configuration.
Internal API
SYNO.MailPlusServer.SMTP.Security
Returns
dict[str, object] or str
Security limits including max connections per minute,
max mails per minute, parallel connections, and
junk command thresholds.
mailplus_imap_pop3
Get IMAP/POP3 configuration.
Internal API
SYNO.MailPlusServer.IMAP_POP3
Returns
dict[str, object] or str
IMAP, IMAPS, POP3, POP3S enable/disable toggles
and authentication security settings.
mailplus_security
Get mail flow limit and sender quota settings.
Internal API
SYNO.MailPlusServer.Security
Returns
dict[str, object] or str
Flow limit (mails per time period) and sender
quota configuration.
mailplus_report
Get mail report configuration.
Internal API
SYNO.MailPlusServer.Report
Returns
dict[str, object] or str
Report settings including enable toggle,
recipient, and scheduled hours/minutes.
mailplus_admin_log
List MailPlus admin audit log entries.
Internal API
SYNO.MailPlusServer.Audit.AdminLog
Parameters
offset int
Pagination offset (default 0).
limit int
Maximum results per page (default 50).
Returns
dict[str, object] or str
{"data": {"log_list": [...], "offset": N, "total": N}, "success": true}.
mailplus_transaction_log
List MailPlus mail transaction log entries.
Internal API
SYNO.MailPlusServer.Audit.TransactionLog
Parameters
offset int
Pagination offset (default 0).
limit int
Maximum results per page (default 50).
Returns
dict[str, object] or str
{"data": {"items": [...], "offset": N, "total": N, "is_migrating": bool}, "success": true}.
mailplus_queue
List messages in the mail queue.
Internal API
SYNO.MailPlusServer.Queue
Parameters
offset int
Pagination offset (default 0).
limit int
Maximum results per page (default 50).
Returns
dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}.