-
Notifications
You must be signed in to change notification settings - Fork 14.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- refactor airflow.utils.email and add typing
- Loading branch information
Showing
5 changed files
with
273 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
# 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 contains AWS SES Hook | ||
""" | ||
from typing import Any, Dict, Iterable, List, Optional, Union | ||
|
||
from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook | ||
from airflow.utils.email import build_mime_message | ||
|
||
|
||
class SESHook(AwsBaseHook): | ||
""" | ||
Interact with Amazon Simple Email Service. | ||
Additional arguments (such as ``aws_conn_id``) may be specified and | ||
are passed down to the underlying AwsBaseHook. | ||
.. seealso:: | ||
:class:`~airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook` | ||
""" | ||
|
||
def __init__(self, *args, **kwargs) -> None: | ||
kwargs['client_type'] = 'ses' | ||
super().__init__(*args, **kwargs) | ||
|
||
def send_email( # pylint: disable=too-many-arguments | ||
self, | ||
mail_from: str, | ||
to: Union[str, Iterable[str]], | ||
subject: str, | ||
html_content: str, | ||
files: Optional[List[str]] = None, | ||
cc: Optional[Union[str, Iterable[str]]] = None, | ||
bcc: Optional[Union[str, Iterable[str]]] = None, | ||
mime_subtype: str = 'mixed', | ||
mime_charset: str = 'utf-8', | ||
reply_to: Optional[str] = None, | ||
return_path: Optional[str] = None, | ||
custom_headers: Optional[Dict[str, Any]] = None | ||
) -> dict: | ||
""" | ||
Send email using Amazon Simple Email Service | ||
:param mail_from: Email address to set as email's from | ||
:param to: List of email addresses to set as email's to | ||
:param subject: Email's subject | ||
:param html_content: Content of email in HTML format | ||
:param files: List of paths of files to be attached | ||
:param cc: List of email addresses to set as email's CC | ||
:param bcc: List of email addresses to set as email's BCC | ||
:param mime_subtype: Can be used to specify the subtype of the message. Default = mixed | ||
:param mime_charset: Email's charset. Default = UTF-8. | ||
:param return_path: The email address to which replies will be sent. By default, replies | ||
are sent to the original sender's email address. | ||
:param reply_to: The email address to which message bounces and complaints should be sent. | ||
"Return-Path" is sometimes called "envelope from," "envelope sender," or "MAIL FROM." | ||
:param custom_headers: Additional headers to add to the MIME message. | ||
No validations are run on these values and they should be able to be encoded. | ||
:return: Response from Amazon SES service with unique message identifier. | ||
""" | ||
ses_client = self.get_conn() | ||
|
||
custom_headers = custom_headers or {} | ||
if reply_to: | ||
custom_headers['Reply-To'] = reply_to | ||
if return_path: | ||
custom_headers['Return-Path'] = return_path | ||
|
||
message, recipients = build_mime_message( | ||
mail_from=mail_from, | ||
to=to, | ||
subject=subject, | ||
html_content=html_content, | ||
files=files, | ||
cc=cc, | ||
bcc=bcc, | ||
mime_subtype=mime_subtype, | ||
mime_charset=mime_charset, | ||
custom_headers=custom_headers, | ||
) | ||
|
||
return ses_client.send_raw_email( | ||
Source=mail_from, Destinations=recipients, RawMessage={'Data': message.as_string()} | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# 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. | ||
|
||
import boto3 | ||
import pytest | ||
from moto import mock_ses | ||
|
||
from airflow.providers.amazon.aws.hooks.ses import SESHook | ||
|
||
boto3.setup_default_session() | ||
|
||
|
||
@mock_ses | ||
def test_get_conn(): | ||
hook = SESHook(aws_conn_id='aws_default') | ||
assert hook.get_conn() is not None | ||
|
||
|
||
@mock_ses | ||
@pytest.mark.parametrize('to', | ||
[ | ||
'to@domain.com', | ||
['to1@domain.com', 'to2@domain.com'], | ||
'to1@domain.com,to2@domain.com' | ||
]) | ||
@pytest.mark.parametrize('cc', | ||
[ | ||
'cc@domain.com', | ||
['cc1@domain.com', 'cc2@domain.com'], | ||
'cc1@domain.com,cc2@domain.com' | ||
]) | ||
@pytest.mark.parametrize('bcc', | ||
[ | ||
'bcc@domain.com', | ||
['bcc1@domain.com', 'bcc2@domain.com'], | ||
'bcc1@domain.com,bcc2@domain.com' | ||
]) | ||
def test_send_email(to, cc, bcc): | ||
# Given | ||
hook = SESHook() | ||
ses_client = hook.get_conn() | ||
mail_from = 'test_from@domain.com' | ||
|
||
# Amazon only allows to send emails from verified addresses, | ||
# then we need to validate the from address before sending the email, | ||
# otherwise this test would raise a `botocore.errorfactory.MessageRejected` exception | ||
ses_client.verify_email_identity(EmailAddress=mail_from) | ||
|
||
# When | ||
response = hook.send_email( | ||
mail_from=mail_from, | ||
to=to, | ||
subject='subject', | ||
html_content='<html>Test</html>', | ||
cc=cc, | ||
bcc=bcc, | ||
reply_to='reply_to@domain.com', | ||
return_path='return_path@domain.com', | ||
) | ||
|
||
# Then | ||
assert response is not None | ||
assert isinstance(response, dict) | ||
assert 'MessageId' in response |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters