mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 14:48:21 +00:00

This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
55 lines
2.6 KiB
ReStructuredText
55 lines
2.6 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.
|
|
|
|
rfc822_msg_fuid: :zeek:type:`string` :zeek:attr:`&optional`
|
|
Tracks the fuid of the top-level RFC822 mail message if
|
|
:zeek:see:`SMTP::enable_rfc822_msg_file_analysis` is set.
|
|
============================================ ===========================================================================================================================
|
|
|
|
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 36 47
|
|
|
|
: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 26 34
|
|
|
|
:Type: :zeek:type:`function` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`) : :zeek:type:`string`
|
|
|
|
Default file handle provider for SMTP.
|
|
|
|
|