Návod: operátor pro odesílání e-mailů v Gmailu

V tomto kurzu vytvoříte python-run-function operátor pro Návrháře Lakeflow, který odešle obsah datového rámce jako přílohu CSV přes Gmail. V tomto příkladu se dozvíte, jak vytvářet operátory založené na YAML, které provádějí vedlejší účinky, jako je odesílání oznámení nebo zápis do externích systémů. Další informace najdete v tématu Uživatelem definované operátory v Návrháři Lakeflow.

Requirements

Pracovní prostor Azure Databricks s oprávněním vytvářet oblasti tajných kódů.
Účet Gmail s heslem aplikace Google (vyžaduje se při povolení vícefaktorového ověřování (MFA).
Rozhraní příkazového řádku Databricks je nainstalované na vašem místním vývojovém počítači.

Krok 1: Nastavení tajných kódů

Uložte přihlašovací údaje ke Gmailu do secret scope v Azure Databricks, aby je operátor mohl za běhu načíst.

Vytvořte rozsah tajných klíčů pomocí rozhraní příkazového řádku Azure Databricks (CLI):
```
databricks secrets create-scope my_email_scope
```
Uložte heslo aplikace pro Gmail v rozsahu:
```
databricks secrets put-secret my_email_scope gmail_app_password
```
Zobrazí se výzva k zadání hodnoty tajného kódu. Vložte heslo aplikace Gmail a uložte ho.

Krok 2: Napište funkci `run()`

Typ python-run-function operátoru vyžaduje funkci s tímto podpisem run() :

def run(config: Dict[str, Any], inputs: Dict[str, Any], spark) -> Dict[str, Any]:

config: Hodnoty konfigurace poskytované uživatelem v uživatelském rozhraní Návrháře Lakeflow.
inputs: Vstupní datové rámce s klíči podle názvu portu
spark: Aktivní relace Sparku.

Funkce musí vrátit slovník výstupních datových rámců s klíči podle názvu výstupního portu.

Definujte a otestujte funkci v buňce poznámkového bloku:

from typing import Dict, Any

def run(config: Dict[str, Any], inputs: Dict[str, Any], spark) -> Dict[str, Any]:
    input_df = inputs["data"]

    # Skip side effects during Designer preview
    if config.get("is_preview", False):
        return {"data": input_df}

    import smtplib
    import os
    from email.mime.multipart import MIMEMultipart
    from email.mime.text import MIMEText
    from email.mime.base import MIMEBase
    from email import encoders

    sender_email = config.get("sender_email", "")
    secret_scope = config.get("secret_scope", "")
    secret_key = config.get("secret_key", "")
    recipients_raw = config.get("recipients", "")
    subject = config.get("subject", "")
    body = config.get("body", "")

    if not sender_email:
        raise ValueError("Sender Email is required.")
    if not secret_scope or not secret_key:
        raise ValueError("Secret Scope and Secret Key are required.")
    if not recipients_raw:
        raise ValueError("At least one recipient is required.")

    recipients = [r.strip() for r in recipients_raw.split(",") if r.strip()]
    if not recipients:
        raise ValueError("At least one valid recipient email is required.")

    # Retrieve password from Databricks secrets
    from pyspark.dbutils import DBUtils
    dbutils = DBUtils(spark)
    sender_password = dbutils.secrets.get(scope=secret_scope, key=secret_key)

    # Convert DataFrame to CSV
    pdf = input_df.toPandas()
    file_path = "/tmp/designer_email_attachment.csv"
    pdf.to_csv(file_path, index=False)

    # Send email to each recipient
    for recipient in recipients:
        msg = MIMEMultipart()
        msg["From"] = sender_email
        msg["To"] = recipient
        msg["Subject"] = subject
        msg.attach(MIMEText(body, "plain"))

        with open(file_path, "rb") as attachment:
            part = MIMEBase("application", "octet-stream")
            part.set_payload(attachment.read())
            encoders.encode_base64(part)
            part.add_header(
                "Content-Disposition",
                f"attachment; filename={os.path.basename(file_path)}",
            )
            msg.attach(part)

        with smtplib.SMTP_SSL("smtp.gmail.com", 465) as server:
            server.login(sender_email, sender_password)
            server.send_message(msg)

    # Clean up temp file
    if os.path.exists(file_path):
        os.remove(file_path)

    return {"data": input_df}

Krok 3: Testování funkce

Otestujte funkci pomocí ukázkového datového rámce:

test_df = spark.createDataFrame(
    [("Alice", 100), ("Bob", 200)],
    ["name", "amount"]
)

# Test in preview mode (no email sent)
result = run(
    config={
        "is_preview": True,
        "sender_email": "you@gmail.com",
        "secret_scope": "my_email_scope",
        "secret_key": "gmail_app_password",
        "recipients": "alice@example.com",
        "subject": "Test",
        "body": "Test body"
    },
    inputs={"data": test_df},
    spark=spark
)

result["data"].show()
# Expected: the original DataFrame, unchanged

Note

Hodnoty secret_scope a secret_key v konfiguraci jsou názvy oblasti tajných klíčů a klíče, které jste vytvořili v kroku 1, nikoli skutečné heslo. Operátor tyto názvy používá k načtení hesla z Azure Databricks tajných kódů za běhu.

Important

Nejprve otestujte is_preview nastavené na True, abyste ověřili chování při předávání, aniž by se odeslal jakýkoli e-mail. Až budete připraveni otestovat skutečný e-mail, nastavte is_preview na False.

Krok 4: Sestavení definice YAML

Vytvořte soubor volaný gmail_email_sender.yaml s následujícím obsahem:

schema: user-defined-operator-v0.1.0
id: gmail_email_sender
type: python-run-function
version: '1.0.0'
name: Gmail Email Sender
description: Sends the input DataFrame as a CSV attachment via Gmail SMTP to one or more recipients.

config:
  type: object
  properties:
    is_preview:
      type: boolean
      format: is_preview
      default: false
    sender_email:
      type: string
      title: Sender Email
      default: ''
      examples:
        - 'you@gmail.com'
      x-ui:
        widget: input
    secret_scope:
      type: string
      title: Secret Scope
      default: ''
      examples:
        - 'my_email_scope'
      x-ui:
        widget: input
    secret_key:
      type: string
      title: Secret Key
      default: ''
      examples:
        - 'gmail_app_password'
      x-ui:
        widget: input
    recipients:
      type: string
      title: Recipients
      default: ''
      examples:
        - 'alice@example.com, bob@example.com'
      x-ui:
        widget: textarea
        rows: 2
    subject:
      type: string
      title: Subject
      default: ''
      examples:
        - 'Designer Output Data'
      x-ui:
        widget: input
    body:
      type: string
      title: Email Body
      default: "Hello,\n\nAttached is the latest data.\n\nBest,\nDatabricks Workflow"
      x-ui:
        widget: textarea
        rows: 6
  required:
    - sender_email
    - secret_scope
    - secret_key
    - recipients
    - subject
  additionalProperties: false

ports:
  input:
    - name: data
      title: Input Data
      mime: application/vnd.databricks.dataframe
  output:
    - name: data
      title: Output Data
      mime: application/vnd.databricks.dataframe

run_function:
  type: inline
  code: |
    from typing import Dict, Any

    def run(config: Dict[str, Any], inputs: Dict[str, Any], spark) -> Dict[str, Any]:
        input_df = inputs["data"]

        if config.get("is_preview", False):
            return {"data": input_df}

        import smtplib
        import os
        from email.mime.multipart import MIMEMultipart
        from email.mime.text import MIMEText
        from email.mime.base import MIMEBase
        from email import encoders

        sender_email = config.get("sender_email", "")
        secret_scope = config.get("secret_scope", "")
        secret_key = config.get("secret_key", "")
        recipients_raw = config.get("recipients", "")
        subject = config.get("subject", "")
        body = config.get("body", "")

        if not sender_email:
            raise ValueError("Sender Email is required.")
        if not secret_scope or not secret_key:
            raise ValueError("Secret Scope and Secret Key are required.")
        if not recipients_raw:
            raise ValueError("At least one recipient is required.")

        recipients = [r.strip() for r in recipients_raw.split(",") if r.strip()]
        if not recipients:
            raise ValueError("At least one valid recipient email is required.")

        from pyspark.dbutils import DBUtils
        dbutils = DBUtils(spark)
        sender_password = dbutils.secrets.get(scope=secret_scope, key=secret_key)

        pdf = input_df.toPandas()
        file_path = "/tmp/designer_email_attachment.csv"
        pdf.to_csv(file_path, index=False)

        for recipient in recipients:
            msg = MIMEMultipart()
            msg["From"] = sender_email
            msg["To"] = recipient
            msg["Subject"] = subject
            msg.attach(MIMEText(body, "plain"))

            with open(file_path, "rb") as attachment:
                part = MIMEBase("application", "octet-stream")
                part.set_payload(attachment.read())
                encoders.encode_base64(part)
                part.add_header(
                    "Content-Disposition",
                    f"attachment; filename={os.path.basename(file_path)}",
                )
                msg.attach(part)

            with smtplib.SMTP_SSL("smtp.gmail.com", 465) as server:
                server.login(sender_email, sender_password)
                server.send_message(msg)

        if os.path.exists(file_path):
            os.remove(file_path)

        return {"data": input_df}

Krok 5: Uložení a registrace operátoru

Uložte soubor YAML do pracovního prostoru Azure Databricks. Příklad:
```
/Workspace/Users/<user-name>/gmail_email_sender.yaml
```

Přidejte operátor do souboru .user_defined_operators.yaml:

operators:
  - /Workspace/Users/<user-name>/gmail_email_sender.yaml

Další informace o možnostech registrace najdete v tématu Zviditelnění vašeho operátora.

Povolení

Uživatelé, kteří spouštějí pracovní postup obsahující tento operátor, potřebují READ přístup k oboru tajných kódů nebo mohou v konfiguraci operátoru zadat vlastní obor tajných kódů a hodnoty klíčů. Uživatelé také potřebují přístup pro čtení k souboru YAML v pracovním prostoru.

Udělení přístupu k oboru tajného kódu:

databricks secrets put-acl my_email_scope <user-or-group> READ

Použití operátoru v nástroji Lakeflow Designer

Po registraci se operátor zobrazí v Návrháři Lakeflow se vstupním portem pro váš zdroj dat a konfigurační pole pro e-mail odesílatele, rozsah tajných kódů, tajný klíč, příjemce, předmět a text.

Když se pracovní postup spustí, operátor převede vstupní datový rámec na CSV, připojí ho k e-mailu a pošle ho každému příjemci. DataFrame prochází beze změny na výstupní port, takže za něj můžete řetězit další navazující operátory. Během náhledu pracovního postupu se neposílají žádné e-maily.

Váš názor

Byla tato stránka užitečná?

Last updated on 2026-06-24