Notice Commands#

synadm notice#

Send messages to users.

synadm notice [OPTIONS] COMMAND [ARGS]...

send#

Send server notices to users on the local homeserver.

Localpart or full matrix ID of the notice receiver. If –regex is set

this will be interpreted as a regular expression.

PLAIN

Plain text content of the notice.

FORMATTED

Formatted content of the notice. If omitted, PLAIN will be used.

synadm notice send [OPTIONS] TO PLAIN [FORMATTED]

Options

-f, --from-file#

Interpret arguments as file paths instead of notice content and read content from those files.

Default:: False

-p, --batch-size, --paginate <SIZE>#

The send command retrieves “pages” of users from the homeserver, filters them and sends out the notices, before retrieving the next page. SIZE sets how many users are in each of these “pages”. It is a performance setting and may be useful for servers with a large amount of users.

Default:: 100

-r, --regex#

Interpret TO as regular expression.

Default:: False

-l, --preview-length <LENGTH>#

Length of the displayed list of matched recipients shown in the confirmation prompt. Does not impact sending behavior. Is ignored when global –non-interactive flag is given.

Default:: 10

-s, --silent#

Usually synadm commands print to console what the API returned. With the “Server Notices Admin API”, an event ID or an error messages would be printed for each message sent. Large amounts of recipients could possibly lead to performance impacts, thus this option can be used to disable printing of what the API responded.

Default:: False

Arguments

TO#: Required argument

PLAIN#: Required argument

FORMATTED#: Optional argument