Notice
synadm notice
Send messages to users with the help of the Server Notices Admin API.
synadm notice [OPTIONS] COMMAND [ARGS]...
send
Send server notices to users on the local homeserver.
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, --paginate <PAGINATE>
The send command retrieves “pages” of users from the homeserver, filters them and sends out the notices, before retrieving the next page. PAGINATE 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