skrybe brands
| Command | Description |
|---|---|
brands | Show the brand the API key belongs to |
brands transport | Show or switch how a brand sends (main account key only) |
brands
skrybe brands
skrybe brands ls
Shows the brands visible to the current API key: ID and name. A brand's key
sees exactly one brand, its own. ls and list are aliases for the bare
command. skrybe whoami shows the same with the active
profile.
ID NAME
86 Acme
API: api/brands/get-brands.php
brands transport
skrybe brands transport <brand-id> [relay|ses] [options]
Shows, or switches, whether a brand sends through the Skrybe SMTP relay or
through SES. Leave out relay|ses to only show the current setting.
This is an administrative command. It needs the install's main account
API key; a brand's own key is rejected with invalid_api_key and a hint to
use the admin profile. Keep the main key in its own profile:
skrybe auth login --profile admin
skrybe --profile admin brands transport 86
Brand 86 Acme
Transport ses
SMTP host -
Port -
SSL/TLS -
Username -
Password not set
Transport can also show smtp, meaning an SMTP server other than the relay,
set in the web app's brand settings. The password itself is never shown.
| Argument / flag | Description |
|---|---|
<brand-id> | Numeric brand ID, as in the web app's brand URL (app?i=86) |
relay or ses | Transport to switch to. Leave out to only show |
--password-stdin | Read the relay password from stdin. Relay only |
--username <login> | Relay login. The default, and the only value the relay accepts, is brand<brand-id>, plus -<env> outside production. Relay only |
--host <host> | Relay host. Default: the server's RELAY_SMTP_HOST, or mta1.skry.be. Relay only |
--no-verify | Switch to the relay without first logging in to it with the brand's From address. Relay only |
--force | Switch even while one of the brand's campaigns is sending |
--password-stdin, --username, --host and --no-verify are only allowed
when switching to relay, and --force only when switching. The password is
read from stdin so it stays out of ps and shell history; a trailing newline
is removed:
printf '%s' "$RELAY_PASSWORD" | skrybe --profile admin brands transport 86 relay --password-stdin
skrybe --profile admin brands transport 86 ses
The password can be left out if the brand already has one stored for the same username.
Before switching to the relay, the server logs in to it and checks it accepts
the brand's From domain, unless --no-verify is given. It refuses to switch
while one of the brand's campaigns is sending, since the rest of that campaign
would go the other way, unless --force is given.
Errors include relay_login_refused, relay_sender_refused,
relay_unreachable, relay_tls_failed, relay_login_mismatch,
smtp_password_missing, campaign_sending and brand_not_found.
Showing is a read and is retried on transient failures; switching is never retried.