💾 Archived View for tris.fyi › pydoc › email.parser captured on 2023-04-26 at 13:36:33. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

email.parser

A parser of RFC 2822 and MIME email messages.

Classes

BytesFeedParser

Like FeedParser, but feed accepts bytes.

close(self)

  Parse all remaining data and return the root message object.

feed(self, data)

BytesHeaderParser

parse(self, fp, headersonly=True)

parsebytes(self, text, headersonly=True)

BytesParser

parse(self, fp, headersonly=False)

  Create a message structure from the data in a binary file.

          Reads all the data from the file and returns the root of the message
          structure.  Optional headersonly is a flag specifying whether to stop
          parsing after reading the headers or not.  The default is False,
          meaning it parses the entire contents of the file.

parsebytes(self, text, headersonly=False)

  Create a message structure from a byte string.

          Returns the root of the message structure.  Optional headersonly is a
          flag specifying whether to stop parsing after reading the headers or
          not.  The default is False, meaning it parses the entire contents of
          the file.

FeedParser

A feed-style parser of email.

close(self)

  Parse all remaining data and return the root message object.

feed(self, data)

  Push more data into the parser.

HeaderParser

parse(self, fp, headersonly=True)

parsestr(self, text, headersonly=True)

Parser

parse(self, fp, headersonly=False)

  Create a message structure from the data in a file.

          Reads all the data from the file and returns the root of the message
          structure.  Optional headersonly is a flag specifying whether to stop
          parsing after reading the headers or not.  The default is False,
          meaning it parses the entire contents of the file.

parsestr(self, text, headersonly=False)

  Create a message structure from a string.

          Returns the root of the message structure.  Optional headersonly is a
          flag specifying whether to stop parsing after reading the headers or
          not.  The default is False, meaning it parses the entire contents of
          the file.

StringIO

Text I/O implementation using an in-memory buffer.

The initial_value argument sets the value of object.  The newline
argument is like the one of TextIOWrapper's constructor.

close(self, /)

  Close the IO object.

  Attempting any further operation after the object is closed
  will raise a ValueError.

  This method has no effect if the file is already closed.

detach(...)

  Separate the underlying buffer from the TextIOBase and return it.

  After the underlying buffer has been detached, the TextIO is in an
  unusable state.

fileno(self, /)

  Returns underlying file descriptor if one exists.

  OSError is raised if the IO object does not use a file descriptor.

flush(self, /)

  Flush write buffers, if applicable.

  This is not implemented for read-only and non-blocking streams.

getvalue(self, /)

  Retrieve the entire contents of the object.

isatty(self, /)

  Return whether this is an 'interactive' stream.

  Return False if it can't be determined.

read(self, size=-1, /)

  Read at most size characters, returned as a string.

  If the argument is negative or omitted, read until EOF
  is reached. Return an empty string at EOF.

readable(self, /)

  Returns True if the IO object can be read.

readline(self, size=-1, /)

  Read until newline or EOF.

  Returns an empty string if EOF is hit immediately.

readlines(self, hint=-1, /)

  Return a list of lines from the stream.

  hint can be specified to control the number of lines read: no more
  lines will be read if the total size (in bytes/characters) of all
  lines so far exceeds hint.

seek(self, pos, whence=0, /)

  Change stream position.

  Seek to character offset pos relative to position indicated by whence:
      0  Start of stream (the default).  pos should be >= 0;
      1  Current position - pos must be 0;
      2  End of stream - pos must be 0.
  Returns the new absolute position.

seekable(self, /)

  Returns True if the IO object can be seeked.

tell(self, /)

  Tell the current file position.

truncate(self, pos=None, /)

  Truncate size to pos.

  The pos argument defaults to the current file position, as
  returned by tell().  The current file position is unchanged.
  Returns the new absolute position.

writable(self, /)

  Returns True if the IO object can be written.

write(self, s, /)

  Write string to file.

  Returns the number of characters written, which is always equal to
  the length of the string.

writelines(self, lines, /)

  Write a list of lines to stream.

  Line separators are not added, so it is usual for each of the
  lines provided to have a line separator at the end.

closed = <attribute 'closed' of '_io.StringIO' objects>

encoding = <attribute 'encoding' of '_io._TextIOBase' objects>
  Encoding of the text stream.

  Subclasses should override.

errors = <attribute 'errors' of '_io._TextIOBase' objects>
  The error setting of the decoder or encoder.

  Subclasses should override.

line_buffering = <attribute 'line_buffering' of '_io.StringIO' objects>

newlines = <attribute 'newlines' of '_io.StringIO' objects>

TextIOWrapper

Character and line based layer over a BufferedIOBase object, buffer.

encoding gives the name of the encoding that the stream will be
decoded or encoded with. It defaults to locale.getpreferredencoding(False).

errors determines the strictness of encoding and decoding (see
help(codecs.Codec) or the documentation for codecs.register) and
defaults to "strict".

newline controls how line endings are handled. It can be None, '',
'\n', '\r', and '\r\n'.  It works as follows:


	On input, if newline is None, universal newlines mode is

  enabled. Lines in the input can end in '\n', '\r', or '\r\n', and
  these are translated into '\n' before being returned to the
  caller. If it is '', universal newline mode is enabled, but line
  endings are returned to the caller untranslated. If it has any of
  the other legal values, input lines are only terminated by the given
  string, and the line ending is returned to the caller untranslated.


	On output, if newline is None, any '\n' characters written are

  translated to the system default line separator, os.linesep. If
  newline is '' or '\n', no translation takes place. If newline is any
  of the other legal values, any '\n' characters written are translated
  to the given string.

If line_buffering is True, a call to flush is implied when a call to
write contains a newline character.

close(self, /)

detach(self, /)

fileno(self, /)

flush(self, /)

isatty(self, /)

read(self, size=-1, /)

readable(self, /)

readline(self, size=-1, /)

readlines(self, hint=-1, /)

  Return a list of lines from the stream.

  hint can be specified to control the number of lines read: no more
  lines will be read if the total size (in bytes/characters) of all
  lines so far exceeds hint.

reconfigure(self, /, *, encoding=None, errors=None, newline=None, line_buffering=None, write_through=None)

  Reconfigure the text stream with new parameters.

  This also does an implicit stream flush.

seek(self, cookie, whence=0, /)

seekable(self, /)

tell(self, /)

truncate(self, pos=None, /)

writable(self, /)

write(self, text, /)

writelines(self, lines, /)

  Write a list of lines to stream.

  Line separators are not added, so it is usual for each of the
  lines provided to have a line separator at the end.

buffer = <member 'buffer' of '_io.TextIOWrapper' objects>

closed = <attribute 'closed' of '_io.TextIOWrapper' objects>

encoding = <member 'encoding' of '_io.TextIOWrapper' objects>

errors = <attribute 'errors' of '_io.TextIOWrapper' objects>

line_buffering = <member 'line_buffering' of '_io.TextIOWrapper' objects>

name = <attribute 'name' of '_io.TextIOWrapper' objects>

newlines = <attribute 'newlines' of '_io.TextIOWrapper' objects>

write_through = <member 'write_through' of '_io.TextIOWrapper' objects>

Other members

compat32 = Compat32()