.config/coc/extensions/coc-python-data/languageServer.0.5.59/Typeshed/stdlib/3/email/message.pyi

   1 # Stubs for email.message (Python 3.4)\r
   2 \r
   3 from typing import (\r
   4     List, Optional, Union, Tuple, TypeVar, Generator, Sequence, Iterator, Any\r
   5 )\r
   6 import sys\r
   7 from email.charset import Charset\r
   8 from email.errors import MessageDefect\r
   9 from email.header import Header\r
  10 from email.policy import Policy\r
  11 from email.contentmanager import ContentManager\r
  12 \r
  13 _T = TypeVar('_T')\r
  14 \r
  15 _PayloadType = Union[List[Message], str, bytes]\r
  16 _CharsetType = Union[Charset, str, None]\r
  17 _ParamsType = Union[str, None, Tuple[str, Optional[str], str]]\r
  18 _ParamType = Union[str, Tuple[Optional[str], Optional[str], str]]\r
  19 _HeaderType = Union[str, Header]\r
  20 \r
  21 class Message:\r
  22     preamble = ...  # type: Optional[str]\r
  23     epilogue = ...  # type: Optional[str]\r
  24     defects = ...  # type: List[MessageDefect]\r
  25     def __str__(self) -> str: ...\r
  26     def is_multipart(self) -> bool: ...\r
  27     def set_unixfrom(self, unixfrom: str) -> None: ...\r
  28     def get_unixfrom(self) -> Optional[str]: ...\r
  29     def attach(self, payload: 'Message') -> None: ...\r
  30     def get_payload(self, i: int = ..., decode: bool = ...) -> Optional[_PayloadType]: ...\r
  31     def set_payload(self, payload: _PayloadType,\r
  32                     charset: _CharsetType = ...) -> None: ...\r
  33     def set_charset(self, charset: _CharsetType) -> None: ...\r
  34     def get_charset(self) -> _CharsetType: ...\r
  35     def __len__(self) -> int: ...\r
  36     def __contains__(self, name: str) -> bool: ...\r
  37     def __getitem__(self, name: str) -> Optional[_HeaderType]: ...\r
  38     def __setitem__(self, name: str, val: _HeaderType) -> None: ...\r
  39     def __delitem__(self, name: str) -> None: ...\r
  40     def keys(self) -> List[str]: ...\r
  41     def values(self) -> List[_HeaderType]: ...\r
  42     def items(self) -> List[Tuple[str, _HeaderType]]: ...\r
  43     def get(self, name: str, failobj: _T = ...) -> Union[_HeaderType, _T]: ...\r
  44     def get_all(self, name: str, failobj: _T = ...) -> Union[List[_HeaderType], _T]: ...\r
  45     def add_header(self, _name: str, _value: str, **_params: _ParamsType) -> None: ...\r
  46     def replace_header(self, _name: str, _value: _HeaderType) -> None: ...\r
  47     def get_content_type(self) -> str: ...\r
  48     def get_content_maintype(self) -> str: ...\r
  49     def get_content_subtype(self) -> str: ...\r
  50     def get_default_type(self) -> str: ...\r
  51     def set_default_type(self, ctype: str) -> None: ...\r
  52     def get_params(self, failobj: _T = ..., header: str = ...,\r
  53                    unquote: bool = ...) -> Union[List[Tuple[str, str]], _T]: ...\r
  54     def get_param(self, param: str, failobj: _T = ..., header: str = ...,\r
  55                   unquote: bool = ...) -> Union[_T, _ParamType]: ...\r
  56     def del_param(self, param: str, header: str = ...,\r
  57                   requote: bool = ...) -> None: ...\r
  58     def set_type(self, type: str, header: str = ...,\r
  59                  requote: bool = ...) -> None: ...\r
  60     def get_filename(self, failobj: _T = ...) -> Union[_T, str]: ...\r
  61     def get_boundary(self, failobj: _T = ...) -> Union[_T, str]: ...\r
  62     def set_boundary(self, boundary: str) -> None: ...\r
  63     def get_content_charset(self, failobj: _T = ...) -> Union[_T, str]: ...\r
  64     def get_charsets(self, failobj: _T = ...) -> Union[_T, List[str]]: ...\r
  65     def walk(self) -> Generator['Message', None, None]: ...\r
  66     if sys.version_info >= (3, 5):\r
  67         def get_content_disposition(self) -> Optional[str]: ...\r
  68     def as_string(self, unixfrom: bool = ..., maxheaderlen: int = ...,\r
  69                   policy: Optional[Policy] = ...) -> str: ...\r
  70     def as_bytes(self, unixfrom: bool = ...,\r
  71                  policy: Optional[Policy] = ...) -> bytes: ...\r
  72     def __bytes__(self) -> bytes: ...\r
  73     def set_param(self, param: str, value: str, header: str = ...,\r
  74                   requote: bool = ..., charset: str = ...,\r
  75                   language: str = ..., replace: bool = ...) -> None: ...\r
  76     def __init__(self, policy: Policy = ...) -> None: ...\r
  77 \r
  78 class MIMEPart(Message):\r
  79     def get_body(self,\r
  80                  preferencelist: Sequence[str] = ...) -> Optional[Message]: ...\r
  81     def iter_attachments(self) -> Iterator[Message]: ...\r
  82     def iter_parts(self) -> Iterator[Message]: ...\r
  83     def get_content(self, *args: Any,\r
  84                     content_manager: Optional[ContentManager] = ...,\r
  85                     **kw: Any) -> Any: ...\r
  86     def set_content(self, *args: Any,\r
  87                     content_manager: Optional[ContentManager] = ...,\r
  88                     **kw: Any) -> None: ...\r
  89     def make_related(self, boundary: Optional[str] = ...) -> None: ...\r
  90     def make_alternative(self, boundary: Optional[str] = ...) -> None: ...\r
  91     def make_mixed(self, boundary: Optional[str] = ...) -> None: ...\r
  92     def add_related(self, *args: Any,\r
  93                     content_manager: Optional[ContentManager] = ...,\r
  94                     **kw: Any) -> None: ...\r
  95     def add_alternative(self, *args: Any,\r
  96                         content_manager: Optional[ContentManager] = ...,\r
  97                         **kw: Any) -> None: ...\r
  98     def add_attachement(self, *args: Any,\r
  99                         content_manager: Optional[ContentManager] = ...,\r
 100                         **kw: Any) -> None: ...\r
 101     def clear(self) -> None: ...\r
 102     def clear_content(self) -> None: ...\r
 103     def is_attachment(self) -> bool: ...\r
 104 \r
 105 class EmailMessage(MIMEPart): ...\r