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

2016-08-16 12:44:29 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a></h1>

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

78

<code><a href="gmail_v1.users.settings.delegates.html">delegates()</a></code>

79

</p>

80

<p class="firstline">Returns the delegates Resource.</p>

81

82

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

83

<code><a href="gmail_v1.users.settings.filters.html">filters()</a></code>

84

</p>

85

<p class="firstline">Returns the filters Resource.</p>

86

87

88

<code><a href="gmail_v1.users.settings.forwardingAddresses.html">forwardingAddresses()</a></code>

89

</p>

90

<p class="firstline">Returns the forwardingAddresses Resource.</p>

91

92

93

<code><a href="gmail_v1.users.settings.sendAs.html">sendAs()</a></code>

94

</p>

95

<p class="firstline">Returns the sendAs Resource.</p>

96

97

Bu Sun Kim

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

[diff] [blame^]

98

<code><a href="#getAutoForwarding">getAutoForwarding(userId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

99

<p class="firstline">Gets the auto-forwarding setting for the specified account.</p>

100

Bu Sun Kim

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

[diff] [blame^]

101

<code><a href="#getImap">getImap(userId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

102

<p class="firstline">Gets IMAP settings.</p>

103

Bu Sun Kim

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

[diff] [blame^]

104

<code><a href="#getLanguage">getLanguage(userId, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

105

<p class="firstline">Gets language settings.</p>

106

Bu Sun Kim

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

[diff] [blame^]

107

<code><a href="#getPop">getPop(userId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

108

<p class="firstline">Gets POP settings.</p>

109

Bu Sun Kim

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

[diff] [blame^]

110

<code><a href="#getVacation">getVacation(userId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

111

<p class="firstline">Gets vacation responder settings.</p>

112

Bu Sun Kim

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

[diff] [blame^]

113

<code><a href="#updateAutoForwarding">updateAutoForwarding(userId, body=None, x__xgafv=None)</a></code></p>

114

<p class="firstline">Updates the auto-forwarding setting for the specified account. A verified</p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

115

Bu Sun Kim

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

[diff] [blame^]

116

<code><a href="#updateImap">updateImap(userId, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

117

<p class="firstline">Updates IMAP settings.</p>

118

Bu Sun Kim

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

[diff] [blame^]

119

<code><a href="#updateLanguage">updateLanguage(userId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

120

<p class="firstline">Updates language settings.</p>

121

Bu Sun Kim

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

[diff] [blame^]

122

<code><a href="#updatePop">updatePop(userId, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

123

<p class="firstline">Updates POP settings.</p>

124

Bu Sun Kim

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

[diff] [blame^]

125

<code><a href="#updateVacation">updateVacation(userId, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

126

<p class="firstline">Updates vacation responder settings.</p>

127

<h3>Method Details</h3>

128

Bu Sun Kim

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

[diff] [blame^]

129

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

130

<pre>Gets the auto-forwarding setting for the specified account.

131

132

Args:

Bu Sun Kim

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

[diff] [blame^]

133

userId: string, User's email address. The special value "me"

134

can be used to indicate the authenticated user. (required)

135

x__xgafv: string, V1 error format.

136

Allowed values

137

1 - v1 error format

138

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

139

140

Returns:

141

An object of the form:

142

143

{ # Auto-forwarding settings for an account.

Bu Sun Kim

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

[diff] [blame^]

144

"enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.

145

"disposition": "A String", # The state that a message should be left in after it has been forwarded.

146

"emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email

147

# address must be a verified member of the forwarding addresses.

148

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

152

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

153

<pre>Gets IMAP settings.

154

155

Args:

Bu Sun Kim

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

[diff] [blame^]

156

userId: string, User's email address. The special value "me"

157

can be used to indicate the authenticated user. (required)

158

x__xgafv: string, V1 error format.

159

Allowed values

160

1 - v1 error format

161

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

162

163

Returns:

164

An object of the form:

165

166

{ # IMAP settings for an account.

Bu Sun Kim

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

[diff] [blame^]

167

"maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may

168

# contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero

169

# is interpreted to mean that there is no limit.

170

"autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is

171

# marked as deleted in IMAP. Otherwise, Gmail will wait for an update from

172

# the client before expunging messages marked as deleted.

173

"expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted

174

# and expunged from the last visible IMAP folder.

175

"enabled": True or False, # Whether IMAP is enabled for the account.

176

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

180

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

181

<pre>Gets language settings.

182

183

Args:

Bu Sun Kim

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

[diff] [blame^]

184

userId: string, User's email address. The special value "me"

185

can be used to indicate the authenticated user. (required)

186

x__xgafv: string, V1 error format.

187

Allowed values

188

1 - v1 error format

189

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

190

191

Returns:

192

An object of the form:

193

Bu Sun Kim

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

[diff] [blame^]

194

{ # Language settings for an account. These settings correspond to

195

# the <a href="https://support.google.com/mail/answer/17091">"Language

196

# settings"</a> feature in the web interface.

197

"displayLanguage": "A String", # The language to display Gmail in, formatted as an

198

# <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066

199

# Language Tag</a> (for example `en-GB`, `fr` or

200

# `ja` for British English, French, or Japanese respectively).

Bu Sun Kim

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

[diff] [blame]

201

#

Bu Sun Kim

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

[diff] [blame^]

202

# The set of languages supported by Gmail evolves over time, so please refer

203

# to the "Language" dropdown in the

204

# <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings

205

# </a> for all available options, as described in the

206

# <a href="https://support.google.com/mail/answer/17091">language settings

207

# help article</a>. A table of sample values is also provided in the

208

# <a href="/gmail/api/guides/language_settings#display_language">Managing

209

# Language Settings guide</a>

Bu Sun Kim

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

[diff] [blame]

210

#

Bu Sun Kim

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

[diff] [blame^]

211

# Not all Gmail clients can display the same set of languages. In the case

212

# that a user's display language is not available for use on a particular

213

# client, said client automatically chooses to display in the closest

214

# supported variant (or a reasonable default).

Bu Sun Kim

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

[diff] [blame]

215

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

219

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

220

<pre>Gets POP settings.

221

222

Args:

Bu Sun Kim

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

[diff] [blame^]

223

userId: string, User's email address. The special value "me"

224

can be used to indicate the authenticated user. (required)

225

x__xgafv: string, V1 error format.

226

Allowed values

227

1 - v1 error format

228

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

229

230

Returns:

231

An object of the form:

232

233

{ # POP settings for an account.

Bu Sun Kim

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

[diff] [blame^]

234

"disposition": "A String", # The action that will be executed on a message after it has been fetched via

235

# POP.

Bu Sun Kim

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

[diff] [blame]

236

"accessWindow": "A String", # The range of messages which are accessible via POP.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

241

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

242

<pre>Gets vacation responder settings.

243

244

Args:

Bu Sun Kim

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

[diff] [blame^]

245

userId: string, User's email address. The special value "me"

246

can be used to indicate the authenticated user. (required)

247

x__xgafv: string, V1 error format.

248

Allowed values

249

1 - v1 error format

250

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

251

252

Returns:

253

An object of the form:

254

Bu Sun Kim

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

[diff] [blame^]

255

{ # Vacation auto-reply settings for an account. These settings correspond to

256

# the <a href="https://support.google.com/mail/answer/25922">"Vacation

257

# responder"</a> feature in the web interface.

258

"startTime": "A String", # An optional start time for sending auto-replies (epoch ms).

259

# When this is specified, Gmail will automatically reply only to messages

260

# that it receives after the start time. If both `startTime` and

261

# `endTime` are specified, `startTime` must precede

262

# `endTime`.

263

"endTime": "A String", # An optional end time for sending auto-replies (epoch ms).

264

# When this is specified, Gmail will automatically reply only to messages

265

# that it receives before the end time. If both `startTime` and

266

# `endTime` are specified, `startTime` must precede

267

# `endTime`.

268

"responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before

269

# storing it. If both `response_body_plain_text` and

270

# `response_body_html` are specified,

271

# `response_body_html` will be used.

272

"responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In

273

# order to enable auto-replies, either the response subject or the response

274

# body must be nonempty.

275

"responseBodyPlainText": "A String", # Response body in plain text format. If both

276

# `response_body_plain_text` and `response_body_html`

277

# are specified, `response_body_html` will be used.

278

"restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not

279

# in the user's list of contacts.

Bu Sun Kim

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

[diff] [blame]

280

"enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.

Bu Sun Kim

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

[diff] [blame^]

281

"restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are

282

# outside of the user's domain. This feature is only available for G Suite

283

# users.

Bu Sun Kim

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

[diff] [blame]

284

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

288

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

289

<pre>Updates the auto-forwarding setting for the specified account. A verified

290

forwarding address must be specified when auto-forwarding is enabled.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

291

Bu Sun Kim

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

[diff] [blame^]

292

This method is only available to service account clients that have been

293

delegated domain-wide authority.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

294

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

295

Args:

Bu Sun Kim

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

[diff] [blame^]

296

userId: string, User's email address. The special value "me"

297

can be used to indicate the authenticated user. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

298

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

299

The object takes the form of:

300

301

{ # Auto-forwarding settings for an account.

Bu Sun Kim

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

[diff] [blame^]

302

"enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.

303

"disposition": "A String", # The state that a message should be left in after it has been forwarded.

304

"emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email

305

# address must be a verified member of the forwarding addresses.

306

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

307

Bu Sun Kim

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

[diff] [blame^]

308

x__xgafv: string, V1 error format.

309

Allowed values

310

1 - v1 error format

311

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

312

313

Returns:

314

An object of the form:

315

316

{ # Auto-forwarding settings for an account.

Bu Sun Kim

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

[diff] [blame^]

317

"enabled": True or False, # Whether all incoming mail is automatically forwarded to another address.

318

"disposition": "A String", # The state that a message should be left in after it has been forwarded.

319

"emailAddress": "A String", # Email address to which all incoming messages are forwarded. This email

320

# address must be a verified member of the forwarding addresses.

321

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

325

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

326

<pre>Updates IMAP settings.

327

328

Args:

Bu Sun Kim

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

[diff] [blame^]

329

userId: string, User's email address. The special value "me"

330

can be used to indicate the authenticated user. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

331

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

332

The object takes the form of:

333

334

{ # IMAP settings for an account.

Bu Sun Kim

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

[diff] [blame^]

335

"maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may

336

# contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero

337

# is interpreted to mean that there is no limit.

338

"autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is

339

# marked as deleted in IMAP. Otherwise, Gmail will wait for an update from

340

# the client before expunging messages marked as deleted.

341

"expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted

342

# and expunged from the last visible IMAP folder.

343

"enabled": True or False, # Whether IMAP is enabled for the account.

344

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

345

Bu Sun Kim

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

[diff] [blame^]

346

x__xgafv: string, V1 error format.

347

Allowed values

348

1 - v1 error format

349

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

350

351

Returns:

352

An object of the form:

353

354

{ # IMAP settings for an account.

Bu Sun Kim

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

[diff] [blame^]

355

"maxFolderSize": 42, # An optional limit on the number of messages that an IMAP folder may

356

# contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero

357

# is interpreted to mean that there is no limit.

358

"autoExpunge": True or False, # If this value is true, Gmail will immediately expunge a message when it is

359

# marked as deleted in IMAP. Otherwise, Gmail will wait for an update from

360

# the client before expunging messages marked as deleted.

361

"expungeBehavior": "A String", # The action that will be executed on a message when it is marked as deleted

362

# and expunged from the last visible IMAP folder.

363

"enabled": True or False, # Whether IMAP is enabled for the account.

364

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

368

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

369

<pre>Updates language settings.

370

Bu Sun Kim

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

[diff] [blame^]

371

If successful, the return object contains the `displayLanguage`

372

that was saved for the user, which may differ from the value passed into

373

the request. This is because the requested `displayLanguage` may

374

not be directly supported by Gmail but have a close variant that is, and so

375

the variant may be chosen and saved instead.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

376

377

Args:

Bu Sun Kim

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

[diff] [blame^]

378

userId: string, User's email address. The special value "me"

379

can be used to indicate the authenticated user. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

380

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

381

The object takes the form of:

382

Bu Sun Kim

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

[diff] [blame^]

383

{ # Language settings for an account. These settings correspond to

384

# the <a href="https://support.google.com/mail/answer/17091">"Language

385

# settings"</a> feature in the web interface.

386

"displayLanguage": "A String", # The language to display Gmail in, formatted as an

387

# <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066

388

# Language Tag</a> (for example `en-GB`, `fr` or

389

# `ja` for British English, French, or Japanese respectively).

Bu Sun Kim

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

[diff] [blame]

390

#

Bu Sun Kim

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

[diff] [blame^]

391

# The set of languages supported by Gmail evolves over time, so please refer

392

# to the "Language" dropdown in the

393

# <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings

394

# </a> for all available options, as described in the

395

# <a href="https://support.google.com/mail/answer/17091">language settings

396

# help article</a>. A table of sample values is also provided in the

397

# <a href="/gmail/api/guides/language_settings#display_language">Managing

398

# Language Settings guide</a>

Bu Sun Kim

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

[diff] [blame]

399

#

Bu Sun Kim

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

[diff] [blame^]

400

# Not all Gmail clients can display the same set of languages. In the case

401

# that a user's display language is not available for use on a particular

402

# client, said client automatically chooses to display in the closest

403

# supported variant (or a reasonable default).

Bu Sun Kim

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

[diff] [blame]

404

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

405

Bu Sun Kim

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

[diff] [blame^]

406

x__xgafv: string, V1 error format.

407

Allowed values

408

1 - v1 error format

409

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

410

411

Returns:

412

An object of the form:

413

Bu Sun Kim

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

[diff] [blame^]

414

{ # Language settings for an account. These settings correspond to

415

# the <a href="https://support.google.com/mail/answer/17091">"Language

416

# settings"</a> feature in the web interface.

417

"displayLanguage": "A String", # The language to display Gmail in, formatted as an

418

# <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066

419

# Language Tag</a> (for example `en-GB`, `fr` or

420

# `ja` for British English, French, or Japanese respectively).

Bu Sun Kim

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

[diff] [blame]

421

#

Bu Sun Kim

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

[diff] [blame^]

422

# The set of languages supported by Gmail evolves over time, so please refer

423

# to the "Language" dropdown in the

424

# <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings

425

# </a> for all available options, as described in the

426

# <a href="https://support.google.com/mail/answer/17091">language settings

427

# help article</a>. A table of sample values is also provided in the

428

# <a href="/gmail/api/guides/language_settings#display_language">Managing

429

# Language Settings guide</a>

Bu Sun Kim

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

[diff] [blame]

430

#

Bu Sun Kim

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

[diff] [blame^]

431

# Not all Gmail clients can display the same set of languages. In the case

432

# that a user's display language is not available for use on a particular

433

# client, said client automatically chooses to display in the closest

434

# supported variant (or a reasonable default).

Bu Sun Kim

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

[diff] [blame]

435

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

439

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

440

<pre>Updates POP settings.

441

442

Args:

Bu Sun Kim

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

[diff] [blame^]

443

userId: string, User's email address. The special value "me"

444

can be used to indicate the authenticated user. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

445

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

446

The object takes the form of:

447

448

{ # POP settings for an account.

Bu Sun Kim

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

[diff] [blame^]

449

"disposition": "A String", # The action that will be executed on a message after it has been fetched via

450

# POP.

Bu Sun Kim

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

[diff] [blame]

451

"accessWindow": "A String", # The range of messages which are accessible via POP.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

452

}

453

Bu Sun Kim

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

[diff] [blame^]

454

x__xgafv: string, V1 error format.

455

Allowed values

456

1 - v1 error format

457

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

458

459

Returns:

460

An object of the form:

461

462

{ # POP settings for an account.

Bu Sun Kim

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

[diff] [blame^]

463

"disposition": "A String", # The action that will be executed on a message after it has been fetched via

464

# POP.

Bu Sun Kim

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

[diff] [blame]

465

"accessWindow": "A String", # The range of messages which are accessible via POP.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

470

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

471

<pre>Updates vacation responder settings.

472

473

Args:

Bu Sun Kim

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

[diff] [blame^]

474

userId: string, User's email address. The special value "me"

475

can be used to indicate the authenticated user. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

476

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

477

The object takes the form of:

478

Bu Sun Kim

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

[diff] [blame^]

479

{ # Vacation auto-reply settings for an account. These settings correspond to

480

# the <a href="https://support.google.com/mail/answer/25922">"Vacation

481

# responder"</a> feature in the web interface.

482

"startTime": "A String", # An optional start time for sending auto-replies (epoch ms).

483

# When this is specified, Gmail will automatically reply only to messages

484

# that it receives after the start time. If both `startTime` and

485

# `endTime` are specified, `startTime` must precede

486

# `endTime`.

487

"endTime": "A String", # An optional end time for sending auto-replies (epoch ms).

488

# When this is specified, Gmail will automatically reply only to messages

489

# that it receives before the end time. If both `startTime` and

490

# `endTime` are specified, `startTime` must precede

491

# `endTime`.

492

"responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before

493

# storing it. If both `response_body_plain_text` and

494

# `response_body_html` are specified,

495

# `response_body_html` will be used.

496

"responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In

497

# order to enable auto-replies, either the response subject or the response

498

# body must be nonempty.

499

"responseBodyPlainText": "A String", # Response body in plain text format. If both

500

# `response_body_plain_text` and `response_body_html`

501

# are specified, `response_body_html` will be used.

502

"restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not

503

# in the user's list of contacts.

Bu Sun Kim

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

[diff] [blame]

504

"enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.

Bu Sun Kim

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

[diff] [blame^]

505

"restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are

506

# outside of the user's domain. This feature is only available for G Suite

507

# users.

Bu Sun Kim

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

[diff] [blame]

508

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

509

Bu Sun Kim

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

[diff] [blame^]

510

x__xgafv: string, V1 error format.

511

Allowed values

512

1 - v1 error format

513

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

514

515

Returns:

516

An object of the form:

517

Bu Sun Kim

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

[diff] [blame^]

518

{ # Vacation auto-reply settings for an account. These settings correspond to

519

# the <a href="https://support.google.com/mail/answer/25922">"Vacation

520

# responder"</a> feature in the web interface.

521

"startTime": "A String", # An optional start time for sending auto-replies (epoch ms).

522

# When this is specified, Gmail will automatically reply only to messages

523

# that it receives after the start time. If both `startTime` and

524

# `endTime` are specified, `startTime` must precede

525

# `endTime`.

526

"endTime": "A String", # An optional end time for sending auto-replies (epoch ms).

527

# When this is specified, Gmail will automatically reply only to messages

528

# that it receives before the end time. If both `startTime` and

529

# `endTime` are specified, `startTime` must precede

530

# `endTime`.

531

"responseBodyHtml": "A String", # Response body in HTML format. Gmail will sanitize the HTML before

532

# storing it. If both `response_body_plain_text` and

533

# `response_body_html` are specified,

534

# `response_body_html` will be used.

535

"responseSubject": "A String", # Optional text to prepend to the subject line in vacation responses. In

536

# order to enable auto-replies, either the response subject or the response

537

# body must be nonempty.

538

"responseBodyPlainText": "A String", # Response body in plain text format. If both

539

# `response_body_plain_text` and `response_body_html`

540

# are specified, `response_body_html` will be used.

541

"restrictToContacts": True or False, # Flag that determines whether responses are sent to recipients who are not

542

# in the user's list of contacts.

Bu Sun Kim

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

[diff] [blame]

543

"enableAutoReply": True or False, # Flag that controls whether Gmail automatically replies to messages.

Bu Sun Kim

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

[diff] [blame^]

544

"restrictToDomain": True or False, # Flag that determines whether responses are sent to recipients who are

545

# outside of the user's domain. This feature is only available for G Suite

546

# users.

Bu Sun Kim

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

[diff] [blame]

547

}</pre>

Jon Wayne Parrott