Options Reference¶

Every options: key accepted by a delivery or transport, generated from the DeliveryOption metadata in options.py. See Default Options for the actual default value each transport sets for these.

Common Options¶

Accepted by every transport.

Option	Type	Examples	Description
simplify_text	bool	-	Remove some common symbols that can trip up voice assistants. SSML markup is left alone on spoken transports
strip_urls	bool	-	Remove URLs from message and title
message_usage	str	`combine_title` `use_title`	Combine message and title, default title
target_select	Selection Rules	-	Only use targets fully matching these regular expressions
unique_targets	bool	-	Don't pass targets already used in this notification
target_categories	list[str]	`["entity_id", "device_id"]`	Which targets to pass, e.g. entity_id, email, device_id
device_discovery	bool	-	Switch automatic device discovery on or off
device_domain	str	-	One or more Home Assistant domains to discover devices, e.g. alexa_devices
device_model_select	Selection Rules	-	Choose device models in device discovery
device_manufacturer_select	Selection Rules	-	Choose device manufacturers in device discovery
device_os_select	Selection Rules	-	Choose device operating systems in device discovery
device_label_select	Selection Rules	-	Choose devices by label in device discovery
device_area_select	Selection Rules	-	Choose devices by Home Assistant area in device discovery

Transport-Specific Options¶

alexa_media_player¶

Option	Type	Examples	Description
media_auto_pause	bool	-	Pause (rather than stop) music if playing before announcing, and restore afterwards

chime¶

Option	Type	Examples	Description
chime_aliases	str	-	Custom chime device aliases and their per-domain tuning

discord¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

email¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification
strict_template	bool	-	Fail template if Jinja2 issues found when true, render anyway if false
preheader_blank	str	-	HTML code used to pack the pre-header with blanks for HTML email
preheader_length	int	-	Minimum size to pack the pre-header with blanks for HTML email
mode	`direct`: Use the native SMTP transport, `ha_smtp`: Use the Home Assistant SMTP integration	-	Set to direct to send over a direct SMTP connection instead of an action call
sender	str	-	Sender address used in direct SMTP mode
sender_name	str	-	Sender display name used in direct SMTP mode
default_title	str	-	Default email subject if none supplied

generic¶

Option	Type	Examples	Description
raw	bool	-	Don't apply domain specific data handling and pruning rules
handle_as_domain	str	-	Treat the action call in the same way as a known domain
data_keys_select	Selection Rules	-	Prune the data block by including/excluding values or by regex pattern

gotify¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

html5¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

kodi¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

matrix¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

media¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

mobile_push¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification
data_keys_select	Selection Rules	-	Prune the data block by including/excluding values or by regex pattern

ntfy¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

pushover¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

telegram¶

Option	Type	Examples	Description
jpeg_opts	mapping	`progressive: true` `optimize: true` `quality: 50`	Tune camera snapshot grabs saved/attached as JPEG
png_opts	mapping	`optimize: true`	Tune camera snapshot grabs saved/attached as PNG
reprocess	`always`: Always regenerate, `never`: Reuse the existing grab, `preserve`: Keep the original file	-	Whether to regenerate a camera snapshot already grabbed for this notification

tts¶

Option	Type	Examples	Description
tts_entity_id	str	-	The tts entity used to generate speech