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)[源代码]

基类: 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')[源代码]
poke(context)[源代码]

轮询邮件服务器上的邮件附件。

参数

context (airflow.utils.context.Context) – 轮询时提供的上下文。

返回

如果存在具有给定名称的附件,则为 True;否则为 False。

返回类型

bool

此条目是否有帮助?