mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 00:36:49 +00:00
Updated new configuration style for notify.smtp.markdown (#7321)
* Updated new configuration style for notify.smtp.markdown * Fix issue with nelify build Co-Authored-By: ChristofferG <christoffer.graversen@gmail.com>
This commit is contained in:
parent
a9cf31ac3a
commit
741faf9b80
@ -26,19 +26,58 @@ notify:
|
||||
recipient: YOUR_RECIPIENT
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **sender** (*Required*): E-mail address of the sender.
|
||||
- **recipient** (*Required*): E-mail address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.
|
||||
- **server** (*Optional*): SMTP server which is used to end the notifications. Defaults to `localhost`.
|
||||
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 587.
|
||||
- **timeout** (*Optional*): The timeout in seconds that the SMTP server is using. Defaults to 5.
|
||||
- **username** (*Optional*): Username for the SMTP account.
|
||||
- **password** (*Optional*): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
|
||||
- **encryption** (*Optional*): Set mode for encryption, `starttls`, `tls` or `none`. Defaults to `starttls`.
|
||||
- **sender_name** (*Optional*): Sets a custom 'sender name' in the emails headers (*From*: Custom name <example@mail.com>).
|
||||
- **debug** (*Optional*): Enables Debug, eg. True or False. Defaults to False.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
required: false
|
||||
type: string
|
||||
default: notify
|
||||
sender:
|
||||
description: E-mail address of the sender.
|
||||
required: true
|
||||
type: string
|
||||
recipient:
|
||||
description: E-mail address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.
|
||||
required: true
|
||||
type: [list, string]
|
||||
server:
|
||||
description: SMTP server which is used to end the notifications.
|
||||
required: false
|
||||
type: string
|
||||
default: localhost
|
||||
port:
|
||||
description: The port that the SMTP server is using.
|
||||
required: false
|
||||
type: integer
|
||||
default: 587
|
||||
timeout:
|
||||
description: The timeout in seconds that the SMTP server is using.
|
||||
required: false
|
||||
type: integer
|
||||
default: 5
|
||||
username:
|
||||
description: Username for the SMTP account.
|
||||
required: false
|
||||
type: string
|
||||
password:
|
||||
description: Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
|
||||
required: false
|
||||
type: string
|
||||
encryption:
|
||||
description: Set mode for encryption, `starttls`, `tls` or `none`.
|
||||
required: false
|
||||
type: string
|
||||
default: starttls
|
||||
sender_name:
|
||||
description: "Sets a custom 'sender name' in the emails headers (*From*: Custom name <example@mail.com>)."
|
||||
required: false
|
||||
type: string
|
||||
debug:
|
||||
description: Enables Debug, eg. True or False.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
A sample configuration entry for Google Mail.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user