You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
105 lines
4.1 KiB
105 lines
4.1 KiB
# |
|
# Licensed to the Apache Software Foundation (ASF) under one |
|
# or more contributor license agreements. See the NOTICE file |
|
# distributed with this work for additional information |
|
# regarding copyright ownership. The ASF licenses this file |
|
# to you under the Apache License, Version 2.0 (the |
|
# "License"); you may not use this file except in compliance |
|
# with the License. You may obtain a copy of the License at |
|
# |
|
# http://www.apache.org/licenses/LICENSE-2.0 |
|
# |
|
# Unless required by applicable law or agreed to in writing, |
|
# software distributed under the License is distributed on an |
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
|
# KIND, either express or implied. See the License for the |
|
# specific language governing permissions and limitations |
|
# under the License. |
|
"""This module allows you to transfer mail attachments from a mail server into s3 bucket.""" |
|
from airflow.models import BaseOperator |
|
from airflow.providers.amazon.aws.hooks.s3 import S3Hook |
|
from airflow.providers.imap.hooks.imap import ImapHook |
|
from airflow.utils.decorators import apply_defaults |
|
|
|
|
|
class ImapAttachmentToS3Operator(BaseOperator): |
|
""" |
|
Transfers a mail attachment from a mail server into s3 bucket. |
|
|
|
.. seealso:: |
|
For more information on how to use this operator, take a look at the guide: |
|
:ref:`howto/operator:ImapAttachmentToS3Operator` |
|
|
|
:param imap_attachment_name: The file name of the mail attachment that you want to transfer. |
|
:type imap_attachment_name: str |
|
:param s3_key: The destination file name in the s3 bucket for the attachment. |
|
:type s3_key: str |
|
:param imap_check_regex: If set checks the `imap_attachment_name` for a regular expression. |
|
:type imap_check_regex: bool |
|
:param imap_mail_folder: The folder on the mail server to look for the attachment. |
|
:type imap_mail_folder: str |
|
:param imap_mail_filter: If set other than 'All' only specific mails will be checked. |
|
See :py:meth:`imaplib.IMAP4.search` for details. |
|
:type imap_mail_filter: str |
|
:param s3_overwrite: If set overwrites the s3 key if already exists. |
|
:type s3_overwrite: bool |
|
:param imap_conn_id: The reference to the connection details of the mail server. |
|
:type imap_conn_id: str |
|
:param s3_conn_id: The reference to the s3 connection details. |
|
:type s3_conn_id: str |
|
""" |
|
|
|
template_fields = ("imap_attachment_name", "s3_key", "imap_mail_filter") |
|
|
|
@apply_defaults |
|
def __init__( |
|
self, |
|
*, |
|
imap_attachment_name: str, |
|
s3_key: str, |
|
imap_check_regex: bool = False, |
|
imap_mail_folder: str = "INBOX", |
|
imap_mail_filter: str = "All", |
|
s3_overwrite: bool = False, |
|
imap_conn_id: str = "imap_default", |
|
s3_conn_id: str = "aws_default", |
|
**kwargs, |
|
) -> None: |
|
super().__init__(**kwargs) |
|
self.imap_attachment_name = imap_attachment_name |
|
self.s3_key = s3_key |
|
self.imap_check_regex = imap_check_regex |
|
self.imap_mail_folder = imap_mail_folder |
|
self.imap_mail_filter = imap_mail_filter |
|
self.s3_overwrite = s3_overwrite |
|
self.imap_conn_id = imap_conn_id |
|
self.s3_conn_id = s3_conn_id |
|
|
|
def execute(self, context) -> None: |
|
""" |
|
This function executes the transfer from the email server (via imap) into s3. |
|
|
|
:param context: The context while executing. |
|
:type context: dict |
|
""" |
|
self.log.info( |
|
"Transferring mail attachment %s from mail server via imap to s3 key %s...", |
|
self.imap_attachment_name, |
|
self.s3_key, |
|
) |
|
|
|
with ImapHook(imap_conn_id=self.imap_conn_id) as imap_hook: |
|
imap_mail_attachments = imap_hook.retrieve_mail_attachments( |
|
name=self.imap_attachment_name, |
|
check_regex=self.imap_check_regex, |
|
latest_only=True, |
|
mail_folder=self.imap_mail_folder, |
|
mail_filter=self.imap_mail_filter, |
|
) |
|
|
|
s3_hook = S3Hook(aws_conn_id=self.s3_conn_id) |
|
s3_hook.load_bytes( |
|
bytes_data=imap_mail_attachments[0][1], |
|
key=self.s3_key, |
|
replace=self.s3_overwrite, |
|
)
|
|
|