Skip to content

Commit

Permalink
Improve imap config flow strings and add data descriptions (#131279)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbouwh authored Nov 22, 2024
1 parent 1dbb92e commit 6064055
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion homeassistant/components/imap/strings.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,31 @@
"charset": "Character set",
"folder": "Folder",
"search": "IMAP search",
"event_message_data": "Message data to be included in the `imap_content` event data:",
"ssl_cipher_list": "SSL cipher list (Advanced)",
"verify_ssl": "[%key:common::config_flow::data::verify_ssl%]"
},
"data_description": {
"username": "The IMAP username.",
"password": "The IMAP password",
"server": "The IMAP server.",
"port": "The IMAP port supporting SSL, usually this is 993.",
"charset": "The character set used. Common values are `utf-8` or `US-ASCII`.",
"folder": "In generally the folder is set to `INBOX`, but e.g. in case of a sub folder, named `Test`, this should be `INBOX.Test`.",
"search": "The IMAP search command which is `UnSeen UnDeleted` by default.",
"event_message_data": "Note that the event size is limited, and not all message text might be sent with the event if the message is too large.",
"ssl_cipher_list": "If the IMAP service only supports legacy encryption, try to change this.",
"verify_ssl": "Recommended, to ensure the server certificate is valid. Turn off, if the server certificate is not trusted (e.g. self signed)."
}
},
"reauth_confirm": {
"description": "The password for {username} is invalid.",
"title": "[%key:common::config_flow::title::reauth%]",
"data": {
"password": "[%key:common::config_flow::data::password%]"
},
"data_description": {
"password": "Correct the IMAP password."
}
}
},
Expand Down Expand Up @@ -81,7 +97,15 @@
"custom_event_data_template": "Template to create custom event data",
"max_message_size": "Max message size (2048 < size < 30000)",
"enable_push": "Enable Push-IMAP if the server supports it. Turn off if Push-IMAP updates are unreliable.",
"event_message_data": "Message data to be included in the `imap_content` event data:"
"event_message_data": "Message data to be included in the `imap_content` event data."
},
"data_description": {
"folder": "[%key:component::imap::config::step::user::data_description::folder%]",
"search": "[%key:component::imap::config::step::user::data_description::search%]",
"event_message_data": "[%key:component::imap::config::step::user::data_description::event_message_data%]",
"custom_event_data_template": "This template is evaluated when a new message was received, and the result is added to the `custom` attribute of the event data.",
"max_message_size": "Limit the maximum size of the event. Instead of passing the (whole) text message, using a template is a better option.",
"enable_push": "Using Push-IMAP is recommended. Polling will increase the time to respond."
}
}
},
Expand Down

0 comments on commit 6064055

Please sign in to comment.