github.com/e154/smart-home@v0.17.2-0.20240311175135-e530a6e5cd45/doc/content/en/docs/plugins/notify/email.md (about)

     1  
     2  ---
     3  title: "EMAIL"
     4  linkTitle: "email"
     5  date: 2024-01-04
     6  description: >
     7    
     8  ---
     9  
    10  The Email plugin provides the ability to integrate email sending functionality into the Smart Home system. This plugin allows users to configure email parameters and send notifications or messages from devices within the smart home.
    11  
    12  #### Device Settings
    13  
    14  - **`email` (type: String)**: The email through which messages are sent.
    15  
    16  - **`auth` (type: String)**: Authentication method for accessing the mail server (e.g., "PLAIN" or "LOGIN").
    17  
    18  - **`pass` (type: Encrypted)**: Encrypted password for authentication when accessing the mail server.
    19  
    20  - **`smtp` (type: String)**: Outgoing mail server (SMTP) address.
    21  
    22  - **`port` (type: Int)**: Outgoing mail server port (e.g., 587 for TLS or 465 for SSL).
    23  
    24  - **`sender` (type: String)**: Sender's email address.
    25  
    26  #### Message Attributes
    27  
    28  - **`addresses` (type: String)**: A list of recipient email addresses, separated by commas.
    29  
    30  - **`subject` (type: String)**: The subject of the email message.
    31  
    32  - **`body` (type: String)**: The body text of the email message.
    33  
    34  #### Example in Coffeescript
    35  
    36  ```coffeescript
    37  msg = notifr.newMessage();
    38  msg.entity_id = 'email.google';
    39  msg.attributes = {
    40    'body': 'some text msg',
    41    'addresses': 'john.smith@example.com,jane.doe@example.com',
    42    'subject': 'Important Notification',
    43  };
    44  ```