dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(cli): document notification smtp update --transport

Browse Source
This commit is contained in:
Joseph Doherty
2026-08-10 06:39:49 -04:00
parent 6f8b9c755d
commit 2f217f5742
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ZB.MOM.WW.ScadaBridge.CLI/README.md
+6 -2
View File
@@ -1302,18 +1302,22 @@ scadabridge --url <url> notification smtp list
Update the SMTP configuration. Update the SMTP configuration.
```sh ```sh
scadabridge --url <url> notification smtp update --id <int> --server <string> --port <int> --auth-mode <string> --from-address <string> [--tls-mode <string>] [--credentials <string>] scadabridge --url <url> notification smtp update --id <int> --server <string> --port <int> --auth-mode <string> --from-address <string> [--tls-mode <string>] [--credentials <string>] [--transport <string>]
``` ```
| Option | Required | Description | | Option | Required | Description |
|--------|----------|-------------| |--------|----------|-------------|
| `--id` | yes | SMTP config ID | | `--id` | yes | SMTP config ID |
| `--server` | yes | SMTP server hostname | | `--server` | yes | SMTP server hostname (under `--transport Ews`, the full EWS URL — `https://…/ews/exchange.asmx`) |
| `--port` | yes | SMTP server port | | `--port` | yes | SMTP server port |
| `--auth-mode` | yes | Authentication mode (e.g. `OAuth2ClientCredentials`, `Basic`) | | `--auth-mode` | yes | Authentication mode (e.g. `OAuth2ClientCredentials`, `Basic`) |
| `--from-address` | yes | Sender email address | | `--from-address` | yes | Sender email address |
| `--tls-mode` | no | TLS mode: `None`, `StartTLS`, or `SSL` (preserves existing if omitted) | | `--tls-mode` | no | TLS mode: `None`, `StartTLS`, or `SSL` (preserves existing if omitted) |
| `--credentials` | no | SMTP credentials — `username:password` for Basic, or client secret for OAuth2 (preserves existing if omitted) | | `--credentials` | no | SMTP credentials — `username:password` for Basic, or client secret for OAuth2 (preserves existing if omitted) |
| `--transport` | no | Email transport: `Smtp` or `Ews` (preserves existing if omitted) |
Under `--transport Ews`, `--server` carries the full EWS URL, `--auth-mode` must be `Basic`,
and `--port` / `--tls-mode` are unused.
#### `notification sms list` #### `notification sms list`