primitivedotdev 2.4.0__tar.gz → 2.6.0__tar.gz

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: primitivedotdev
-Version: 2.4.0
+Version: 2.6.0
 Summary: Official Primitive Python SDK for webhook handling and API access
 Project-URL: Homepage, https://primitive.dev
 Project-URL: Repository, https://github.com/primitivedotdev/sdks

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/json-schema/email-received-event.schema.json

@@ -203,6 +203,15 @@
             "relay": {
               "anyOf": [{ "$ref": "#/definitions/EmailRelay" }, { "type": "null" }],
               "description": "Set when the message reached Primitive through a Primitive mail relay. Null for other mail. The field may be absent; treat a missing value the same as null."
+            },
+            "automated": {
+              "type": "boolean",
+              "description": "Whether the message was sent by a machine rather than a person (bounce, auto-reply, list or bulk mail, report, or mail from the address it was delivered to). Same value GET /v1/emails/{id} returns. The field may be absent; treat a missing value as unknown."
+            },
+            "automated_reasons": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Why automated is true, in rule order; empty when it is false. Current values: null_envelope_sender, no_identifiable_sender, own_address, mailer_daemon, auto_submitted, precedence, list_unsubscribe, list_id, auto_response_suppress, failed_recipients, report. Treat an unfamiliar value as one added after your client was built."
             }
           },
           "required": [

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "primitivedotdev"
-version = "2.4.0"
+version = "2.6.0"
 description = "Official Primitive Python SDK for webhook handling and API access"
 readme = "README.md"
 requires-python = ">=3.11"

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/src/primitive/api/models/email_detail.py

@@ -91,9 +91,9 @@ class EmailDetail:
                 **This is the canonical "who sent this email" field for
                 most use cases**, including comparing against allowlists,
                 routing replies, or displaying the sender to a user. Use
-                `from_header` when you specifically need the display name,
-                or `sender`/`smtp_mail_from` when you need the SMTP
-                envelope value (e.g. to follow a bounce).
+                `from_name` when you need the display name, `from_header`
+                for the raw header, or `sender`/`smtp_mail_from` when you
+                need the SMTP envelope value (e.g. to follow a bounce).
             to_email (str): Parsed to address (same as recipient)
             sender_connected_agent_verified (bool): True only when this inbound message matches a send made with the
                 current key bound to its sender address as a connected agent.
@@ -219,10 +219,20 @@ class EmailDetail:
             smtp_rcpt_to (list[str] | None | Unset):
             from_header (None | str | Unset): Raw `From:` header from the message body, including any
                 display name (e.g. `"Alice Example" <alice@example.com>`).
-                Use this when you need the display name for rendering.
+                The display name in this raw value may be RFC 2047 encoded
+                (`=?UTF-8?Q?...?=`); use `from_name` for the decoded name.
 
                 For the bare email address (display name stripped), use
                 `from_email`.
+            from_name (None | str | Unset): Display name from the `From:` header, decoded for display:
+                RFC 2047 encoded words are decoded in their declared charset
+                and folded lines are joined (e.g. `Dana Rúiz` for
+                `=?UTF-8?Q?Dana_R=C3=BAiz?= <dana@example.com>`). Null when
+                the header carries no display name, and may be absent; treat
+                a missing value the same as null.
+
+                For display only: the sender chooses this name freely, so
+                identify the sender by `from_email`, never by this name.
             content_discarded_at (datetime.datetime | None | Unset):
             content_discarded_by_delivery_id (None | str | Unset):
             from_known_address (bool | Unset): True when the inbound's sender address has a matching grant
@@ -321,6 +331,7 @@ class EmailDetail:
     smtp_mail_from: None | str | Unset = UNSET
     smtp_rcpt_to: list[str] | None | Unset = UNSET
     from_header: None | str | Unset = UNSET
+    from_name: None | str | Unset = UNSET
     content_discarded_at: datetime.datetime | None | Unset = UNSET
     content_discarded_by_delivery_id: None | str | Unset = UNSET
     from_known_address: bool | Unset = UNSET
@@ -531,6 +542,12 @@ class EmailDetail:
         else:
             from_header = self.from_header
 
+        from_name: None | str | Unset
+        if isinstance(self.from_name, Unset):
+            from_name = UNSET
+        else:
+            from_name = self.from_name
+
         content_discarded_at: None | str | Unset
         if isinstance(self.content_discarded_at, Unset):
             content_discarded_at = UNSET
@@ -677,6 +694,8 @@ class EmailDetail:
             field_dict["smtp_rcpt_to"] = smtp_rcpt_to
         if from_header is not UNSET:
             field_dict["from_header"] = from_header
+        if from_name is not UNSET:
+            field_dict["from_name"] = from_name
         if content_discarded_at is not UNSET:
             field_dict["content_discarded_at"] = content_discarded_at
         if content_discarded_by_delivery_id is not UNSET:
@@ -1073,6 +1092,16 @@ class EmailDetail:
         from_header = _parse_from_header(d.pop("from_header", UNSET))
 
 
+        def _parse_from_name(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        from_name = _parse_from_name(d.pop("from_name", UNSET))
+
+
         def _parse_content_discarded_at(data: object) -> datetime.datetime | None | Unset:
             if data is None:
                 return data
@@ -1300,6 +1329,7 @@ class EmailDetail:
             smtp_mail_from=smtp_mail_from,
             smtp_rcpt_to=smtp_rcpt_to,
             from_header=from_header,
+            from_name=from_name,
             content_discarded_at=content_discarded_at,
             content_discarded_by_delivery_id=content_discarded_by_delivery_id,
             from_known_address=from_known_address,

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/src/primitive/api/models/email_search_result.py

@@ -205,6 +205,15 @@ class EmailSearchResult:
                 anything other than `pending`.
             relay (EmailSummaryRelayType0 | None | Unset): Set when the message reached Primitive through a Primitive mail
                 relay. Null for other mail. The field may be absent; treat a missing value the same as null.
+            from_name (None | str | Unset): Display name from the `From:` header, decoded for display:
+                RFC 2047 encoded words are decoded in their declared charset
+                and folded lines are joined (e.g. `Dana Rúiz` for
+                `=?UTF-8?Q?Dana_R=C3=BAiz?= <dana@example.com>`). Null when
+                the header carries no display name, and may be absent; treat
+                a missing value the same as null.
+
+                For display only: the sender chooses this name freely, so
+                identify the sender by `from_email`, never by this name.
             score (float | Unset): Relevance score. Present only when sorting by relevance.
             highlights (EmailSearchHighlights | Unset):
      """
@@ -242,6 +251,7 @@ class EmailSearchResult:
     interaction_kind: None | str | Unset = UNSET
     interaction_candidate: bool | Unset = UNSET
     relay: EmailSummaryRelayType0 | None | Unset = UNSET
+    from_name: None | str | Unset = UNSET
     score: float | Unset = UNSET
     highlights: EmailSearchHighlights | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
@@ -405,6 +415,12 @@ class EmailSearchResult:
         else:
             relay = self.relay
 
+        from_name: None | str | Unset
+        if isinstance(self.from_name, Unset):
+            from_name = UNSET
+        else:
+            from_name = self.from_name
+
         score = self.score
 
         highlights: dict[str, Any] | Unset = UNSET
@@ -465,6 +481,8 @@ class EmailSearchResult:
             field_dict["interaction_candidate"] = interaction_candidate
         if relay is not UNSET:
             field_dict["relay"] = relay
+        if from_name is not UNSET:
+            field_dict["from_name"] = from_name
         if score is not UNSET:
             field_dict["score"] = score
         if highlights is not UNSET:
@@ -804,6 +822,16 @@ class EmailSearchResult:
         relay = _parse_relay(d.pop("relay", UNSET))
 
 
+        def _parse_from_name(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        from_name = _parse_from_name(d.pop("from_name", UNSET))
+
+
         score = d.pop("score", UNSET)
 
         _highlights = d.pop("highlights", UNSET)
@@ -850,6 +878,7 @@ class EmailSearchResult:
             interaction_kind=interaction_kind,
             interaction_candidate=interaction_candidate,
             relay=relay,
+            from_name=from_name,
             score=score,
             highlights=highlights,
         )

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/src/primitive/api/models/email_summary.py

@@ -198,6 +198,15 @@ class EmailSummary:
                 anything other than `pending`.
             relay (EmailSummaryRelayType0 | None | Unset): Set when the message reached Primitive through a Primitive mail
                 relay. Null for other mail. The field may be absent; treat a missing value the same as null.
+            from_name (None | str | Unset): Display name from the `From:` header, decoded for display:
+                RFC 2047 encoded words are decoded in their declared charset
+                and folded lines are joined (e.g. `Dana Rúiz` for
+                `=?UTF-8?Q?Dana_R=C3=BAiz?= <dana@example.com>`). Null when
+                the header carries no display name, and may be absent; treat
+                a missing value the same as null.
+
+                For display only: the sender chooses this name freely, so
+                identify the sender by `from_email`, never by this name.
      """
 
     id: UUID
@@ -230,6 +239,7 @@ class EmailSummary:
     interaction_kind: None | str | Unset = UNSET
     interaction_candidate: bool | Unset = UNSET
     relay: EmailSummaryRelayType0 | None | Unset = UNSET
+    from_name: None | str | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
 
@@ -386,6 +396,12 @@ class EmailSummary:
         else:
             relay = self.relay
 
+        from_name: None | str | Unset
+        if isinstance(self.from_name, Unset):
+            from_name = UNSET
+        else:
+            from_name = self.from_name
+
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
@@ -438,6 +454,8 @@ class EmailSummary:
             field_dict["interaction_candidate"] = interaction_candidate
         if relay is not UNSET:
             field_dict["relay"] = relay
+        if from_name is not UNSET:
+            field_dict["from_name"] = from_name
 
         return field_dict
 
@@ -765,6 +783,16 @@ class EmailSummary:
         relay = _parse_relay(d.pop("relay", UNSET))
 
 
+        def _parse_from_name(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        from_name = _parse_from_name(d.pop("from_name", UNSET))
+
+
         email_summary = cls(
             id=id,
             status=status,
@@ -796,6 +824,7 @@ class EmailSummary:
             interaction_kind=interaction_kind,
             interaction_candidate=interaction_candidate,
             relay=relay,
+            from_name=from_name,
         )
 
 

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/src/primitive/models_generated.py

@@ -1198,6 +1198,18 @@ class Email(BaseModel):
             description="Set when the message reached Primitive through a Primitive mail relay. Null for other mail. The field may be absent; treat a missing value the same as null."
         ),
     ] = None
+    automated: Annotated[
+        bool | None,
+        Field(
+            description="Whether the message was sent by a machine rather than a person (bounce, auto-reply, list or bulk mail, report, or mail from the address it was delivered to). Same value GET /v1/emails/{id} returns. The field may be absent; treat a missing value as unknown."
+        ),
+    ] = None
+    automated_reasons: Annotated[
+        list[str] | None,
+        Field(
+            description="Why automated is true, in rule order; empty when it is false. Current values: null_envelope_sender, no_identifiable_sender, own_address, mailer_daemon, auto_submitted, precedence, list_unsubscribe, list_id, auto_response_suppress, failed_recipients, report. Treat an unfamiliar value as one added after your client was built."
+        ),
+    ] = None
 
 
 class EmailReceivedEvent(BaseModel):

{primitivedotdev-2.4.0 → primitivedotdev-2.6.0}/src/primitive/schemas/email_received_event.schema.json

@@ -203,6 +203,15 @@
             "relay": {
               "anyOf": [{ "$ref": "#/definitions/EmailRelay" }, { "type": "null" }],
               "description": "Set when the message reached Primitive through a Primitive mail relay. Null for other mail. The field may be absent; treat a missing value the same as null."
+            },
+            "automated": {
+              "type": "boolean",
+              "description": "Whether the message was sent by a machine rather than a person (bounce, auto-reply, list or bulk mail, report, or mail from the address it was delivered to). Same value GET /v1/emails/{id} returns. The field may be absent; treat a missing value as unknown."
+            },
+            "automated_reasons": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Why automated is true, in rule order; empty when it is false. Current values: null_envelope_sender, no_identifiable_sender, own_address, mailer_daemon, auto_submitted, precedence, list_unsubscribe, list_id, auto_response_suppress, failed_recipients, report. Treat an unfamiliar value as one added after your client was built."
             }
           },
           "required": [