class documentation

class HeaderMatches(RESTList): (source)

View In Hierarchy

The list of header matches for a mailing-list.

Method __init__ No summary
Method __repr__ Undocumented
Method __str__ Undocumented
Method add Add a new HeaderMatch rule to the MailingList.
Method find Find a set of HeaderMatch rules.
Instance Variable _factory Undocumented
Instance Variable _mlist Undocumented

Inherited from RESTList:

Method __delitem__ Undocumented
Method __getitem__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method clear Undocumented
Property rest_data Get data from API and cache it (only once per instance).

Inherited from RESTBase (via RESTList):

Method save Undocumented
Method _get Undocumented
Method _reset_cache Undocumented
Method _set Undocumented
Class Variable _autosave automatically send a PATCH request to the API when a value is changed. Otherwise, the save() method must be called.
Class Variable _properties the list of expected entity properties. This is required for API elements that behave like an object, with REST data accessed through attributes. If this value is None, the REST data is used to list available properties.
Class Variable _read_only_properties list of properties that cannot be written to (defaults to self_link only).
Class Variable _writable_properties list of properties that can be written to using a PATCH request. If this value is None, all properties are writable.
Instance Variable _changed_rest_data Undocumented
Instance Variable _connection Undocumented
Instance Variable _rest_data Undocumented
Instance Variable _url Undocumented
def __init__(self, connection, url, mlist): (source)
Parameters
connectionUndocumented
urlUndocumented
mlist:MailingList.The corresponding list object.
def __repr__(self): (source)
def __str__(self): (source)

Undocumented

def add(self, header, pattern, action=None, tag=None): (source)

Add a new HeaderMatch rule to the MailingList.

Parameters
header:strThe header to consider.
pattern:strThe regular expression to use for filtering.
action:strThe action to take when the header matches the pattern. This can be 'accept', 'discard', 'reject', or 'hold'.
tagUndocumented
def find(self, header=None, tag=None, action=None): (source)

Find a set of HeaderMatch rules.

Parameters
header:strThe header to consider.
tag:strThe tag associated with header.
action:strThe action to take when the header matches the pattern. This can be 'accept', 'discard', 'reject', or 'hold'.

Undocumented