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]
attachment_name[source]
check_regex = False[source]
mail_folder = 'INBOX'[source]
mail_filter = 'All'[source]
conn_id = 'imap_default'[source]
poke(context)[source]

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

引數:

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

返回:

如果存在具有給定名稱的附件則返回 True,否則返回 False。

返回型別:

bool

此條目有幫助嗎?