Deprecate mailbox platform (#31632)

This commit is contained in:
Robert Resch 2024-02-27 13:50:28 +01:00 committed by GitHub
parent 26cd51f6fc
commit 019a83fc4c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 3 additions and 80 deletions

View File

@ -1,12 +0,0 @@
---
title: Asterisk Call Detail Records
description: Instructions on how to integrate an Asterisk CDR within Home Assistant.
ha_category:
- Mailbox
ha_iot_class: Local Polling
ha_release: 0.79
ha_domain: asterisk_cdr
ha_integration_type: integration
---
The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail integration](/integrations/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/).

View File

@ -1,49 +0,0 @@
---
title: Asterisk Voicemail
description: Instructions on how to integrate your existing Asterisk voicemail within Home Assistant.
ha_category:
- Mailbox
ha_iot_class: Local Push
ha_release: 0.51
ha_domain: asterisk_mbox
ha_integration_type: integration
---
The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The integration includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
To enable the integration, a configuration is required in both Home Assistant as well as on the Asterisk server.
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
## Configuration
Once that is complete, add the following entry `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
asterisk_mbox:
password: ASTERISK_PBX_PASSWORD
host: ASTERISK_PBX_SERVER_IP_ADDRESS
port: ASTERISK_PBX_SERVER_PORT
```
This will add a new 'Mailbox' side-panel, as well as a sensor to indicate # of messages available.
{% configuration %}
password:
description: The password that was set during Asterisk PBX configuration
required: true
type: string
host:
description: The IP-address of the server that is running the Asterisk PBX
required: true
type: string
port:
description: The port on the Asterisk PBX server that was configured during Asterisk PBX configuration
required: true
type: string
{% endconfiguration %}
<div class='note warning'>
Communication between the Asterisk PBX server and Home Assistant is password-protected, but the data transmission is not encrypted. It is recommended to only use this integration when communication is contained within a local area network.
</div>

View File

@ -65,7 +65,6 @@ Available demo platforms:
- [Image processing](/integrations/image_processing/) (`image_processing`)
- [Light](/integrations/light/) (`light`)
- [Lock](/integrations/lock/) (`lock`)
- [Mailbox](/integrations/mailbox/) (`mailbox`)
- [Media player](/integrations/media_player/) (`media_player`)
- [Notification](/integrations/notify/) (`notify`)
- [Number](/integrations/number/) (`number`)

View File

@ -1,17 +0,0 @@
---
title: Mailbox
description: Instructions on how to setup your mailboxes with Home Assistant.
ha_release: 0.51
ha_domain: mailbox
ha_quality_scale: internal
ha_category: []
ha_integration_type: entity
---
Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend.
Home Assistant currently supports only the [Asterisk Voicemail](/integrations/asterisk_mbox/) mailbox.
Each mailbox also provides an entity to indicate the number of messages available on the main page.
{% include integrations/building_block_integration.md %}

View File

@ -205,7 +205,6 @@ layout: null
/components/image_processing.* /integrations/:splat
/components/light.* /integrations/:splat
/components/lock.* /integrations/:splat
/components/mailbox.* /integrations/:splat
/components/media_player.* /integrations/:splat
/components/notify.* /integrations/:splat
/components/remote.* /integrations/:splat
@ -480,6 +479,8 @@ layout: null
/integrations/apns /more-info/removed-integration 301
/integrations/arlo /more-info/removed-integration 301
/integrations/arduino /more-info/removed-integration 301
/integrations/asterisk_cdr /more-info/removed-integration 301
/integrations/asterisk_mbox /more-info/removed-integration 301
/integrations/bbb_gpio /more-info/removed-integration 301
/integrations/bh1750 /more-info/removed-integration 301
/integrations/binary_sensor.mychevy /more-info/removed-integration 301
@ -536,6 +537,7 @@ layout: null
/integrations/loopenergy /more-info/removed-integration 301
/integrations/lyft /more-info/removed-integration 301
/integrations/magicseaweed /more-info/removed-integration 301
/integrations/mailbox /more-info/removed-integration 301
/integrations/mazda /more-info/removed-integration 301
/integrations/mcp23017 /more-info/removed-integration 301
/integrations/mhz19 /more-info/removed-integration 301