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'

fts_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.

fts_properties

property fts_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: sqlalchemy.Column[str]

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

title: sqlalchemy.Column[str]

lead: sqlalchemy.Column[str | None]

html: sqlalchemy.Column[str]

closing_remark

sent: sqlalchemy.Column[datetime.datetime | None]

scheduled: sqlalchemy.Column[datetime.datetime | None]

recipients: sqlalchemy.orm.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: sqlalchemy.Column[uuid.UUID]

address: sqlalchemy.Column[str]

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

group: sqlalchemy.Column[str | None]

newsletters: sqlalchemy.orm.relationship[list[Newsletter]]

token: sqlalchemy.Column[str]

confirmed: sqlalchemy.Column[bool]

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

daily_newsletter: sqlalchemy.Column[bool]

property __table_args__: tuple[sqlalchemy.Index, Ellipsis]

property subscription: Subscription

property is_inactive: bool

Checks if the recipient’s email address is marked as inactive.

Returns:

bool: True if the email address is marked as inactive, False otherwise.

mark_inactive() → None

Marks the recipient’s email address as inactive.

This method sets the ‘inactive’ flag in the recipient’s metadata to True. It is typically used when a bounce event causes the email address to be deactivated by Postmark.

reactivate() → None

Marks a previously inactive recipient as active again.

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