Merge pull request #4 from tai271828/pr-render-mail-config

Add suffix option

Author: Lee-W

.github/workflows/pushed.yaml .github/workflows/python-check.yaml.github/workflows/pushed.yaml renamed to .github/workflows/python-check.yaml

@@ -1,7 +1,6 @@
-name: New commit pushed
+name: New commit pushed or pull request created
 
-on:
-  push:
+on: [push, pull_request]
 
 jobs:
   check:

Pipfile

@@ -7,6 +7,7 @@ verify_ssl = true
 # task management
 invoke = "*"
 # test
+tox = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-mock = "*"

Pipfile.lock

@@ -35,6 +35,40 @@ Options:
 }
 ```
 
+Please note the comma is able to be used as a receiver separator to send multiple people. For example, the following 3
+formats are all working:
+
+A space following a comma
+```json
+{
+    "common_data": {},
+    "unique_data": [
+        {"receiver_email": "somerec01@somedomain, somerec02@somedomain"}
+    ]
+}
+```
+
+No space following a comma
+```json
+{
+    "common_data": {},
+    "unique_data": [
+        {"receiver_email": "somerec01@somedomain,somerec02@somedomain"}
+    ]
+}
+```
+
+Or mix both of the above two types
+```json
+{
+    "common_data": {},
+    "unique_data": [
+        {"receiver_email": "somerec01@somedomain, somerec02@somedomain,somerec03@somedomain"}
+    ]
+}
+```
+
+
 * `--mails_path PATH`: The output path of the mails. The mail will be named as the receivers email address.
 
 ### Step 2: Send the generated mails
@@ -43,7 +77,7 @@ Options:
 python send_mail.py [OPTIONS] CONFIG_PATH
 
 Options:
-  --output_path PATH  [default: mails_to_sent]
+  --mails_path PATH  [default: mails_to_sent]
   --attachment_file PATH
 ```
 
@@ -57,8 +91,28 @@ Options:
 }
 ```
 
+Please note the comma is used as a receiver separator to send multiple people.
+
 * `--mails_path PATH`: The path of the mails to sent.
 
+By issuing the `send_mail.py` command,
+you will be prompted to input the corresponding password of your smtp server.
+
+```plaintext
+You are about to send the mails under "mails_to_sent". Do you want to continue? [y/N]: y
+Please enter your mail account: <sender email address in mail config>
+Please enter you mail password:
+INFO:root:Email sent to <receiver address in RECEIVER_DATA>!
+```
+
+Currently we only support the smtp server of `gmail`,
+so you may want to use the one-time app password for security concern.
+To use gmail one-time app password, please go to
+`Manage your Goolge Account > Security > Signning to Google > App passwords` and then
+`Select app > Other`
+to generate your one-time app password. The generated password could be removed anytime
+if you are sure that you won't use it anymore.
+
 ## Contributing
 See [Contributing](contributing.md)
 

docs/README.md

@@ -1,12 +1,25 @@
 {
     "common_data": {
         "sender_name": "Taihsiang Ho",
-        "sender_team": "2020 台灣 Python 年會籌備團隊 贊助組"
+        "sender_team": "2020 台灣 Python 年會籌備團隊 贊助組",
+        "pycon_tw_20xx": "PyCon Taiwan 2020"
     },
     "unique_data": [
         {
-            "receiver_email": "sponsorship@pycon.tw",
-            "receiver_name": "贊助組測試有限公司"
+            "receiver_email": "tai271828+sponsorship.testemail.1@gmail.com",
+            "receiver_name": "贊助組測試01有限公司"
+        },
+        {
+            "receiver_email": "tai271828+sponsorship.testemail.2@gmail.com",
+            "receiver_name": "贊助組測試02有限公司"
+        },
+        {
+            "receiver_email": "tai271828+sponsorship.testemail.4@gmail.com, tai271828+sponsorship.testemail.4.1@pycon.tw, taihsiangho+sponsorship.testemail.4.2@gmail.com,tai271828+sponsorship.testemail.4.3@solvcon.net",
+            "receiver_name": "贊助組測試04有限公司"
+        },
+        {
+            "receiver_email": "tai271828+sponsorship.testemail.3@gmail.com",
+            "receiver_name": "贊助組測試03有限公司"
         }
     ]
 }

examples/sponsorship/spam_sponsors_2020.json

@@ -1,5 +1,5 @@
 {
-    "Subject": "[測試][請忽略][PyConTW2020] 敬邀參與 PyCon Taiwan 2020 - 測試請忽略有限公司",
+    "Subject": "[PyConTW2020] 敬邀參與 PyCon Taiwan 2020",
     "From": "tai27182@pycon.tw",
     "CC": "sponsorship@pycon.tw"
 }

examples/sponsorship/spam_sponsors_2020_mail_config.json

@@ -15,12 +15,19 @@ def load_template(tmpl_path: Path) -> Template:
 
 
 def render_all_content(
-    template: Template, common_data: Dict[str, str], unique_data: List[Dict[str, str]]
+    template: Template,
+    common_data: Dict[str, str],
+    unique_data: List[Dict[str, str]],
+    separator: str,
 ) -> Dict[str, str]:
     recv_to_mail = dict()
     for data in unique_data:
         data.update(common_data)
-        recv_to_mail[data["receiver_email"]] = template.render(**data)
+        if separator:
+            subject = separator.join([data["receiver_email"], data["receiver_name"]])
+        else:
+            subject = data["receiver_email"]
+        recv_to_mail[subject] = template.render(**data)
     return recv_to_mail
 
 
@@ -33,24 +40,30 @@ def export_mails(recv_to_mail, output_path):
 @click.command()
 @click.argument("template_path", type=click.Path(exists=True))
 @click.argument("receiver_data", type=click.Path(exists=True))
+@click.option(
+    "--separator",
+    default="",
+    show_default=True,
+    help="Separator used for subject suffix",
+)
 @click.option(
     "--output_path",
     type=click.Path(exists=False),
     default="mails_to_sent",
     show_default=True,
 )
-def main(template_path, receiver_data, output_path):
+def main(template_path, receiver_data, separator, output_path):
     if not os.path.isdir(output_path):
         logging.info('Create directory "%s"', output_path)
-        os.mkdir(output_path)
+        Path(output_path).mkdir(parents=True)
 
     with open(receiver_data, "r") as input_file:
         data = json.load(input_file)
         common_data = data["common_data"]
         unique_data = data["unique_data"]
 
     template = load_template(template_path)
-    recv_to_mail = render_all_content(template, common_data, unique_data)
+    recv_to_mail = render_all_content(template, common_data, unique_data, separator)
     export_mails(recv_to_mail, output_path)