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