Source code for airflow.providers.amazon.aws.example_dags.example_imap_attachment_to_s3

# 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 is an example dag for using `ImapAttachmentToS3Operator` to transfer an email attachment via IMAP
protocol from a mail server to S3 Bucket.
"""

from datetime import datetime
from os import getenv

from airflow import DAG
from airflow.providers.amazon.aws.transfers.imap_attachment_to_s3 import ImapAttachmentToS3Operator


[docs]IMAP_ATTACHMENT_NAME = getenv("IMAP_ATTACHMENT_NAME", "test.txt")


[docs]IMAP_MAIL_FOLDER = getenv("IMAP_MAIL_FOLDER", "INBOX")


[docs]IMAP_MAIL_FILTER = getenv("IMAP_MAIL_FILTER", "All")


[docs]S3_BUCKET = getenv("S3_BUCKET", "test-bucket")


[docs]S3_KEY = getenv("S3_KEY", "key")


with DAG(
    dag_id="example_imap_attachment_to_s3",
    start_date=datetime(2021, 1, 1),
    schedule_interval=None,
    catchup=False,
    tags=['example'],
) as dag:
    # [START howto_transfer_imap_attachment_to_s3]

[docs]    task_transfer_imap_attachment_to_s3 = ImapAttachmentToS3Operator(
        task_id='transfer_imap_attachment_to_s3',
        imap_attachment_name=IMAP_ATTACHMENT_NAME,
        s3_bucket=S3_BUCKET,
        s3_key=S3_KEY,
        imap_mail_folder=IMAP_MAIL_FOLDER,
        imap_mail_filter=IMAP_MAIL_FILTER,

    )
    # [END howto_transfer_imap_attachment_to_s3]

Was this entry helpful?