Blame - docs/dyn/gmail_v1.users.drafts.html - platform/external/python/google-api-python-client

2020-07-22 17:02:09 -0700

[diff] [blame]

127

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

128

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

129

{

130

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

131

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

132

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

133

],

134

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

135

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

136

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

137

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

138

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

139

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

140

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

141

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

142

"id": "A String", # The immutable ID of the message.

143

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

144

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

145

"historyId": "A String", # The ID of the last history record that modified this message.

146

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

147

},

148

"id": "A String", # The immutable ID of the draft.

149

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

150

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

151

x__xgafv: string, V1 error format.

152

Allowed values

153

1 - v1 error format

154

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

155

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

156

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

157

158

Returns:

159

An object of the form:

160

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

{ # A draft email in the user's mailbox.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

162

"message": { # An email message. # The message content of the draft.

163

"sizeEstimate": 42, # Estimated size in bytes of the message.

164

"snippet": "A String", # A short part of the message text.

165

"labelIds": [ # List of IDs of labels applied to this message.

166

"A String",

167

],

168

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

169

"mimeType": "A String", # The MIME type of the message part.

170

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

171

# Object with schema name: MessagePart

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

172

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

173

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

174

{

175

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

176

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

177

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

178

],

179

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

180

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

181

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

182

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

183

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

184

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

185

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

186

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

187

"id": "A String", # The immutable ID of the message.

188

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

189

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

190

"historyId": "A String", # The ID of the last history record that modified this message.

191

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

192

},

193

"id": "A String", # The immutable ID of the draft.

194

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

198

<code class="details" id="delete">delete(userId, id, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

199

<pre>Immediately and permanently deletes the specified draft. Does not simply trash it.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

200

201

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

202

userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

203

id: string, The ID of the draft to delete. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

204

x__xgafv: string, V1 error format.

205

Allowed values

206

1 - v1 error format

207

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

212

<code class="details" id="get">get(userId, id, format=None, x__xgafv=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

213

<pre>Gets the specified draft.

214

215

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

216

userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

217

id: string, The ID of the draft to retrieve. (required)

218

format: string, The format to return the draft in.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

219

Allowed values

220

minimal - Returns only email message ID and labels; does not return the email headers, body, or payload.

221

full - Returns the full email message data with body content parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.

222

raw - Returns the full email message data with body content in the `raw` field as a base64url encoded string; the `payload` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.

223

metadata - Returns only email message ID, labels, and email headers.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

224

x__xgafv: string, V1 error format.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

225

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

226

1 - v1 error format

227

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

228

229

Returns:

230

An object of the form:

231

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

{ # A draft email in the user's mailbox.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

233

"message": { # An email message. # The message content of the draft.

234

"sizeEstimate": 42, # Estimated size in bytes of the message.

235

"snippet": "A String", # A short part of the message text.

236

"labelIds": [ # List of IDs of labels applied to this message.

237

"A String",

238

],

239

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

240

"mimeType": "A String", # The MIME type of the message part.

241

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

242

# Object with schema name: MessagePart

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

243

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

244

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

245

{

246

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

247

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

248

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

249

],

250

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

251

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

252

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

253

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

254

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

255

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

256

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

257

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

258

"id": "A String", # The immutable ID of the message.

259

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

260

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

261

"historyId": "A String", # The ID of the last history record that modified this message.

262

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

263

},

264

"id": "A String", # The immutable ID of the draft.

265

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

269

<code class="details" id="list">list(userId, q=None, pageToken=None, maxResults=None, includeSpamTrash=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

270

<pre>Lists the drafts in the user's mailbox.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

271

272

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

273

userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)

274

q: string, Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

275

pageToken: string, Page token to retrieve a specific page of results in the list.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

276

maxResults: integer, Maximum number of drafts to return.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

277

includeSpamTrash: boolean, Include drafts from `SPAM` and `TRASH` in the results.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

278

x__xgafv: string, V1 error format.

279

Allowed values

280

1 - v1 error format

281

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

282

283

Returns:

284

An object of the form:

285

286

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

287

"resultSizeEstimate": 42, # Estimated total number of results.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

288

"nextPageToken": "A String", # Token to retrieve the next page of results in the list.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

289

"drafts": [ # List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The messages.get method can fetch additional message details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

{ # A draft email in the user's mailbox.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

291

"message": { # An email message. # The message content of the draft.

292

"sizeEstimate": 42, # Estimated size in bytes of the message.

293

"snippet": "A String", # A short part of the message text.

294

"labelIds": [ # List of IDs of labels applied to this message.

295

"A String",

296

],

297

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

298

"mimeType": "A String", # The MIME type of the message part.

299

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

300

# Object with schema name: MessagePart

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

301

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

302

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

303

{

304

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

305

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

306

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

307

],

308

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

309

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

310

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

311

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

312

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

313

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

314

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

315

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

316

"id": "A String", # The immutable ID of the message.

317

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

318

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

319

"historyId": "A String", # The ID of the last history record that modified this message.

320

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

321

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

322

"id": "A String", # The immutable ID of the draft.

323

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

330

<pre>Retrieves the next page of results.

331

332

Args:

333

previous_request: The request for the previous page. (required)

334

previous_response: The response from the request for the previous page. (required)

335

336

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

337

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

338

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

343

<code class="details" id="send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

344

<pre>Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

345

346

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

347

userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

348

body: object, The request body.

349

The object takes the form of:

350

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

351

{ # A draft email in the user's mailbox.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

352

"message": { # An email message. # The message content of the draft.

353

"sizeEstimate": 42, # Estimated size in bytes of the message.

354

"snippet": "A String", # A short part of the message text.

355

"labelIds": [ # List of IDs of labels applied to this message.

356

"A String",

357

],

358

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

359

"mimeType": "A String", # The MIME type of the message part.

360

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

361

# Object with schema name: MessagePart

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

362

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

363

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

364

{

365

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

366

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

367

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

368

],

369

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

370

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

371

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

372

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

373

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

374

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

375

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

376

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

377

"id": "A String", # The immutable ID of the message.

378

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

379

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

380

"historyId": "A String", # The ID of the last history record that modified this message.

381

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

382

},

383

"id": "A String", # The immutable ID of the draft.

384

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

385

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

386

x__xgafv: string, V1 error format.

387

Allowed values

388

1 - v1 error format

389

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

390

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

391

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

392

393

Returns:

394

An object of the form:

395

396

{ # An email message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

397

"sizeEstimate": 42, # Estimated size in bytes of the message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

398

"snippet": "A String", # A short part of the message text.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

399

"labelIds": [ # List of IDs of labels applied to this message.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

400

"A String",

401

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

402

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

403

"mimeType": "A String", # The MIME type of the message part.

404

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

405

# Object with schema name: MessagePart

406

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

407

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

408

{

409

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

410

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

411

},

412

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

413

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

414

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

415

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

416

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

417

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

418

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

419

"partId": "A String", # The immutable ID of the message part.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

420

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

421

"id": "A String", # The immutable ID of the message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

422

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

423

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

424

"historyId": "A String", # The ID of the last history record that modified this message.

425

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

430

<code class="details" id="update">update(userId, id, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

431

<pre>Replaces a draft's content.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

432

433

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

434

userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

435

id: string, The ID of the draft to update. (required)

436

body: object, The request body.

437

The object takes the form of:

438

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

{ # A draft email in the user's mailbox.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

440

"message": { # An email message. # The message content of the draft.

441

"sizeEstimate": 42, # Estimated size in bytes of the message.

442

"snippet": "A String", # A short part of the message text.

443

"labelIds": [ # List of IDs of labels applied to this message.

444

"A String",

445

],

446

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

447

"mimeType": "A String", # The MIME type of the message part.

448

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

449

# Object with schema name: MessagePart

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

450

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

451

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

452

{

453

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

454

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

455

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

456

],

457

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

458

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

459

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

460

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

461

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

462

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

463

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

464

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

465

"id": "A String", # The immutable ID of the message.

466

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

467

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

468

"historyId": "A String", # The ID of the last history record that modified this message.

469

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

470

},

471

"id": "A String", # The immutable ID of the draft.

472

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

473

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

474

x__xgafv: string, V1 error format.

475

Allowed values

476

1 - v1 error format

477

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

478

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

479

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

480

481

Returns:

482

An object of the form:

483

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

484

{ # A draft email in the user's mailbox.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

485

"message": { # An email message. # The message content of the draft.

486

"sizeEstimate": 42, # Estimated size in bytes of the message.

487

"snippet": "A String", # A short part of the message text.

488

"labelIds": [ # List of IDs of labels applied to this message.

489

"A String",

490

],

491

"payload": { # A single MIME message part. # The parsed email structure in the message parts.

492

"mimeType": "A String", # The MIME type of the message part.

493

"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

494

# Object with schema name: MessagePart

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

495

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

496

"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

497

{

498

"name": "A String", # The name of the header before the `:` separator. For example, `To`.

499

"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

500

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

501

],

502

"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.

503

"body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.

504

"attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

505

"size": 42, # Number of bytes for the message part data (encoding notwithstanding).

506

"data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

507

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

508

"partId": "A String", # The immutable ID of the message part.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

509

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

510

"id": "A String", # The immutable ID of the message.

511

"internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

512

"raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

513

"historyId": "A String", # The ID of the last history record that modified this message.

514

"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

515

},

516

"id": "A String", # The immutable ID of the draft.

517

}</pre>

Craig Citro