Skip to content

Commit

Permalink
Docs: note inbound attachments doesn't include inlines
Browse files Browse the repository at this point in the history
Closes #389
  • Loading branch information
medmunds committed Aug 7, 2024
1 parent 13fa505 commit 53dcc1e
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/inbound.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,15 +242,20 @@ Normalized inbound message
A `list` of all attachments to the message, or an empty list if there are
no attachments. See :ref:`inbound-attachments` below a description of the values.

Note that inline images (which appear intermixed with a message's body text)
are generally not included in :attr:`!attachments`. Use :attr:`inlines`
to access inline images.

If the inbound message includes an attached message, :attr:`!attachments`
will include the attached message and all of *its* attachments, recursively.
Consider Python's :meth:`~email.message.EmailMessage.iter_attachments` as an
alternative that doesn't descend into attached messages.

.. attribute:: inlines

A `list` of all inline content parts in the message, or an empty list if none.
See :ref:`inbound-attachments` below for a description of the values.
A `list` of all inline images (or other inline content) in the message,
or an empty list if none. See :ref:`inbound-attachments` below for
a description of the values.

Like :attr:`attachments`, this will recursively descend into any attached messages.

Expand Down

0 comments on commit 53dcc1e

Please sign in to comment.