Metadata-Version: 2.1
Name: ntuee-mailer
Version: 2.0.0
Summary: an auto mailer to send emails in batch for you
Home-page: https://github.com/NTUEE-SAAD/mailing
License: MIT
Author: zhuang-jia-xu
Author-email: 76544194+zhuang-jia-xu@users.noreply.github.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Cerberus (==1.3.4)
Requires-Dist: PyYAML (==6.0)
Requires-Dist: email-validator (==1.2.1)
Requires-Dist: rich (==12.5.1)
Requires-Dist: typer[all] (>=0.6.1,<0.7.0)
Project-URL: Repository, https://github.com/NTUEE-SAAD/mailing
Description-Content-Type: text/markdown

# 學術部寄信程式

## Requirements

- python 3.X 64bit
- 套件皆有內建，不需額外安裝

## Usage

- **請不要把信件內容push上來**，負責人可以寫完信之後zip好傳給其他人
- 請複製 letters 資料夾中的 template 來創建新的信件
- content.html 放信件內文
  - **記得在內文中加入$recipient**，此處會被替換成收件人，及其稱謂
- recipients.csv 收件人及信箱名單
  - 可以用 excel 編輯 csv 檔案，格式詳見 template
  - **第一欄填收件人姓名，第二欄填收件人信箱**
  - 如果是臺大的信箱，可以不用填 '@ntu.edu.tw'，會自動加上去
- config.json 裡面可以修改信件設定
  - subject 為主旨
  - from 為寄件人名稱顯示，如果 from 留空白會顯示你原本的名稱
  - recipientTitle 裡面的 Title 不是空字串則會把這個 title 接到收件人姓名後面
  - lastNameOnly 如果是 true，使用「姓氏+稱謂」，反之則使用「全名+稱謂」
- attachments 資料夾裡放要附加的檔案
  - 執行時使用-a 選項來附加，預設不附加檔案，下面有範例
  - 如果你很在乎順序的話，取檔名的時候記得要確認順序
- **account-default.ini的檔名改成account.ini** 裡面放自己的計中帳密
  - **把檔案寄給別人時這個要改掉，不然大家都知道了**

## Run

    python mailer_invite.py LETTER
    python3 mailer_invite.py LETTER

LETTER is the name of the folder in the 'letters' folder where your email lives

### Options

    -h, --help    show help message and exit
    -a, --attach  attach files in 'letters/LETTER/attachments' folder to the email
    -t, --test    send email in test mode (to yourself)

## Examples

    python3 mailer_invite.py template -t
    python mailer_invite.py letter1 -a

