mailmanclient.restobjects.user.User

class documentation

class User(RESTObject, PreferencesMixin): (source)

View In Hierarchy

Undocumented

Method __init__ No summary
Method __repr__ Undocumented
Method __setattr__ Special case for the password
Method add_address Adds another email adress to the user record and returns an _Address object.
Method preferred_address.setter Set a User's preferred address.
Property addresses Undocumented
Property preferred_address Preferred address of a User.
Property subscription_list_ids Undocumented
Property subscriptions Undocumented
Class Variable _properties Undocumented
Class Variable _writable_properties Undocumented
Instance Variable _preferred_address Undocumented
Instance Variable _subscription_list_ids Undocumented
Instance Variable _subscriptions Undocumented

Inherited from RESTObject:

Method __getattr__ Undocumented
Method delete Undocumented

Inherited from RESTBase (via RESTObject):

Method save Undocumented
Property rest_data Get data from API and cache it (only once per instance).
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 _read_only_properties list of properties that cannot be written to (defaults to self_link only).
Instance Variable _changed_rest_data Undocumented
Instance Variable _connection Undocumented
Instance Variable _rest_data Undocumented
Instance Variable _url Undocumented

Inherited from PreferencesMixin (via RESTObject, RESTBase):

Property preferences Undocumented
def __init__(self, connection, url, data=None): (source)
overrides mailmanclient.restbase.base.RESTBase.__init__
Parameters
connection:Connection.An API connection object.
url:str.The url of the API endpoint.
data:dict.The initial data to use.
def __repr__(self): (source)
overrides mailmanclient.restbase.base.RESTBase.__repr__

Undocumented

def __setattr__(self, name, value): (source)
overrides mailmanclient.restbase.base.RESTObject.__setattr__

Special case for the password

def add_address(self, email, absorb_existing=False): (source)

Adds another email adress to the user record and returns an _Address object.

Parameters
email:str.The address to add
absorb_existing:bool.set this to True if you want to add the address even if it already exists. It will import the existing user into the current one, not overwriting any previously set value.
@preferred_address.setter
def preferred_address(self, email): (source)

Set a User's preferred address.

New in version 3.2.3.
Parameters
emailEmail to be set as the User's preferred address. If this address is not linked to the user, it will be linked to the user unless it is linked to an other user. If email is None, preferred address would be unset.
@property
addresses = (source)

Undocumented

@property
preferred_address = (source)

Preferred address of a User.

New in version 3.2.3.
Returns
Address or None.
@property
subscription_list_ids = (source)

Undocumented

@property
subscriptions = (source)

Undocumented

_properties: tuple[str, ...] = (source)
overrides mailmanclient.restbase.base.RESTBase._properties

Undocumented

_writable_properties: tuple[str, ...] = (source)
overrides mailmanclient.restbase.base.RESTBase._writable_properties

Undocumented

_preferred_address = (source)

Undocumented

_subscription_list_ids = (source)

Undocumented

_subscriptions = (source)

Undocumented