Add config flow to imap by engrbm87 · Pull Request #74623 · home-assistant/core

engrbm87 · 2022-07-07T13:29:29Z

Breaking change

The Imap integration migrated to configuration via the UI. Configuring Imap via YAML configuration has been deprecated and will be removed in a future Home Assistant release.

Your existing YAML configuration is automatically imported on upgrade to this release; and thus can be safely removed from your YAML configuration after upgrading.

Proposed change

Add configuration flow for imap integration.
Import config from sensor platform.
Add tests.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add config flow to IMAP integration home-assistant.io#25656

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

github-actions · 2022-11-09T07:06:37Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

MartinHjelmare · 2022-11-09T07:10:42Z

Please solve the merge conflict.

MartinHjelmare · 2022-12-20T13:39:05Z

A future improvement of this integration could be to fire a custom event when a new email arrives. Then we could deprecate the imap_email_content integration.

https://www.home-assistant.io/integrations/imap_email_content/

fix coverage fix config_flows.py

MartinHjelmare

Looks good!

MartinHjelmare · 2023-01-06T22:07:41Z

Ping me when you've linked a docs PR and I'll merge.

engrbm87 · 2023-01-09T08:07:45Z

Ping me when you've linked a docs PR and I'll merge.

Done. Thanks for the support on this one.

MartinHjelmare · 2023-01-09T10:41:36Z

Thanks!

* Add config flow to imap fix coverage fix config_flows.py * move coordinator to seperate file, remove name key * update intrgations.json * update requirements_all.txt * fix importing issue_registry * Address comments * Improve handling exceptions on intial connection * exit loop tasks properly * fix timeout * revert async_timeout * Improve entity update handling * ensure we wait for idle to finish * fix typing * Update deprecation period Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

jbouwh · 2023-03-24T16:28:39Z

A future improvement of this integration could be to fire a custom event when a new email arrives. Then we could deprecate the imap_email_content integration.

https://www.home-assistant.io/integrations/imap_email_content/

@MartinHjelmare With a custom event, can the user use the data, or is it only possible to filter an event with the data?

MartinHjelmare · 2023-03-24T16:35:59Z

I don't understand what you mean with:

can the user use the data, or is it only possible to filter an event with the data

jbouwh · 2023-03-24T16:39:07Z

Found this https://www.home-assistant.io/integrations/template/#turning-an-event-into-a-trigger-based-binary-sensor
If we would use a custom event that sends the data, it should be possible to use the data of the event.

MartinHjelmare · 2023-03-24T16:41:49Z

Yes, the trigger data is available in the template.

https://www.home-assistant.io/docs/automation/templating/#event

homeassistant added the cla-signed label Jul 7, 2022

probot-home-assistant Bot added config-flow This integration migrates to the UI by adding a config flow has-tests integration: imap labels Jul 7, 2022

engrbm87 marked this pull request as ready for review July 26, 2022 09:55

engrbm87 force-pushed the imap-config-flow branch from a461b7a to 32e88ef Compare July 26, 2022 10:04

engrbm87 force-pushed the imap-config-flow branch from 8432cff to 55eeace Compare August 11, 2022 06:48

github-actions Bot added the stale label Nov 9, 2022

github-actions Bot removed the stale label Nov 9, 2022

engrbm87 force-pushed the imap-config-flow branch from 55eeace to 6b34e94 Compare November 10, 2022 08:24

MartinHjelmare requested changes Dec 20, 2022

View reviewed changes

MartinHjelmare reviewed Dec 20, 2022

View reviewed changes

Comment thread homeassistant/components/imap/strings.json Outdated

MartinHjelmare reviewed Dec 20, 2022

View reviewed changes

Comment thread homeassistant/components/imap/sensor.py Outdated

engrbm87 force-pushed the imap-config-flow branch from c228576 to 5d0ad4f Compare December 22, 2022 08:25

engrbm87 commented Dec 22, 2022

View reviewed changes

Comment thread homeassistant/components/imap/coordinator.py Outdated

engrbm87 commented Dec 22, 2022

View reviewed changes

Comment thread homeassistant/components/imap/__init__.py Outdated

MartinHjelmare reviewed Dec 22, 2022

View reviewed changes

Comment thread homeassistant/components/imap/coordinator.py Outdated

Comment thread homeassistant/components/imap/coordinator.py Outdated

MartinHjelmare reviewed Dec 22, 2022

View reviewed changes

Comment thread homeassistant/components/imap/coordinator.py Outdated

engrbm87 commented Dec 22, 2022

View reviewed changes

Comment thread homeassistant/components/imap/coordinator.py Outdated

MartinHjelmare reviewed Dec 27, 2022

View reviewed changes

Comment thread homeassistant/components/imap/coordinator.py Outdated

engrbm87 force-pushed the imap-config-flow branch from cc343d5 to a039482 Compare December 28, 2022 12:11

MartinHjelmare reviewed Dec 28, 2022

View reviewed changes

Comment thread homeassistant/components/imap/coordinator.py Outdated

Comment thread homeassistant/components/imap/sensor.py Outdated

engrbm87 added 5 commits January 6, 2023 09:11

Add config flow to imap

c9719a9

fix coverage fix config_flows.py

move coordinator to seperate file, remove name key

8668136

update intrgations.json

e95824f

update requirements_all.txt

b7058a3

fix importing issue_registry

e390509

engrbm87 added 7 commits January 6, 2023 09:11

Address comments

6c8dbb2

Improve handling exceptions on intial connection

df7e33d

exit loop tasks properly

eb35d4c

fix timeout

9a1c6cd

revert async_timeout

3984bac

Improve entity update handling

1cc89b9

ensure we wait for idle to finish

3980299

engrbm87 force-pushed the imap-config-flow branch from a039482 to 3980299 Compare January 6, 2023 09:12

fix typing

3b3eab5

MartinHjelmare reviewed Jan 6, 2023

View reviewed changes

Comment thread homeassistant/components/imap/sensor.py

MartinHjelmare reviewed Jan 6, 2023

View reviewed changes

Comment thread homeassistant/components/imap/sensor.py Outdated

MartinHjelmare added deprecation Indicates a breaking change to happen in the future docs-missing labels Jan 6, 2023

Update deprecation period

004e3a1

MartinHjelmare approved these changes Jan 6, 2023

View reviewed changes

engrbm87 mentioned this pull request Jan 9, 2023

Add config flow to IMAP integration home-assistant/home-assistant.io#25656

Merged

8 tasks

MartinHjelmare removed the docs-missing label Jan 9, 2023

MartinHjelmare merged commit a0e1805 into home-assistant:dev Jan 9, 2023

github-actions Bot locked and limited conversation to collaborators Jan 10, 2023

Uh oh!

Conversation

engrbm87 commented Jul 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Additional information

Checklist

Uh oh!

github-actions Bot commented Nov 9, 2022

Uh oh!

MartinHjelmare commented Nov 9, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare commented Dec 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare commented Jan 6, 2023

Uh oh!

engrbm87 commented Jan 9, 2023

Uh oh!

MartinHjelmare commented Jan 9, 2023

Uh oh!

jbouwh commented Mar 24, 2023

Uh oh!

MartinHjelmare commented Mar 24, 2023

Uh oh!

jbouwh commented Mar 24, 2023

Uh oh!

MartinHjelmare commented Mar 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

engrbm87 commented Jul 7, 2022 •

edited

Loading

MartinHjelmare commented Dec 20, 2022 •

edited

Loading