airflow.providers.imap.sensors.imap_attachment

此模組讓您可以輪詢郵件伺服器上的附件。

模組內容

類別

ImapAttachmentSensor

等待郵件伺服器上的特定附件。

class airflow.providers.imap.sensors.imap_attachment.ImapAttachmentSensor(*, attachment_name, check_regex=False, mail_folder='INBOX', mail_filter='All', conn_id='imap_default', **kwargs)[source]

基底類別: airflow.sensors.base.BaseSensorOperator

等待郵件伺服器上的特定附件。

參數
  • attachment_name – 將被檢查的附件名稱。

  • check_regex – 若設定為 True,附件名稱將被解析為正規表示式。透過此設定,您可以取得比僅比對附件名稱相等性更廣泛的附件搜尋範圍。

  • mail_folder – 搜尋附件的郵件資料夾。

  • mail_filter – 若設定為非 ‘All’,則僅會檢查特定的郵件。詳情請參閱 imaplib.IMAP4.search()

  • imap_conn_id – 執行感測器的 imap 連線 ID

template_fields: collections.abc.Sequence[str] = ('attachment_name', 'mail_filter')[source]
poke(context)[source]

輪詢郵件伺服器上的郵件附件。

參數

context (airflow.utils.context.Context) – 輪詢時提供的上下文。

返回

若具有指定名稱的附件存在則返回 True,否則返回 False。

返回類型

bool

此條目是否有幫助?