| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.contrib.hooks.imap_hook — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| <script type="text/javascript" src="../../../../_static/jira-links.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/exampleinclude.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| |
| <script> |
| </script> |
| <style> |
| |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.8 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../executor/index.html">Executor</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../errors.html">Error Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../dag-serialization.html">DAG Serialization</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../best-practices.html">Best Practices</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../configurations-ref.html">Configurations</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.imap_hook</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.hooks.imap_hook</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| |
| <span class="kn">import</span> <span class="nn">email</span> |
| <span class="kn">import</span> <span class="nn">imaplib</span> |
| <span class="kn">import</span> <span class="nn">os.path</span> |
| <span class="kn">import</span> <span class="nn">re</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="kn">import</span> <span class="n">LoggingMixin</span><span class="p">,</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="kn">import</span> <span class="n">BaseHook</span> |
| |
| |
| <div class="viewcode-block" id="ImapHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook">[docs]</a><span class="k">class</span> <span class="nc">ImapHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> This hook connects to a mail server by using the imap protocol.</span> |
| |
| <span class="sd"> :param imap_conn_id: The connection id that contains the information used to authenticate the client.</span> |
| <span class="sd"> :type imap_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">imap_conn_id</span><span class="o">=</span><span class="s1">'imap_default'</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">ImapHook</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">imap_conn_id</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="n">imap_conn_id</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span> <span class="o">=</span> <span class="n">imaplib</span><span class="o">.</span><span class="n">IMAP4_SSL</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="ImapHook.__enter__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook.__enter__">[docs]</a> <span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">login</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span></div> |
| |
| <div class="viewcode-block" id="ImapHook.__exit__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook.__exit__">[docs]</a> <span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span><span class="o">.</span><span class="n">logout</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="ImapHook.has_mail_attachment"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook.has_mail_attachment">[docs]</a> <span class="k">def</span> <span class="nf">has_mail_attachment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">mail_folder</span><span class="o">=</span><span class="s1">'INBOX'</span><span class="p">,</span> <span class="n">check_regex</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Checks the mail folder for mails containing attachments with the given name.</span> |
| |
| <span class="sd"> :param name: The name of the attachment that will be searched for.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param mail_folder: The mail folder where to look at.</span> |
| <span class="sd"> :type mail_folder: str</span> |
| <span class="sd"> :param check_regex: Checks the name for a regular expression.</span> |
| <span class="sd"> :type check_regex: bool</span> |
| <span class="sd"> :returns: True if there is an attachment with the given name and False if not.</span> |
| <span class="sd"> :rtype: bool</span> |
| <span class="sd"> """</span> |
| <span class="n">mail_attachments</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieve_mails_attachments_by_name</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">mail_folder</span><span class="p">,</span> |
| <span class="n">check_regex</span><span class="p">,</span> |
| <span class="n">latest_only</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">mail_attachments</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span></div> |
| |
| <div class="viewcode-block" id="ImapHook.retrieve_mail_attachments"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook.retrieve_mail_attachments">[docs]</a> <span class="k">def</span> <span class="nf">retrieve_mail_attachments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">name</span><span class="p">,</span> |
| <span class="n">mail_folder</span><span class="o">=</span><span class="s1">'INBOX'</span><span class="p">,</span> |
| <span class="n">check_regex</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">latest_only</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">not_found_mode</span><span class="o">=</span><span class="s1">'raise'</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieves mail's attachments in the mail folder by its name.</span> |
| |
| <span class="sd"> :param name: The name of the attachment that will be downloaded.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param mail_folder: The mail folder where to look at.</span> |
| <span class="sd"> :type mail_folder: str</span> |
| <span class="sd"> :param check_regex: Checks the name for a regular expression.</span> |
| <span class="sd"> :type check_regex: bool</span> |
| <span class="sd"> :param latest_only: If set to True it will only retrieve</span> |
| <span class="sd"> the first matched attachment.</span> |
| <span class="sd"> :type latest_only: bool</span> |
| <span class="sd"> :param not_found_mode: Specify what should happen if no attachment has been found.</span> |
| <span class="sd"> Supported values are 'raise', 'warn' and 'ignore'.</span> |
| <span class="sd"> If it is set to 'raise' it will raise an exception,</span> |
| <span class="sd"> if set to 'warn' it will only print a warning and</span> |
| <span class="sd"> if set to 'ignore' it won't notify you at all.</span> |
| <span class="sd"> :type not_found_mode: str</span> |
| <span class="sd"> :returns: a list of tuple each containing the attachment filename and its payload.</span> |
| <span class="sd"> :rtype: a list of tuple</span> |
| <span class="sd"> """</span> |
| <span class="n">mail_attachments</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieve_mails_attachments_by_name</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">mail_folder</span><span class="p">,</span> |
| <span class="n">check_regex</span><span class="p">,</span> |
| <span class="n">latest_only</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">mail_attachments</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_handle_not_found_mode</span><span class="p">(</span><span class="n">not_found_mode</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">mail_attachments</span></div> |
| |
| <div class="viewcode-block" id="ImapHook.download_mail_attachments"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook.download_mail_attachments">[docs]</a> <span class="k">def</span> <span class="nf">download_mail_attachments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">name</span><span class="p">,</span> |
| <span class="n">local_output_directory</span><span class="p">,</span> |
| <span class="n">mail_folder</span><span class="o">=</span><span class="s1">'INBOX'</span><span class="p">,</span> |
| <span class="n">check_regex</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">latest_only</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">not_found_mode</span><span class="o">=</span><span class="s1">'raise'</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Downloads mail's attachments in the mail folder by its name to the local directory.</span> |
| |
| <span class="sd"> :param name: The name of the attachment that will be downloaded.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param local_output_directory: The output directory on the local machine</span> |
| <span class="sd"> where the files will be downloaded to.</span> |
| <span class="sd"> :type local_output_directory: str</span> |
| <span class="sd"> :param mail_folder: The mail folder where to look at.</span> |
| <span class="sd"> :type mail_folder: str</span> |
| <span class="sd"> :param check_regex: Checks the name for a regular expression.</span> |
| <span class="sd"> :type check_regex: bool</span> |
| <span class="sd"> :param latest_only: If set to True it will only download</span> |
| <span class="sd"> the first matched attachment.</span> |
| <span class="sd"> :type latest_only: bool</span> |
| <span class="sd"> :param not_found_mode: Specify what should happen if no attachment has been found.</span> |
| <span class="sd"> Supported values are 'raise', 'warn' and 'ignore'.</span> |
| <span class="sd"> If it is set to 'raise' it will raise an exception,</span> |
| <span class="sd"> if set to 'warn' it will only print a warning and</span> |
| <span class="sd"> if set to 'ignore' it won't notify you at all.</span> |
| <span class="sd"> :type not_found_mode: str</span> |
| <span class="sd"> """</span> |
| <span class="n">mail_attachments</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieve_mails_attachments_by_name</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">mail_folder</span><span class="p">,</span> |
| <span class="n">check_regex</span><span class="p">,</span> |
| <span class="n">latest_only</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">mail_attachments</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_handle_not_found_mode</span><span class="p">(</span><span class="n">not_found_mode</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_create_files</span><span class="p">(</span><span class="n">mail_attachments</span><span class="p">,</span> <span class="n">local_output_directory</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._handle_not_found_mode"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._handle_not_found_mode">[docs]</a> <span class="k">def</span> <span class="nf">_handle_not_found_mode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">not_found_mode</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">not_found_mode</span> <span class="o">==</span> <span class="s1">'raise'</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'No mail attachments found!'</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">not_found_mode</span> <span class="o">==</span> <span class="s1">'warn'</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">'No mail attachments found!'</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">not_found_mode</span> <span class="o">==</span> <span class="s1">'ignore'</span><span class="p">:</span> |
| <span class="k">pass</span> <span class="c1"># Do not notify if the attachment has not been found.</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Invalid "not_found_mode" </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">not_found_mode</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._retrieve_mails_attachments_by_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._retrieve_mails_attachments_by_name">[docs]</a> <span class="k">def</span> <span class="nf">_retrieve_mails_attachments_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">mail_folder</span><span class="p">,</span> <span class="n">check_regex</span><span class="p">,</span> <span class="n">latest_only</span><span class="p">):</span> |
| <span class="n">all_matching_attachments</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">mail_folder</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">mail_id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_list_mail_ids_desc</span><span class="p">():</span> |
| <span class="n">response_mail_body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch_mail_body</span><span class="p">(</span><span class="n">mail_id</span><span class="p">)</span> |
| <span class="n">matching_attachments</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_mail_body</span><span class="p">(</span><span class="n">response_mail_body</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">check_regex</span><span class="p">,</span> <span class="n">latest_only</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">matching_attachments</span><span class="p">:</span> |
| <span class="n">all_matching_attachments</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">matching_attachments</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">latest_only</span><span class="p">:</span> |
| <span class="k">break</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| |
| <span class="k">return</span> <span class="n">all_matching_attachments</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._list_mail_ids_desc"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._list_mail_ids_desc">[docs]</a> <span class="k">def</span> <span class="nf">_list_mail_ids_desc</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">result</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">'All'</span><span class="p">)</span> |
| <span class="n">mail_ids</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()</span> |
| <span class="k">return</span> <span class="nb">reversed</span><span class="p">(</span><span class="n">mail_ids</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._fetch_mail_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._fetch_mail_body">[docs]</a> <span class="k">def</span> <span class="nf">_fetch_mail_body</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mail_id</span><span class="p">):</span> |
| <span class="n">result</span><span class="p">,</span> <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mail_client</span><span class="o">.</span><span class="n">fetch</span><span class="p">(</span><span class="n">mail_id</span><span class="p">,</span> <span class="s1">'(RFC822)'</span><span class="p">)</span> |
| <span class="n">mail_body</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="c1"># The mail body is always in this specific location</span> |
| <span class="n">mail_body_str</span> <span class="o">=</span> <span class="n">mail_body</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">mail_body_str</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._check_mail_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._check_mail_body">[docs]</a> <span class="k">def</span> <span class="nf">_check_mail_body</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response_mail_body</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">check_regex</span><span class="p">,</span> <span class="n">latest_only</span><span class="p">):</span> |
| <span class="n">mail</span> <span class="o">=</span> <span class="n">Mail</span><span class="p">(</span><span class="n">response_mail_body</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">mail</span><span class="o">.</span><span class="n">has_attachments</span><span class="p">():</span> |
| <span class="k">return</span> <span class="n">mail</span><span class="o">.</span><span class="n">get_attachments_by_name</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">check_regex</span><span class="p">,</span> <span class="n">find_first</span><span class="o">=</span><span class="n">latest_only</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._create_files"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._create_files">[docs]</a> <span class="k">def</span> <span class="nf">_create_files</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mail_attachments</span><span class="p">,</span> <span class="n">local_output_directory</span><span class="p">):</span> |
| <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">payload</span> <span class="ow">in</span> <span class="n">mail_attachments</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_symlink</span><span class="p">(</span><span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Can not create file because it is a symlink!'</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_escaping_current_directory</span><span class="p">(</span><span class="n">name</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Can not create file because it is escaping the current directory!'</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_create_file</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">payload</span><span class="p">,</span> <span class="n">local_output_directory</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._is_symlink"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._is_symlink">[docs]</a> <span class="k">def</span> <span class="nf">_is_symlink</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="c1"># IMPORTANT NOTE: os.path.islink is not working for windows symlinks</span> |
| <span class="c1"># See: https://stackoverflow.com/a/11068434</span> |
| <span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">islink</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._is_escaping_current_directory"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._is_escaping_current_directory">[docs]</a> <span class="k">def</span> <span class="nf">_is_escaping_current_directory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s1">'../'</span> <span class="ow">in</span> <span class="n">name</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._correct_path"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._correct_path">[docs]</a> <span class="k">def</span> <span class="nf">_correct_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">local_output_directory</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">local_output_directory</span> <span class="o">+</span> <span class="n">name</span> <span class="k">if</span> <span class="n">local_output_directory</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> \ |
| <span class="k">else</span> <span class="n">local_output_directory</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">name</span></div> |
| |
| <div class="viewcode-block" id="ImapHook._create_file"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.ImapHook._create_file">[docs]</a> <span class="k">def</span> <span class="nf">_create_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">payload</span><span class="p">,</span> <span class="n">local_output_directory</span><span class="p">):</span> |
| <span class="n">file_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_correct_path</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">local_output_directory</span><span class="p">)</span> |
| |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span> |
| <span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">payload</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="Mail"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.Mail">[docs]</a><span class="k">class</span> <span class="nc">Mail</span><span class="p">(</span><span class="n">LoggingMixin</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> This class simplifies working with mails returned by the imaplib client.</span> |
| |
| <span class="sd"> :param mail_body: The mail body of a mail received from imaplib client.</span> |
| <span class="sd"> :type mail_body: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mail_body</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">Mail</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">mail</span> <span class="o">=</span> <span class="n">email</span><span class="o">.</span><span class="n">message_from_string</span><span class="p">(</span><span class="n">mail_body</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="Mail.has_attachments"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.Mail.has_attachments">[docs]</a> <span class="k">def</span> <span class="nf">has_attachments</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Checks the mail for a attachments.</span> |
| |
| <span class="sd"> :returns: True if it has attachments and False if not.</span> |
| <span class="sd"> :rtype: bool</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">mail</span><span class="o">.</span><span class="n">get_content_maintype</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'multipart'</span></div> |
| |
| <div class="viewcode-block" id="Mail.get_attachments_by_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.Mail.get_attachments_by_name">[docs]</a> <span class="k">def</span> <span class="nf">get_attachments_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">check_regex</span><span class="p">,</span> <span class="n">find_first</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets all attachments by name for the mail.</span> |
| |
| <span class="sd"> :param name: The name of the attachment to look for.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param check_regex: Checks the name for a regular expression.</span> |
| <span class="sd"> :type check_regex: bool</span> |
| <span class="sd"> :param find_first: If set to True it will only find the first match and then quit.</span> |
| <span class="sd"> :type find_first: bool</span> |
| <span class="sd"> :returns: a list of tuples each containing name and payload</span> |
| <span class="sd"> where the attachments name matches the given name.</span> |
| <span class="sd"> :rtype: list of tuple</span> |
| <span class="sd"> """</span> |
| <span class="n">attachments</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">mail</span><span class="o">.</span><span class="n">walk</span><span class="p">():</span> |
| <span class="n">mail_part</span> <span class="o">=</span> <span class="n">MailPart</span><span class="p">(</span><span class="n">part</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">mail_part</span><span class="o">.</span><span class="n">is_attachment</span><span class="p">():</span> |
| <span class="n">found_attachment</span> <span class="o">=</span> <span class="n">mail_part</span><span class="o">.</span><span class="n">has_matching_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="k">if</span> <span class="n">check_regex</span> \ |
| <span class="k">else</span> <span class="n">mail_part</span><span class="o">.</span><span class="n">has_equal_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">found_attachment</span><span class="p">:</span> |
| <span class="n">file_name</span><span class="p">,</span> <span class="n">file_payload</span> <span class="o">=</span> <span class="n">mail_part</span><span class="o">.</span><span class="n">get_file</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Found attachment: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">file_name</span><span class="p">))</span> |
| <span class="n">attachments</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">file_name</span><span class="p">,</span> <span class="n">file_payload</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">find_first</span><span class="p">:</span> |
| <span class="k">break</span> |
| |
| <span class="k">return</span> <span class="n">attachments</span></div></div> |
| |
| |
| <div class="viewcode-block" id="MailPart"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.MailPart">[docs]</a><span class="k">class</span> <span class="nc">MailPart</span><span class="p">:</span> |
| <span class="sd">"""</span> |
| <span class="sd"> This class is a wrapper for a Mail object's part and gives it more features.</span> |
| |
| <span class="sd"> :param part: The mail part in a Mail object.</span> |
| <span class="sd"> :type part: any</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">part</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">part</span> <span class="o">=</span> <span class="n">part</span> |
| |
| <div class="viewcode-block" id="MailPart.is_attachment"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.MailPart.is_attachment">[docs]</a> <span class="k">def</span> <span class="nf">is_attachment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Checks if the part is a valid mail attachment.</span> |
| |
| <span class="sd"> :returns: True if it is an attachment and False if not.</span> |
| <span class="sd"> :rtype: bool</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">part</span><span class="o">.</span><span class="n">get_content_maintype</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">'multipart'</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">part</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Content-Disposition'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="MailPart.has_matching_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.MailPart.has_matching_name">[docs]</a> <span class="k">def</span> <span class="nf">has_matching_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Checks if the given name matches the part's name.</span> |
| |
| <span class="sd"> :param name: The name to look for.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :returns: True if it matches the name (including regular expression).</span> |
| <span class="sd"> :rtype: tuple</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">part</span><span class="o">.</span><span class="n">get_filename</span><span class="p">())</span></div> |
| |
| <div class="viewcode-block" id="MailPart.has_equal_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.MailPart.has_equal_name">[docs]</a> <span class="k">def</span> <span class="nf">has_equal_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Checks if the given name is equal to the part's name.</span> |
| |
| <span class="sd"> :param name: The name to look for.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :returns: True if it is equal to the given name.</span> |
| <span class="sd"> :rtype: bool</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">part</span><span class="o">.</span><span class="n">get_filename</span><span class="p">()</span> <span class="o">==</span> <span class="n">name</span></div> |
| |
| <div class="viewcode-block" id="MailPart.get_file"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/imap_hook/index.html#airflow.contrib.hooks.imap_hook.MailPart.get_file">[docs]</a> <span class="k">def</span> <span class="nf">get_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets the file including name and payload.</span> |
| |
| <span class="sd"> :returns: the part's name and payload.</span> |
| <span class="sd"> :rtype: tuple</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">part</span><span class="o">.</span><span class="n">get_filename</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">part</span><span class="o">.</span><span class="n">get_payload</span><span class="p">(</span><span class="n">decode</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |