FastAPIでメールフォームを作ってみた件 - クローラー君アウトプットブログ

今日はFASTAPIを用いてメールフォームを作成していて、やっとこさ動いたので、アウトプットする。

参考記事

今回のメールフォーム作成では「FastAPI-Mail」モジュールを用いて作成する。

インポートの仕方は下記を参照。

　from fastapi_mail import MessageSchema, FastMail, ConnectionConfig

仮想環境にインストールしていない人は、インストールしてね。

　pip install fastapi-mail

ここで「FastAPI-Mail」、「MessageSchema」、「FastMail」、「ConnctionConfig」それぞれの機能と使い方について理解しておこう。

fastapi_emailモジュールから、MesseageSchemaとFastMail、ConnectionConfig関数をインストール
ConnectionConfigで、メールサーバーとの接続を書く
1. ここで詰まった。どうやら参考記事と自分が使っていたfastapi_mailのバージョンが違っていて、最新は書き方が変わったらしい。
2. 　MAIL_STARTTLS=True
  
  　 MAIL_SSL_TLS=False
FastMailのインスタンスを生成
1. fm = FastMail(conf)
2. ConnectionConfigをFastMailの引数として渡して、SMTP設定を引き継がせる。これにより、FastMailオブジェクトを使い、メールが送信できるようになる。FastMailオブジェクトがないと、メールの送信ができない。
pydanticのEmailSchemaクラスを用いて、メール送信時の各フィールドのバリデーションを行う
1. 　class EmailSchema(BaseModel):
  
  　name:str
  
  　email:str
  
  　　　contents: str
  
  　tel: str
2. これがないと、POSTで受け取った時に型が不一致になってエラーの原因になるので、優秀なクラスっぽい。pydanticすげえ。。。
情報がpostされた時に行う処理をルーティング含め書いていく
1. MessageSchemaで、受信時のメッセージを作成していく
2. returnに、ユーザー側に表示される内容を作っていく。これthanks.htmlとかでもええかも

コードを書き終えて、フォームからPOSTすると、下記のエラーになった。

{"detail":[{"loc":["body"],"msg":"value is not a valid dict","type":"type_error.dict"}]}

エラーが意味するのは、フォームからPOSTされた値のバリデーションが辞書型ではなく、正しくないですよ。とのこと。

FastAPIはデフォルトだと、JSON形式のデータを受け取ることを想定している。JSON形式のデータというのは、「KeyとValueのペアである辞書型」なのだ。

今回の場合、フォームから送信されたデータをPydanticモデル(EmailSchema)に従って

バリデーションし、データの形式を確認する。

しかし、HTMLフォームからデータを送信する場合、

multipart/form-dataエンコーディングが使用されるらしい。そしてmultipart/form-dataエンコーディングは、フォームのフィールドを個別のパートとして送信するそうな。

そのため、FASTAPIがEmailSchemaを通して、自動でバリデーションできなくなるよう。

ここでコードを下記のように変更した。

旧コード：

async def submit_form(email: EmailSchema):

email：EmailSchemaというのは、関数submit_formに引数emailを渡している。そして型はEmailSchemaだよということ。受け取ったデータを、EmailSchemaを通して、バリデーションするのだ。

新コード：

async def submit_form(name: str = Form(...), tel: str = Form(...),
email: str = Form(...), contents: str = Form(...)):
 