python / python/cpython

smtplib documentation of mail_options/rcpt_options does not cover key-value case

オープン
#124,864 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

docs
主要言語
Python
スター
77.2k
フォーク
35.9k
PR マージ指標
PR 指標を取得中

説明

smtplib's sendmailand send_message support the arguments mail_options and rcpt_options which both take a list of ESMTP options. However, the documentation does only describe the single word case not the key-value case.

The caller may pass a list of ESMTP options (such as 8bitmime) to be used in MAIL FROM commands as mail_options. ESMTP options (such as DSN commands) that should be used with all RCPT commands can be passed as rcpt_options.

To determine the correct format, users need to read the library source code. Maybe this could directly be extended to:

The caller may pass a list of ESMTP options as strings (such as "8bitmime") to be used in MAIL FROM commands as mail_options. ESMTP options (such as DSN commands) that should be used with all RCPT commands can be passed as rcpt_options (such as "NOTIFY=SUCCESS,FAILURE").

Linked PRs
  • gh-132547
  • gh-142796
  • gh-142797

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

sendmail と send_message に関する smtplib のドキュメントから始め、mail_options と rcpt_options の説明をライブラリのソースコードと比較します。ドキュメントがスタンドアロンの ESMTP オプションとキーと値のオプションの両方を、NOTIFY=SUCCESS,FAILURE のような例とともに明確に説明していれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。