#IMAP

server:
  description: IMAP 服务器名称
username:
  description: IMAP 用户名
search:
  description: IMAP 搜索配置
folder:
  description: IMAP 文件夹配置
text:
  description: 邮件正文的 `text` 内容。默认仅提供正文前 2048 字节，其余部分会被截断。你可以增大正文文本的最大长度，但不建议这样做，也无法保证能拿到完整正文。更好的做法是使用自定义事件数据模板（高级设置）解析整封邮件，这种方式不受大小限制。渲染结果会作为 `custom` 属性加入事件数据中，用于自动化。只有在选项流程中显式选择后，`text` 才会被包含。
sender:
  description: 邮件的 `sender`（发件人）
subject:
  description: 邮件的 `subject`（主题）
date:
  description: 邮件发送时间的 `datetime` 对象
headers:
  description: 邮件的 `headers`，以字典形式提供。由于同一个请求头可能出现多次，因此其值可迭代。只有在选项流程中显式选择后，`headers` 才会被包含。
custom:
  description: 保存自定义事件数据[模板](/home-assistant/docs/configuration/templating)的结果。所有属性都可作为模板中的变量使用。
initial:
  description: 如果这是最近一封收到邮件的首次事件，则返回 `True`。当搜索范围内的邮件被删除，而最近收到的那封邮件本身没有变化时，仍会生成一个 `imap_content` 事件，此时 `initial` 为 `False`。注意：如果触发邮件没有 `Message-ID` 头，则 `initial` 始终为 `True`。
parts:
  description: 返回一个字典，列出多部分邮件中可用的各个部分。字典键可通过 `part` 选项传给 `fetch` 动作，以获取邮件指定部分的内容。
uid:
  description: 邮件最新的 `uid`。

template:
  - trigger:
      - trigger: event
        event_type: "imap_content"
        id: "custom_event"
    sensor:
      - name: imap_content
        state: "{{ trigger.event.data['subject'] }}"
        attributes:
          Entry: "{{ trigger.event.data['entry_id'] }}"
          UID: "{{ trigger.event.data['uid'] }}"
          Message: "{{ trigger.event.data['text'] }}"
          Server: "{{ trigger.event.data['server'] }}"
          Username: "{{ trigger.event.data['username'] }}"
          Search: "{{ trigger.event.data['search'] }}"
          Folder: "{{ trigger.event.data['folder'] }}"
          Sender: "{{ trigger.event.data['sender'] }}"
          Date: "{{ trigger.event.data['date'] }}"
          Subject: "{{ trigger.event.data['subject'] }}"
          Initial: "{{ trigger.event.data['initial'] }}"
          To: "{{ trigger.event.data['headers'].get('Delivered-To', ['n/a'])[0] }}"
          Return-Path: "{{ trigger.event.data['headers'].get('Return-Path',['n/a'])[0] }}"
          Received-first: "{{ trigger.event.data['headers'].get('Received',['n/a'])[0] }}"
          Received-last: "{{ trigger.event.data['headers'].get('Received',['n/a'])[-1] }}"

text:
  description: 获取到的邮件纯文本内容。
subject:
  description: 获取到的邮件主题。
sender:
  description: 获取到的邮件发件人地址。
uid:
  description: 邮件的 UID。
parts:
  description: 在多部分邮件场景下，包含一个字典，列出邮件中各可用部分的元数据。这样可进一步获取并处理完整文本部分，不受大小限制。
  type: map
  keys:
    content_type:
      description: 邮件部分的 MIME 内容类型，例如 `image/jpeg`
    content_transfer_encoding:
      description: 返回的邮件部分所使用的编码。
    filename:
      description: 邮件部分的文件名；仅在该信息存在时可用。

part_data:
  description: 获取到的邮件部分编码数据。
content_type:
  description: 邮件部分的 MIME 内容类型，例如 `image/jpeg`。
content_transfer_encoding:
  description: `part_data` 中数据的编码方式。
file_name:
  description: 邮件部分的文件名；若该部分是附件则通常会有此值，未设置时为 `null`。
uid:
  description: 邮件的 UID。
part:
  description: 部分索引。

alias: "imap fetch and seen example"
description: "Fetch and mark an incoming message as seen"
triggers:
  - trigger: event
    event_type: imap_content
    event_data:
      entry_id: 91fadb3617c5a3ea692aeb62d92aa869
conditions:
  - condition: template
    value_template: "{{ trigger.event.data['sender'] == 'info@example.com' }}"
actions:
  - action: imap.fetch
    data:
      entry: 91fadb3617c5a3ea692aeb62d92aa869
      uid: "{{ trigger.event.data['uid'] }}"
    response_variable: message_text
  - action: imap.seen
    data:
      entry: 91fadb3617c5a3ea692aeb62d92aa869
      uid: "{{ trigger.event.data['uid'] }}"
  - action: persistent_notification.create
    data:
      message: "{{ message_text['subject'] }}"

alias: "imap fetch and seen example"
description: "Fetch and mark an incoming message as seen"
triggers:
  - trigger: event
    event_type: imap_content
    event_data:
      entry_id: 91fadb3617c5a3ea692aeb62d92aa869
conditions:
  - condition: template
    value_template: "{{ trigger.event.data['sender'] == 'info@example.com' }}"
  - condition: template
    value_template: "{{ trigger.event.data['parts'].get('1') }}"
  - condition: template
    value_template: "{{ trigger.event.data['parts']['1'].get('content_type') == 'text/plain' }}"
actions:
  - action: imap.fetch_part
    data:
      entry: 91fadb3617c5a3ea692aeb62d92aa869
      uid: "{{ trigger.event.data['uid'] }}"
      part: "1"
    response_variable: message_text
  - action: imap.seen
    data:
      entry: 91fadb3617c5a3ea692aeb62d92aa869
      uid: "{{ trigger.event.data['uid'] }}"
  - action: persistent_notification.create
    data:
      message: "{{ message_text['part_data'] | base64_decode }}"

template:
  - trigger:
      - trigger: event
        event_type: "imap_content"
        id: "custom_event"
        event_data:
          sender: "no-reply@smartconnect.apc.com"
          initial: true
    sensor:
      - name: house_electricity
        state: >-
          {% if 'UPS On Battery' in trigger.event.data["subject"] %}
            power_out
          {% elif 'Power Restored' in trigger.event.data["subject"] %}
            power_on
          {% endif %}

template:
  - trigger:
      - trigger: event
        event_type: "imap_content"
        id: "custom_event"
        event_data:
          sender: "no-reply@smartconnect.apc.com"
    sensor:
      - name: "Previous Day Energy Use"
        unit_of_measurement: "kWh"
        state: >
        {{ trigger.event.data["text"]
          | regex_findall_index("\*Yesterday's Energy Use:\* ([0-9]+) kWh") }}
      - name: "Previous Day Cost"
        unit_of_measurement: "$"
        state: >
          {{ trigger.event.data["text"]
            | regex_findall_index("\*Yesterday's estimated energy cost:\* \$([0-9.]+)") }}
      - name: "Billing Cycle Total"
        unit_of_measurement: "$"
        state: >
          {{ trigger.event.data["text"]
            | regex_findall_index("\ days:\* \$([0-9.]+)") }}

template:
  - trigger:
      - trigger: event
        event_type: "imap_content"
        id: "custom_event"
        event_data:
          custom: True
    sensor:
      - name: event filtered by template
        state: '{{ trigger.event.data["subject"] }}'