zeek/doc/scripts/base/protocols/smtp/files.zeek.rst
Patrick Kelley 8fd444092b initial
2025-05-07 15:35:15 -04:00

52 lines
2.2 KiB
ReStructuredText

:tocdepth: 3
base/protocols/smtp/files.zeek
==============================
.. zeek:namespace:: SMTP
:Namespace: SMTP
:Imports: :doc:`base/frameworks/files </scripts/base/frameworks/files/index>`, :doc:`base/protocols/smtp/entities.zeek </scripts/base/protocols/smtp/entities.zeek>`, :doc:`base/protocols/smtp/main.zeek </scripts/base/protocols/smtp/main.zeek>`, :doc:`base/utils/conn-ids.zeek </scripts/base/utils/conn-ids.zeek>`
Summary
~~~~~~~
Redefinitions
#############
============================================ ===========================================================================================================================
:zeek:type:`SMTP::Info`: :zeek:type:`record`
:New Fields: :zeek:type:`SMTP::Info`
fuids: :zeek:type:`vector` of :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&default` = ``[]`` :zeek:attr:`&optional`
An ordered vector of file unique IDs seen attached to
the message.
============================================ ===========================================================================================================================
Functions
#########
======================================================= ======================================
:zeek:id:`SMTP::describe_file`: :zeek:type:`function` Default file describer for SMTP.
:zeek:id:`SMTP::get_file_handle`: :zeek:type:`function` Default file handle provider for SMTP.
======================================================= ======================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: SMTP::describe_file
:source-code: base/protocols/smtp/files.zeek 28 39
:Type: :zeek:type:`function` (f: :zeek:type:`fa_file`) : :zeek:type:`string`
Default file describer for SMTP.
.. zeek:id:: SMTP::get_file_handle
:source-code: base/protocols/smtp/files.zeek 22 26
:Type: :zeek:type:`function` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`) : :zeek:type:`string`
Default file handle provider for SMTP.