Search.setIndex({"docnames": ["_api/airflow/providers/imap/hooks/imap/index", "_api/airflow/providers/imap/hooks/index", "_api/airflow/providers/imap/index", "_api/airflow/providers/imap/sensors/imap_attachment/index", "_api/airflow/providers/imap/sensors/index", "commits", "connections/imap", "index", "installing-providers-from-sources"], "filenames": ["_api/airflow/providers/imap/hooks/imap/index.rst", "_api/airflow/providers/imap/hooks/index.rst", "_api/airflow/providers/imap/index.rst", "_api/airflow/providers/imap/sensors/imap_attachment/index.rst", "_api/airflow/providers/imap/sensors/index.rst", "commits.rst", "connections/imap.rst", "index.rst", "installing-providers-from-sources.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.hooks.imap</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.hooks</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.sensors.imap_attachment</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.sensors</span></code>", "Package apache-airflow-providers-imap", "IMAP Connection", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-imap</span></code>", "Installing from sources"], "terms": {"thi": [0, 1, 2, 3, 4, 5, 6, 7, 8], "everyth": 0, "abl": 0, "search": [0, 3], "mail": [0, 3], "specif": [0, 3, 5], "attach": [0, 3], "also": [0, 6, 8], "download": [0, 8], "It": [0, 8], "us": [0, 5, 6, 8], "imaplib": [0, 3], "librari": 0, "i": [0, 1, 2, 3, 4, 5, 6, 7, 8], "alreadi": [0, 8], "integr": [0, 5, 6], "python": [0, 5, 7, 8], "3": [0, 1, 2, 3, 4, 6, 8], "imaphook": [0, 5], "imap_conn_id": [0, 3], "default_conn_nam": 0, "sourc": [0, 3, 7], "base": [0, 3], "basehook": 0, "connect": [0, 3, 5, 7], "server": [0, 3, 8], "protocol": [0, 5, 7], "pleas": [0, 8], "call": [0, 5], "context": [0, 3, 5], "manag": [0, 5, 8], "via": [0, 6, 7, 8], "automat": [0, 7], "open": 0, "close": 0, "paramet": [0, 3, 6], "str": [0, 3], "The": [0, 3, 6, 8], "id": [0, 3, 8], "contain": [0, 8], "inform": [0, 5], "authent": 0, "client": [0, 6], "conn_name_attr": 0, "imap_default": [0, 3, 6], "conn_typ": 0, "hook_nam": 0, "__enter__": 0, "__exit__": 0, "exc_typ": 0, "exc_val": 0, "exc_tb": 0, "get_conn": 0, "login": [0, 6], "return": [0, 3], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8], "author": 0, "object": 0, "type": [0, 3, 5, 6, 7], "has_mail_attach": 0, "name": [0, 3, 5], "check_regex": [0, 3], "fals": [0, 3, 6], "mail_fold": [0, 3], "inbox": [0, 3], "mail_filt": [0, 3], "all": [0, 3, 5, 6, 7], "check": [0, 3, 5, 8], "folder": [0, 3, 8], "given": [0, 3], "bool": [0, 3], "regular": [0, 3], "express": [0, 3, 5], "where": [0, 3], "look": [0, 3], "If": [0, 3, 6, 7, 8], "set": [0, 3, 5, 6, 7], "other": [0, 3], "than": [0, 3], "onli": [0, 3, 7], "see": [0, 3, 5, 7], "imap4": [0, 3], "detail": [0, 3, 5, 7, 8], "true": [0, 3, 6], "retrieve_mail_attach": 0, "latest_onli": 0, "not_found_mod": 0, "rais": 0, "retriev": 0, "": [0, 3, 5, 8], "its": 0, "first": [0, 7], "match": [0, 5, 8], "specifi": [0, 6], "what": 0, "should": [0, 6, 8], "happen": 0, "ha": 0, "been": 0, "found": 0, "support": [0, 5, 7], "valu": 0, "ar": [0, 7, 8], "warn": [0, 5, 8], "ignor": 0, "except": 0, "print": 0, "won": 0, "t": 0, "notifi": 0, "you": [0, 3, 6, 7, 8], "list": [0, 5, 7], "tupl": 0, "each": 0, "filenam": 0, "payload": 0, "download_mail_attach": 0, "local_output_directori": 0, "local": [0, 8], "directori": [0, 8], "output": 0, "machin": 0, "file": [0, 5, 7, 8], "mail_bodi": 0, "util": [0, 3], "log": 0, "logging_mixin": 0, "loggingmixin": 0, "simplifi": [0, 5], "work": 0, "bodi": 0, "receiv": 0, "from": [0, 5, 7], "has_attach": 0, "get_attachments_by_nam": 0, "find_first": 0, "get": [0, 3, 8], "find": 0, "quit": 0, "mailpart": 0, "part": 0, "wrapper": 0, "give": 0, "more": [0, 5], "featur": [0, 1, 2, 3, 4, 5, 6, 8], "ani": [0, 8], "is_attach": 0, "valid": [0, 8], "has_matching_nam": 0, "includ": [0, 5], "has_equal_nam": 0, "equal": [0, 3], "get_fil": 0, "0": [0, 1, 2, 3, 4, 6, 8], "2": [0, 1, 2, 3, 4, 6, 8], "4": [0, 1, 2, 3, 4, 5, 6, 7, 8], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8], "hook": [2, 5, 6], "sensor": [2, 5, 6], "imap_attach": [2, 4], "allow": [3, 5, 7], "poke": 3, "imapattachmentsensor": 3, "attachment_nam": 3, "conn_id": 3, "kwarg": 3, "basesensoroper": 3, "wait": 3, "pars": 3, "through": 3, "can": [3, 6, 7, 8], "broader": 3, "just": 3, "run": [3, 7, 8], "against": 3, "template_field": [3, 5], "sequenc": [3, 5], "being": [3, 6], "when": [3, 6], "present": 3, "internet": [5, 7], "messag": [5, 7], "access": [5, 7], "commit": 5, "chang": [5, 6], "version": [5, 7, 8], "For": [5, 6, 8], "high": 5, "level": 5, "changelog": 5, "latest": 5, "2022": 5, "06": 5, "07": 5, "subject": 5, "717a7588bc": 5, "updat": [5, 7], "descript": 5, "remov": [5, 7, 8], "doubl": 5, "min": 5, "24292": 5, "aeabe994b3": 5, "prepar": 5, "doc": 5, "mai": 5, "releas": [5, 7], "24231": 5, "027b707d21": 5, "05": 5, "add": [5, 7], "explanatori": 5, "note": [5, 6], "contributor": 5, "about": [5, 8], "24229": 5, "03": 5, "22": 5, "d7dbfb7e26": 5, "document": [5, 7], "bugfix": 5, "22383": 5, "14": 5, "16adc035b1": 5, "classifi": [5, 7], "march": 5, "22226": 5, "f5b96315fe": 5, "feb": 5, "22056": 5, "02": 5, "08": 5, "d94fa37830": 5, "fix": 5, "januari": 5, "delai": 5, "21439": 5, "6c3a67d4fc": 5, "2021": [5, 8], "21257": 5, "602abe8394": 5, "01": 5, "20": 5, "line": 5, "now": 5, "sphinx": 5, "autoapi": 5, "typehint": 5, "20951": 5, "032cf7cdbc": 5, "mypi": 5, "issu": 5, "insid": 5, "20968": 5, "25a5f553c3": 5, "12": [5, 8], "use_ssl": [5, 6, 7], "option": [5, 6, 7], "20441": [5, 7], "4fa9cfd7d": 5, "grpc": 5, "20651": 5, "31": 5, "f77417eb0d": 5, "k8": 5, "pypi": [5, 7], "compat": 5, "20614": 5, "97496ba2b4": 5, "decemb": 5, "20523": 5, "d56e7b56bb": 5, "30": 5, "have": [5, 7], "friendli": 5, "20571": 5, "a0821235fb": 5, "everywher": 5, "20565": 5, "ee87953652": 5, "21": 5, "port": [5, 6, 7], "20440": [5, 7], "0a68588479": 5, "august": 5, "17890": 5, "be75dcd39c": 5, "23": 5, "new": 5, "meta": 5, "data": 5, "76ed2a49c6": 5, "19": 5, "import": [5, 7, 8], "lazili": 5, "individu": 5, "17682": 5, "18": 5, "bbc627a3da": 5, "rc2": 5, "16501": 5, "cbf8001d76": 5, "16": 5, "synchron": 5, "after": 5, "buggfix": 5, "16464": 5, "1fba5402bb": 5, "15": 5, "june": 5, "16405": 5, "9c94b72d44": 5, "16294": 5, "37681bca00": 5, "auto": [5, 7], "appli": [5, 7], "apply_default": [5, 7], "decor": [5, 7], "15667": [5, 7], "807ad32ce5": 5, "pip": [5, 7, 8], "15576": 5, "5b2fe0e740": 5, "04": 5, "27": 5, "popular": 5, "15393": 5, "6f8ab9e6da": 5, "python2": 5, "relat": [5, 6], "handl": 5, "depend": [5, 6], "15301": 5, "68e4c4dcb0": 5, "backport": 5, "14886": 5, "6e6526a0f6": 5, "13": 5, "broken": 5, "14734": 5, "88bdcfa0df": 5, "wave": 5, "14013": 5, "ac2f72c98d": 5, "implement": 5, "tool": 5, "13767": 5, "3fd5ef3555": 5, "miss": 5, "logo": 5, "13717": 5, "295d66f914": 5, "2020": 5, "grammar": 5, "13380": 5, "6cf76d7ac0": 5, "typo": 5, "upgrad": [5, 7], "command": 5, "13148": 5, "09": 5, "32971a1a2d": 5, "12955": 5, "b40dffa085": 5, "renam": 5, "rema": 5, "modul": 5, "aip": 5, "12917": 5, "9b39f24780": 5, "dynam": 5, "form": 5, "field": [5, 6], "per": 5, "12558": 5, "2037303eef": 5, "11": [5, 8], "29": 5, "discoveri": 5, "12466": 5, "c34ef853c8": 5, "separ": 5, "out": 5, "build": [5, 8], "12444": 5, "0080354502": 5, "readm": [5, 7], "0b2": 5, "batch": 5, "12449": 5, "ae7cb4a1e2": 5, "17": 5, "wrong": 5, "hash": 5, "12390": 5, "6889a333cf": 5, "improv": 5, "oper": [5, 6], "ref": 5, "12366": 5, "7825e8f590": 5, "instal": 5, "12304": 5, "85a18e13d9": 5, "point": 5, "project": 5, "page": [5, 8], "cross": 5, "12212": 5, "59eb5de78c": 5, "up": 5, "come": 5, "0beta1": 5, "12206": 5, "b2a28d1590": 5, "move": 5, "script": [5, 8], "dev": 5, "12082": 5, "41bf172c1d": 5, "string": 5, "12093": 5, "4e8f9cc8d0": 5, "enabl": [5, 6], "black": 5, "formmatt": 5, "9550": 5, "5a439e84eb": 5, "10": [5, 7], "26": 5, "2a1": 5, "11855": 5, "872b1566a1": 5, "25": 5, "gener": 5, "setup": 5, "11826": 5, "349b0811c3": 5, "d200": 5, "pydocstyl": 5, "11688": 5, "16e7129719": 5, "ad": [5, 7], "11487": 5, "0a0e1af800": 5, "markdown": 5, "link": [5, 8], "toc": 5, "11249": 5, "ca4238eb4d": 5, "month": 5, "octob": 5, "11242": 5, "5220e4c384": 5, "11238": 5, "08dfd8cd00": 5, "increas": 5, "coverag": 5, "11154": 5, "f3e87c5030": 5, "d202": 5, "11032": 5, "fdd9b6f65b": 5, "10543": 5, "3696c34c28": 5, "24": 5, "word": 5, "10528": 5, "ee7ca128a1": 5, "refernc": 5, "10483": 5, "cdec301254": 5, "correct": [5, 8], "signatur": [5, 8], "10205": 5, "24c8e4c2d6": 5, "constructor": 5, "arg": 5, "argument": 5, "10163": 5, "0aff69fbd2": 5, "9887": 5, "d0e7db4024": 5, "number": 5, "fresh": 5, "9408": 5, "12af6a0800": 5, "final": 5, "cleanup": 5, "6": 5, "23rc1": 5, "9404": 5, "c7e5bce57f": 5, "candid": 5, "9370": 5, "f6bd817a3a": 5, "introduc": 5, "transfer": 5, "9320": 5, "0b0e4f7a4c": 5, "rc3": 5, "relas": 5, "9026": 5, "00642a46d0": 5, "remain": 5, "wrongli": 5, "8994": 5, "1d36b0303b": 5, "refer": 5, "8984": 5, "375d1ca229": 5, "8898": 5, "12c5e5d8a": 5, "8891": 5, "f3521fb0e3": 5, "regener": 5, "8886": 5, "92585ca4cb": 5, "autom": 5, "8807": 5, "05443c6dc8": 5, "super": 5, "class": [5, 7], "7828": 5, "4d03e33c11": 5, "6817": 5, "__init__": 5, "py": 5, "replac": 5, "implicit": 5, "explicit": 5, "entri": 5, "md": [5, 7], "squash": 5, "rebas": 5, "7456": 5, "97a429f9d0": 5, "6714": 5, "magic": 5, "comment": 5, "utf": 5, "8": 5, "7338": 5, "cf141506a2": 5, "6708": 5, "uniqu": 5, "logger": 5, "7330": 5, "9a04013b0": 5, "6646": 5, "7268": 5, "password": 6, "standard": 6, "usernam": 6, "host": 6, "url": 6, "whether": 6, "ssl": 6, "extra": 6, "json": 6, "dictionari": 6, "non": 6, "influenc": 6, "environ": 6, "variabl": 6, "uri": 6, "syntax": 6, "compon": 6, "encod": 6, "exampl": [6, 8], "export": 6, "airflow_conn_imap_default": 6, "myimap": 6, "com": [6, 7, 8], "993": 6, "anoth": 6, "airflow_conn_imap_nonssl": 6, "143": 6, "regardless": 6, "choos": [6, 8], "abov": [6, 8], "show": 6, "api": 7, "repositori": 7, "top": [7, 8], "exist": 7, "requir": 7, "below": [7, 8], "minimum": 7, "avail": [7, 8], "explain": 7, "polici": 7, "http": [7, 8], "github": 7, "blob": 7, "main": [7, 8], "mistakenli": 7, "install_requir": 7, "22382": 7, "trove": 7, "framework": 7, "optimis": 7, "due": 7, "your": 7, "want": [7, 8], "least": 7, "otherwis": 7, "manual": 7, "db": 7, "complet": 7, "migrat": 7, "initi": 7, "describ": 8, "apach": 8, "airflow": 8, "provid": 8, "imap": 8, "offici": 8, "most": 8, "differ": 8, "select": 8, "drop": 8, "down": 8, "left": 8, "sdist": 8, "whl": 8, "origin": 8, "checksum": 8, "softwar": 8, "foundat": 8, "asc": 8, "sha512": 8, "those": 8, "code": 8, "how": 8, "pgp": 8, "kei": 8, "essenti": 8, "sha": 8, "gpg": 8, "well": 8, "relev": 8, "distribut": 8, "recommend": 8, "mirror": 8, "pgpk": 8, "ka": 8, "To": 8, "binari": 8, "follow": 8, "guid": 8, "pgpv": 8, "tar": 8, "gz": 8, "made": 8, "sat": 8, "sep": 8, "49": 8, "54": 8, "bst": 8, "rsa": 8, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 8, "issuer": 8, "kaxilnaik": 8, "org": 8, "good": 8, "kaxil": 8, "naik": 8, "unknown": 8, "aka": 8, "gmail": 8, "user": 8, "certifi": 8, "trust": 8, "There": 8, "indic": 8, "belong": 8, "owner": 8, "primari": 8, "fingerprint": 8, "cde1": 8, "5c6e": 8, "4d3a": 8, "8ec4": 8, "ecf4": 8, "ba4b": 8, "6674": 8, "e08a": 8, "d7de": 8, "406f": 8, "do": 8, "worri": 8, "certif": 8, "self": 8, "sign": 8, "why": 8, "By": 8, "previou": 8, "step": 8, "know": 8, "sum": 8, "shasum": 8, "512": 8, "diff": 8, "one": 8, "bin": 8, "bash": 8, "package_vers": 8, "package_nam": 8, "provider_download_dir": 8, "mktemp": 8, "d": 8, "dep": 8, "dest": 8, "curl": 8, "apache_airflow_providers_imap": 8, "py3": 8, "none": 8, "l": 8, "o": 8, "echo": 8, "la": 8, "onc": 8, "instruct": 8, "chapter": 8, "temporari": 8, "creat": 8}, "objects": {"airflow.providers": [[2, 0, 0, "-", "imap"]], "airflow.providers.imap": [[1, 0, 0, "-", "hooks"], [4, 0, 0, "-", "sensors"]], "airflow.providers.imap.hooks": [[0, 0, 0, "-", "imap"]], "airflow.providers.imap.hooks.imap": [[0, 1, 1, "", "ImapHook"], [0, 1, 1, "", "Mail"], [0, 1, 1, "", "MailPart"]], "airflow.providers.imap.hooks.imap.ImapHook": [[0, 2, 1, "", "__enter__"], [0, 2, 1, "", "__exit__"], [0, 3, 1, "", "conn_name_attr"], [0, 3, 1, "", "conn_type"], [0, 3, 1, "", "default_conn_name"], [0, 2, 1, "", "download_mail_attachments"], [0, 2, 1, "", "get_conn"], [0, 2, 1, "", "has_mail_attachment"], [0, 3, 1, "", "hook_name"], [0, 2, 1, "", "retrieve_mail_attachments"]], "airflow.providers.imap.hooks.imap.Mail": [[0, 2, 1, "", "get_attachments_by_name"], [0, 2, 1, "", "has_attachments"]], "airflow.providers.imap.hooks.imap.MailPart": [[0, 2, 1, "", "get_file"], [0, 2, 1, "", "has_equal_name"], [0, 2, 1, "", "has_matching_name"], [0, 2, 1, "", "is_attachment"]], "airflow.providers.imap.sensors": [[3, 0, 0, "-", "imap_attachment"]], "airflow.providers.imap.sensors.imap_attachment": [[3, 1, 1, "", "ImapAttachmentSensor"]], "airflow.providers.imap.sensors.imap_attachment.ImapAttachmentSensor": [[3, 2, 1, "", "poke"], [3, 3, 1, "", "template_fields"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"airflow": [0, 1, 2, 3, 4, 5, 7], "provid": [0, 1, 2, 3, 4, 5, 7], "imap": [0, 1, 2, 3, 4, 5, 6, 7], "hook": [0, 1], "modul": [0, 3], "content": [0, 3, 7], "class": [0, 3], "submodul": [1, 4], "subpackag": 2, "sensor": [3, 4], "imap_attach": 3, "packag": [5, 7, 8], "apach": [5, 7], "3": [5, 7], "0": [5, 7], "2": [5, 7], "1": [5, 7], "connect": 6, "authent": 6, "default": 6, "id": 6, "configur": 6, "refer": 7, "resourc": 7, "commit": 7, "instal": [7, 8], "changelog": 7, "break": 7, "chang": 7, "bug": 7, "fix": 7, "misc": 7, "featur": 7, "from": 8, "sourc": 8, "releas": 8, "integr": 8, "verifi": 8, "pypi": 8}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 56}})