Skip to content

policies

CreatePolicyRequest

Bases: TypedDict

Request body for creating a policy.

Source code in nylas/models/policies.py 
50
51
52
53
54
55
56
57
class CreatePolicyRequest(TypedDict):
    """Request body for creating a policy."""

    name: str
    options: NotRequired[PolicyOptionsRequest]
    limits: NotRequired[PolicyLimitsRequest]
    rules: NotRequired[List[str]]
    spam_detection: NotRequired[PolicySpamDetectionRequest]

ListPoliciesQueryParams

Bases: ListQueryParams

Query parameters for listing policies.

Attributes:

Name Type Description
limit

Maximum number of objects to return.
page_token

Cursor for the next page (from next_cursor on the previous response).
Source code in nylas/models/policies.py 
10
11
12
13
14
15
16
17
18
19
class ListPoliciesQueryParams(ListQueryParams):
    """
    Query parameters for listing policies.

    Attributes:
        limit: Maximum number of objects to return.
        page_token: Cursor for the next page (from ``next_cursor`` on the previous response).
    """

    pass

Policy dataclass

A policy for Nylas Agent Accounts.

Source code in nylas/models/policies.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@dataclass_json
@dataclass
class Policy:
    """A policy for Nylas Agent Accounts."""

    id: Optional[str] = None
    name: Optional[str] = None
    application_id: Optional[str] = None
    organization_id: Optional[str] = None
    options: Optional[PolicyOptions] = None
    limits: Optional[PolicyLimits] = None
    rules: Optional[List[str]] = None
    spam_detection: Optional[PolicySpamDetection] = None
    created_at: Optional[int] = None
    updated_at: Optional[int] = None

PolicyLimits dataclass

Operational limits applied to inboxes that use this policy.

Source code in nylas/models/policies.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
@dataclass_json
@dataclass
class PolicyLimits:
    """Operational limits applied to inboxes that use this policy."""

    limit_attachment_size_limit: Optional[int] = None
    limit_attachment_count_limit: Optional[int] = None
    limit_attachment_allowed_types: Optional[List[str]] = None
    limit_size_total_mime: Optional[int] = None
    limit_storage_total: Optional[int] = None
    limit_count_daily_message_per_grant: Optional[int] = None
    limit_inbox_retention_period: Optional[int] = None
    limit_spam_retention_period: Optional[int] = None

PolicyLimitsRequest

Bases: TypedDict

Request shape for policy limits.

Source code in nylas/models/policies.py 
29
30
31
32
33
34
35
36
37
38
39
class PolicyLimitsRequest(TypedDict, total=False):
    """Request shape for policy limits."""

    limit_attachment_size_limit: NotRequired[int]
    limit_attachment_count_limit: NotRequired[int]
    limit_attachment_allowed_types: NotRequired[List[str]]
    limit_size_total_mime: NotRequired[int]
    limit_storage_total: NotRequired[int]
    limit_count_daily_message_per_grant: NotRequired[int]
    limit_inbox_retention_period: NotRequired[int]
    limit_spam_retention_period: NotRequired[int]

PolicyOptions dataclass

Policy options applied to inboxes that use this policy.

Source code in nylas/models/policies.py 
70
71
72
73
74
75
76
@dataclass_json
@dataclass
class PolicyOptions:
    """Policy options applied to inboxes that use this policy."""

    additional_folders: Optional[List[str]] = None
    use_cidr_aliasing: Optional[bool] = None

PolicyOptionsRequest

Bases: TypedDict

Request shape for policy options.

Source code in nylas/models/policies.py 
22
23
24
25
26
class PolicyOptionsRequest(TypedDict, total=False):
    """Request shape for policy options."""

    additional_folders: NotRequired[List[str]]
    use_cidr_aliasing: NotRequired[bool]

PolicySpamDetection dataclass

Spam detection settings applied to inboxes that use this policy.

Source code in nylas/models/policies.py 
 94
 95
 96
 97
 98
 99
100
101
@dataclass_json
@dataclass
class PolicySpamDetection:
    """Spam detection settings applied to inboxes that use this policy."""

    use_list_dnsbl: Optional[bool] = None
    use_header_anomaly_detection: Optional[bool] = None
    spam_sensitivity: Optional[float] = None

PolicySpamDetectionRequest

Bases: TypedDict

Request shape for policy spam detection settings.

Source code in nylas/models/policies.py 
42
43
44
45
46
47
class PolicySpamDetectionRequest(TypedDict, total=False):
    """Request shape for policy spam detection settings."""

    use_list_dnsbl: NotRequired[bool]
    use_header_anomaly_detection: NotRequired[bool]
    spam_sensitivity: NotRequired[float]

UpdatePolicyRequest

Bases: TypedDict

Request body for updating a policy.

Source code in nylas/models/policies.py 
60
61
62
63
64
65
66
67
class UpdatePolicyRequest(TypedDict, total=False):
    """Request body for updating a policy."""

    name: NotRequired[str]
    options: NotRequired[PolicyOptionsRequest]
    limits: NotRequired[PolicyLimitsRequest]
    rules: NotRequired[List[str]]
    spam_detection: NotRequired[PolicySpamDetectionRequest]