Skip to content

drafts

Drafts

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Draft API

The Drafts API allows you to create, read, update, and delete drafts and send them as messages.

Source code in nylas/resources/drafts.py 
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
class Drafts(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Nylas Draft API

    The Drafts API allows you to create, read, update, and delete drafts and send them as messages.
    """

    def list(
        self,
        identifier: str,
        query_params: Optional[ListDraftsQueryParams] = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Draft]:
        """
        Return all Drafts.

        Args:
            identifier: The identifier of the grant to get drafts for.
            query_params: The query parameters to filter drafts by.
            overrides: The request overrides to use for the request.

        Returns:
            A list of Drafts.
        """
        return super().list(
            path=f"/v3/grants/{identifier}/drafts",
            response_type=Draft,
            query_params=query_params,
            overrides=overrides,
        )

    def find(
        self,
        identifier: str,
        draft_id: str,
        overrides: RequestOverrides = None,
    ) -> Response[Draft]:
        """
        Return a Draft.

        Args:
            identifier: The identifier of the grant to get the draft for.
            draft_id: The identifier of the draft to get.
            overrides: The request overrides to use for the request.

        Returns:
            The requested Draft.
        """
        return super().find(
            path=f"/v3/grants/{identifier}/drafts/{draft_id}",
            response_type=Draft,
            overrides=overrides,
        )

    def create(
        self,
        identifier: str,
        request_body: CreateDraftRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Draft]:
        """
        Create a Draft.

        Args:
            identifier: The identifier of the grant to send the message for.
            request_body: The request body to create a draft with.
            overrides: The request overrides to use for the request.

        Returns:
            The newly created Draft.
        """
        path = f"/v3/grants/{identifier}/drafts"

        # Use form data only if the attachment size is greater than 3mb
        attachment_size = sum(
            attachment.get("size", 0)
            for attachment in request_body.get("attachments", [])
        )
        if attachment_size >= MAXIMUM_JSON_ATTACHMENT_SIZE:
            json_response = self._http_client._execute(
                method="POST",
                path=path,
                data=_build_form_request(request_body),
                overrides=overrides,
            )

            return Response.from_dict(json_response, Draft)

        # Encode the content of the attachments to base64
        for attachment in request_body.get("attachments", []):
            if issubclass(type(attachment["content"]), io.IOBase):
                attachment["content"] = encode_stream_to_base64(attachment["content"])

        return super().create(
            path=path,
            response_type=Draft,
            request_body=request_body,
            overrides=overrides,
        )

    def update(
        self,
        identifier: str,
        draft_id: str,
        request_body: UpdateDraftRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Draft]:
        """
        Update a Draft.

        Args:
            identifier: The identifier of the grant to update the draft for.
            draft_id: The identifier of the draft to update.
            request_body: The request body to update the draft with.
            overrides: The request overrides to use for the request.

        Returns:
            The updated Draft.
        """
        path = f"/v3/grants/{identifier}/drafts/{draft_id}"

        # Use form data only if the attachment size is greater than 3mb
        attachment_size = sum(
            attachment.get("size", 0)
            for attachment in request_body.get("attachments", [])
        )
        if attachment_size >= MAXIMUM_JSON_ATTACHMENT_SIZE:
            json_response = self._http_client._execute(
                method="PUT",
                path=path,
                data=_build_form_request(request_body),
                overrides=overrides,
            )

            return Response.from_dict(json_response, Draft)

        # Encode the content of the attachments to base64
        for attachment in request_body.get("attachments", []):
            if issubclass(type(attachment["content"]), io.IOBase):
                attachment["content"] = encode_stream_to_base64(attachment["content"])

        return super().update(
            path=path,
            response_type=Draft,
            request_body=request_body,
            overrides=overrides,
        )

    def destroy(
        self,
        identifier: str,
        draft_id: str,
        overrides: RequestOverrides = None,
    ) -> DeleteResponse:
        """
        Delete a Draft.

        Args:
            identifier: The identifier of the grant to delete the draft for.
            draft_id: The identifier of the draft to delete.
            overrides: The request overrides to use for the request.

        Returns:
            The deletion response.
        """
        return super().destroy(
            path=f"/v3/grants/{identifier}/drafts/{draft_id}",
            overrides=overrides,
        )

    def send(
        self,
        identifier: str,
        draft_id: str,
        overrides: RequestOverrides = None,
    ) -> Response[Message]:
        """
        Send a Draft.

        Args:
            identifier: The identifier of the grant to send the draft for.
            draft_id: The identifier of the draft to send.
            overrides: The request overrides to use for the request.
        """
        json_response = self._http_client._execute(
            method="POST",
            path=f"/v3/grants/{identifier}/drafts/{draft_id}",
            overrides=overrides,
        )

        return Response.from_dict(json_response, Message)

create(identifier, request_body, overrides=None)

Create a Draft.

Parameters:

Name Type Description Default
identifier str

The identifier of the grant to send the message for.

 required
request_body CreateDraftRequest

The request body to create a draft with.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Draft]

The newly created Draft.
Source code in nylas/resources/drafts.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def create(
    self,
    identifier: str,
    request_body: CreateDraftRequest,
    overrides: RequestOverrides = None,
) -> Response[Draft]:
    """
    Create a Draft.

    Args:
        identifier: The identifier of the grant to send the message for.
        request_body: The request body to create a draft with.
        overrides: The request overrides to use for the request.

    Returns:
        The newly created Draft.
    """
    path = f"/v3/grants/{identifier}/drafts"

    # Use form data only if the attachment size is greater than 3mb
    attachment_size = sum(
        attachment.get("size", 0)
        for attachment in request_body.get("attachments", [])
    )
    if attachment_size >= MAXIMUM_JSON_ATTACHMENT_SIZE:
        json_response = self._http_client._execute(
            method="POST",
            path=path,
            data=_build_form_request(request_body),
            overrides=overrides,
        )

        return Response.from_dict(json_response, Draft)

    # Encode the content of the attachments to base64
    for attachment in request_body.get("attachments", []):
        if issubclass(type(attachment["content"]), io.IOBase):
            attachment["content"] = encode_stream_to_base64(attachment["content"])

    return super().create(
        path=path,
        response_type=Draft,
        request_body=request_body,
        overrides=overrides,
    )

destroy(identifier, draft_id, overrides=None)

Delete a Draft.

Parameters:

Name Type Description Default
identifier str

The identifier of the grant to delete the draft for.

 required
draft_id str

The identifier of the draft to delete.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/drafts.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
def destroy(
    self,
    identifier: str,
    draft_id: str,
    overrides: RequestOverrides = None,
) -> DeleteResponse:
    """
    Delete a Draft.

    Args:
        identifier: The identifier of the grant to delete the draft for.
        draft_id: The identifier of the draft to delete.
        overrides: The request overrides to use for the request.

    Returns:
        The deletion response.
    """
    return super().destroy(
        path=f"/v3/grants/{identifier}/drafts/{draft_id}",
        overrides=overrides,
    )

find(identifier, draft_id, overrides=None)

Return a Draft.

Parameters:

Name Type Description Default
identifier str

The identifier of the grant to get the draft for.

 required
draft_id str

The identifier of the draft to get.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Draft]

The requested Draft.
Source code in nylas/resources/drafts.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def find(
    self,
    identifier: str,
    draft_id: str,
    overrides: RequestOverrides = None,
) -> Response[Draft]:
    """
    Return a Draft.

    Args:
        identifier: The identifier of the grant to get the draft for.
        draft_id: The identifier of the draft to get.
        overrides: The request overrides to use for the request.

    Returns:
        The requested Draft.
    """
    return super().find(
        path=f"/v3/grants/{identifier}/drafts/{draft_id}",
        response_type=Draft,
        overrides=overrides,
    )

list(identifier, query_params=None, overrides=None)

Return all Drafts.

Parameters:

Name Type Description Default
identifier str

The identifier of the grant to get drafts for.

 required
query_params Optional[ListDraftsQueryParams]

The query parameters to filter drafts by.

 None
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
ListResponse[Draft]

A list of Drafts.
Source code in nylas/resources/drafts.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def list(
    self,
    identifier: str,
    query_params: Optional[ListDraftsQueryParams] = None,
    overrides: RequestOverrides = None,
) -> ListResponse[Draft]:
    """
    Return all Drafts.

    Args:
        identifier: The identifier of the grant to get drafts for.
        query_params: The query parameters to filter drafts by.
        overrides: The request overrides to use for the request.

    Returns:
        A list of Drafts.
    """
    return super().list(
        path=f"/v3/grants/{identifier}/drafts",
        response_type=Draft,
        query_params=query_params,
        overrides=overrides,
    )

send(identifier, draft_id, overrides=None)

Send a Draft.

Parameters:

Name Type Description Default
identifier str

The identifier of the grant to send the draft for.

 required
draft_id str

The identifier of the draft to send.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None
Source code in nylas/resources/drafts.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def send(
    self,
    identifier: str,
    draft_id: str,
    overrides: RequestOverrides = None,
) -> Response[Message]:
    """
    Send a Draft.

    Args:
        identifier: The identifier of the grant to send the draft for.
        draft_id: The identifier of the draft to send.
        overrides: The request overrides to use for the request.
    """
    json_response = self._http_client._execute(
        method="POST",
        path=f"/v3/grants/{identifier}/drafts/{draft_id}",
        overrides=overrides,
    )

    return Response.from_dict(json_response, Message)

update(identifier, draft_id, request_body, overrides=None)

Update a Draft.

Parameters:

Name Type Description Default
identifier str

The identifier of the grant to update the draft for.

 required
draft_id str

The identifier of the draft to update.

 required
request_body UpdateDraftRequest

The request body to update the draft with.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Draft]

The updated Draft.
Source code in nylas/resources/drafts.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def update(
    self,
    identifier: str,
    draft_id: str,
    request_body: UpdateDraftRequest,
    overrides: RequestOverrides = None,
) -> Response[Draft]:
    """
    Update a Draft.

    Args:
        identifier: The identifier of the grant to update the draft for.
        draft_id: The identifier of the draft to update.
        request_body: The request body to update the draft with.
        overrides: The request overrides to use for the request.

    Returns:
        The updated Draft.
    """
    path = f"/v3/grants/{identifier}/drafts/{draft_id}"

    # Use form data only if the attachment size is greater than 3mb
    attachment_size = sum(
        attachment.get("size", 0)
        for attachment in request_body.get("attachments", [])
    )
    if attachment_size >= MAXIMUM_JSON_ATTACHMENT_SIZE:
        json_response = self._http_client._execute(
            method="PUT",
            path=path,
            data=_build_form_request(request_body),
            overrides=overrides,
        )

        return Response.from_dict(json_response, Draft)

    # Encode the content of the attachments to base64
    for attachment in request_body.get("attachments", []):
        if issubclass(type(attachment["content"]), io.IOBase):
            attachment["content"] = encode_stream_to_base64(attachment["content"])

    return super().update(
        path=path,
        response_type=Draft,
        request_body=request_body,
        overrides=overrides,
    )