zeek/doc/scripts/base/bif/plugins/Zeek_IMAP.events.bif.zeek.rst
Tim Wojtulewicz adce4e604a Copy docs into Zeek repo directly
This is based on commit 99e6942efec5feff50523f6b2a1f5868f19ab638 from the
zeek-docs repo.
2025-10-13 11:06:48 -07:00

51 lines
1.6 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_IMAP.events.bif.zeek
==========================================
.. zeek:namespace:: GLOBAL
:Namespace: GLOBAL
Summary
~~~~~~~
Events
######
================================================ ==================================================================
:zeek:id:`imap_capabilities`: :zeek:type:`event` Generated when a server sends a capability list to the client,
after being queried using the CAPABILITY command.
:zeek:id:`imap_starttls`: :zeek:type:`event` Generated when a IMAP connection goes encrypted after a successful
StartTLS exchange between the client and the server.
================================================ ==================================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: imap_capabilities
:source-code: base/bif/plugins/Zeek_IMAP.events.bif.zeek 10 10
:Type: :zeek:type:`event` (c: :zeek:type:`connection`, capabilities: :zeek:type:`string_vec`)
Generated when a server sends a capability list to the client,
after being queried using the CAPABILITY command.
:param c: The connection.
:param capabilities: The list of IMAP capabilities as sent by the server.
.. zeek:id:: imap_starttls
:source-code: base/bif/plugins/Zeek_IMAP.events.bif.zeek 17 17
:Type: :zeek:type:`event` (c: :zeek:type:`connection`)
Generated when a IMAP connection goes encrypted after a successful
StartTLS exchange between the client and the server.
:param c: The connection.