GMime.References¶
Fields¶
Name |
Type |
Access |
Description |
---|---|---|---|
array |
[ |
r/w |
the array of message-id references |
Methods¶
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Details¶
- class GMime.References¶
A List of references, as per the References or In-Reply-To header fields.
- classmethod new()¶
- Returns:
a new
GMime.References
.- Return type:
Creates a new
GMime.References
.
- classmethod parse(options, text)¶
- Parameters:
options (
GMime.ParserOptions
orNone
) – aGMime.ParserOptions
orNone
text (
str
) – string containing a list of msg-ids
- Returns:
a new
GMime.References
containing the parsed message ids.- Return type:
Decodes a list of msg-ids as in the References and/or In-Reply-To headers defined in rfc822.
- append(msgid)¶
- Parameters:
msgid (
str
) – a message-id string
Appends a reference to msgid to the list of references.
- clear()¶
Clears the
GMime.References
list.
- copy()¶
- Returns:
a new
GMime.References
list that contains an identical list of items as self.- Return type:
Copies a
GMime.References
list.
- free()¶
Frees the
GMime.References
list.
- get_message_id(index)¶
- Parameters:
index (
int
) – the index of the message id- Returns:
the Message-Id reference from the
GMime.References
.- Return type:
Gets the specified Message-Id reference from the
GMime.References
.
- length()¶
- Returns:
the number of message ids in the list.
- Return type:
Gets the length of the
GMime.References
list.
- set_message_id(index, msgid)¶
-
Sets the specified Message-Id reference from the
GMime.References
.