python / python/cpython

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

Abierto
#124,864 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la documentación de smtplib para sendmail y send_message y, a continuación, compara las descripciones de mail_options y rcpt_options con el código fuente de la biblioteca. El trabajo estará terminado cuando la documentación describa claramente tanto las opciones ESMTP independientes como las opciones de clave-valor, con un ejemplo como NOTIFY=SUCCESS,FAILURE.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.