summaryrefslogtreecommitdiffstats
path: root/Doc/lib/emailutil.tex
diff options
context:
space:
mode:
authorAnthony Baxter <anthonybaxter@gmail.com>2004-10-11 13:53:08 (GMT)
committerAnthony Baxter <anthonybaxter@gmail.com>2004-10-11 13:53:08 (GMT)
commit3dd9e461618b0964312fa3c649cf03c7bfe27827 (patch)
treeb8c98e967b38f936410f4e3fddda413bc9c8db3d /Doc/lib/emailutil.tex
parent7f468f29f49786988e4f1a005174578fc83c7eb9 (diff)
downloadcpython-3dd9e461618b0964312fa3c649cf03c7bfe27827.zip
cpython-3dd9e461618b0964312fa3c649cf03c7bfe27827.tar.gz
cpython-3dd9e461618b0964312fa3c649cf03c7bfe27827.tar.bz2
Added a usegmt flag to email.Utils.formatdate - this allows it to be
used to replace rfc822.formatdate for protocols like HTTP (where 'GMT' must be the timezone string).
Diffstat (limited to 'Doc/lib/emailutil.tex')
-rw-r--r--Doc/lib/emailutil.tex7
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/lib/emailutil.tex b/Doc/lib/emailutil.tex
index c41f066..b93a2b9 100644
--- a/Doc/lib/emailutil.tex
+++ b/Doc/lib/emailutil.tex
@@ -84,7 +84,7 @@ changes in daylight savings time, though not worth worrying about for
common use.
\end{funcdesc}
-\begin{funcdesc}{formatdate}{\optional{timeval\optional{, localtime}}}
+\begin{funcdesc}{formatdate}{\optional{timeval\optional{, localtime}\optional{, usegmt}}}
Returns a date string as per \rfc{2822}, e.g.:
\begin{verbatim}
@@ -99,6 +99,11 @@ Optional \var{localtime} is a flag that when \code{True}, interprets
\var{timeval}, and returns a date relative to the local timezone
instead of UTC, properly taking daylight savings time into account.
The default is \code{False} meaning UTC is used.
+
+Optional \var{usegmt} is a flag that when \code{True}, outputs a
+date string with the timezone as an ascii string \code{GMT}, rather
+than a numeric \code{-0000}. This is needed for some protocols (such
+as HTTP). This only applies when \var{localtime} is \code{False}
\end{funcdesc}
\begin{funcdesc}{make_msgid}{\optional{idstring}}