newsletter.models

Attributes

newsletter_recipients

Classes

Newsletter	Represents a newsletter before and after it is sent.
Recipient	Represents a single recipient.
Subscription	Adds subscription management to a recipient.

Module Contents

newsletter.models.newsletter_recipients

class newsletter.models.Newsletter

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, onegov.core.orm.mixins.TimestampMixin, onegov.search.SearchableContent

Represents a newsletter before and after it is sent.

A newsletter basically consists of a title/subject, a content and a number of recipients. We assume that all newsletters are sent in HTML using onegov.core, which automatically creates a text representation.

__tablename__ = 'newsletters'

es_id = 'name'

The name of the id attribute (not the actual value!).

If you use this on an ORM model, be sure to use a primary key, all other properties are not available during deletion.

es_properties

Returns the type mapping of this model. Each property in the mapping will be read from the model instance.

The returned object needs to be a dict or an object that provides a to_dict method.

Internally, onegov.search stores differing languages in different indices. It does this automatically through langauge detection, or by manually specifying a language.

Note that objects with multiple languages are not supported (each object is supposed to have exactly one language).

Onegov.search will automatically insert the right analyzer for types like these.

There’s currently only limited support for properties here, namely objects and nested mappings do not work! This is going to be added in the future though.

property es_public: bool

Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results.

name: Column[str]

validate_name(key: str, name: str) → str

title: Column[str]

lead: Column[str | None]

html: Column[str]

sent: Column[datetime | None]

scheduled: Column[datetime | None]

recipients: relationship[list[Recipient]]

property open_recipients: tuple[Recipient, Ellipsis]

show_news_as_tiles: onegov.core.orm.mixins.dict_property[bool]

newsletter_categories: onegov.core.orm.mixins.dict_property[list[str] | None]

class newsletter.models.Recipient

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin, onegov.core.orm.mixins.ContentMixin

Represents a single recipient.

Recipients may be grouped by any kind of string. Only inside their groups are recipient addresses unique. However, groups are an optional feature and they are not deeply integrated. If you don’t care for group, never use them and the list becomes like a simple list of addresses with no duplicate addresses present.

__tablename__ = 'recipients'

id: Column[uuid.UUID]

address: Column[str]

validate_address(key: str, address: str) → str

group: Column[str | None]

newsletters: relationship[list[Newsletter]]

token: Column[str]

confirmed: Column[bool]

subscribed_categories: onegov.core.orm.mixins.dict_property[list[str] | None]

property __table_args__: tuple[sqlalchemy.Index, Ellipsis]

property subscription: Subscription

class newsletter.models.Subscription(recipient: Recipient, token: str)

Adds subscription management to a recipient.

recipient

token

property recipient_id: uuid.UUID

confirm() → bool

unsubscribe() → bool