Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix large imap_content event warning by truncating the email text body to 2 KiB #92066

Merged
merged 1 commit into from Apr 26, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Apr 26, 2023

Breaking change

The use of imap_content event could break for users that want to parse data from larger email messages from the part that is truncated. Only the first 2048 bytes of the message body (2 KiB) will be available.

Proposed change

Limits the size of the email text body that will be available in the event data or an imap_content event.
We should avoid large text bodies to be passed as event. The size of body text will be truncated to 2 KiB.
Large messages will lead to event data becoming to large, causing events not to be processed and warnings in the log about the size. A PR to update the documentation is added.

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)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

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
  • I have followed the perfect PR recommendations
  • 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:

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @engrbm87, mind taking a look at this pull request as it has been labeled with an integration (imap) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of imap can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign imap Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@jbouwh jbouwh added this to the 2023.5.0b0 milestone Apr 26, 2023
@jbouwh jbouwh linked an issue Apr 26, 2023 that may be closed by this pull request
@jbouwh jbouwh changed the title Limit email text in imap_content event to 2 KiB Fix large imap_content event warning by truncating the email text body to 2 KiB Apr 26, 2023
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @jbouwh 👍

../Frenck

@frenck frenck merged commit 5a78684 into home-assistant:dev Apr 26, 2023
26 checks passed
@jbouwh jbouwh deleted the imap-event-max-size branch April 26, 2023 17:11
@github-actions github-actions bot locked and limited conversation to collaborators Apr 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warning about the imap_content event
2 participants