.. Generated by docs/_scripts/generate_operation_docs.py. Do not edit.

Extract email addresses
=======================

**Category:** Networking

**Status:** Registered and callable in the CyberChef 11.3.0 compatibility inventory.

**Input / output:** ``string`` → ``string``

What it does
------------

Extracts all email addresses from the input.

.. note::

   Status here means the operation name is implemented and callable. It does not by
   itself promise byte-for-byte parity for every upstream option. See
   :doc:`../../compatibility` for the verified
   scope and known boundaries.

Arguments and options
---------------------

Arguments are positional. Keep their order when using ``bake()`` or
``Pipeline.then()``.

.. list-table::
   :header-rows: 1
   :widths: 8 24 16 24 28

   * - Index
     - Name
     - UI type
     - PyChef default
     - Accepted values / format
   * - ``0``
     - Display total
     - ``boolean``
     - ``False``
     - ``True`` or ``False``
   * - ``1``
     - Sort
     - ``boolean``
     - ``False``
     - ``True`` or ``False``
   * - ``2``
     - Unique
     - ``boolean``
     - ``False``
     - ``True`` or ``False``

Recipe template
---------------

.. important::

   This is a call template built from the documented defaults. Replace placeholder
   values such as empty keys, paths, patterns, or lookup data before running it.

.. code-block:: python

   from pychef import bake

   input_value = "example"
   args = [False, False, False]
   result = bake(input_value, [{"op": 'Extract email addresses', "args": args}])
   print(result)

Pipeline example
----------------

.. code-block:: python

   from pychef import Pipeline

   args = [False, False, False]
   transform = Pipeline().then('Extract email addresses', *args)
   result = transform("example")

Dedicated operation module
--------------------------

The registered entry point lives in
``pychef.operations.by_operation.extract_email_addresses``. Direct calls
receive the input value and a positional argument tuple:

.. code-block:: python

   from pychef.operations.by_operation.extract_email_addresses import run

   result = run("example", tuple([False, False, False]))

.. autofunction:: pychef.operations.by_operation.extract_email_addresses.run