mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 15:18:20 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
82 lines
2.8 KiB
ReStructuredText
82 lines
2.8 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/utils/email.zeek
|
|
=====================
|
|
|
|
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Functions
|
|
#########
|
|
============================================================ ===========================================================================
|
|
:zeek:id:`extract_email_addrs_set`: :zeek:type:`function` Extract mail addresses out of address specifications conforming to RFC5322.
|
|
:zeek:id:`extract_email_addrs_vec`: :zeek:type:`function` Extract mail addresses out of address specifications conforming to RFC5322.
|
|
:zeek:id:`extract_first_email_addr`: :zeek:type:`function` Extract the first email address from a string.
|
|
:zeek:id:`split_mime_email_addresses`: :zeek:type:`function` Split email addresses from MIME headers.
|
|
============================================================ ===========================================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Functions
|
|
#########
|
|
.. zeek:id:: extract_email_addrs_set
|
|
:source-code: base/utils/email.zeek 24 33
|
|
|
|
:Type: :zeek:type:`function` (str: :zeek:type:`string`) : :zeek:type:`set` [:zeek:type:`string`]
|
|
|
|
Extract mail addresses out of address specifications conforming to RFC5322.
|
|
|
|
|
|
:param str: A string potentially containing email addresses.
|
|
|
|
|
|
:returns: A set of extracted email addresses. An empty set is returned
|
|
if no email addresses are discovered.
|
|
|
|
.. zeek:id:: extract_email_addrs_vec
|
|
:source-code: base/utils/email.zeek 7 16
|
|
|
|
:Type: :zeek:type:`function` (str: :zeek:type:`string`) : :zeek:type:`string_vec`
|
|
|
|
Extract mail addresses out of address specifications conforming to RFC5322.
|
|
|
|
|
|
:param str: A string potentially containing email addresses.
|
|
|
|
|
|
:returns: A vector of extracted email addresses. An empty vector is returned
|
|
if no email addresses are discovered.
|
|
|
|
.. zeek:id:: extract_first_email_addr
|
|
:source-code: base/utils/email.zeek 40 47
|
|
|
|
:Type: :zeek:type:`function` (str: :zeek:type:`string`) : :zeek:type:`string`
|
|
|
|
Extract the first email address from a string.
|
|
|
|
|
|
:param str: A string potentially containing email addresses.
|
|
|
|
|
|
:returns: An email address or empty string if none found.
|
|
|
|
.. zeek:id:: split_mime_email_addresses
|
|
:source-code: base/utils/email.zeek 58 67
|
|
|
|
:Type: :zeek:type:`function` (line: :zeek:type:`string`) : :zeek:type:`set` [:zeek:type:`string`]
|
|
|
|
Split email addresses from MIME headers. The email addresses will
|
|
include the display name and email address as it was given by the mail
|
|
mail client. Note that this currently does not account for MIME group
|
|
addresses and won't handle them correctly. The group name will show up
|
|
as part of an email address.
|
|
|
|
|
|
:param str: The argument from a MIME header.
|
|
|
|
|
|
:returns: A set of addresses or empty string if none found.
|
|
|
|
|