1.1.320 • Published 2 months ago

@sequencemedia/gmail-api v1.1.320

Weekly downloads
12
License
ISC
Repository
-
Last release
2 months ago

@sequencemedia/gmail-api

The @sequencemedia/gmail-api package is an async interface to the Gmail API by Google.

  • It exports functions for querying and requesting Gmail messages, drafts, and labels
  • It must be authorised to do so by a human

Usage

Messages

import getGmail from '@sequencemedia/gmail-api/src/gmail'

import {
  getMessages
} from '@sequencemedia/gmail-api/src/gmail/messages/list'

import {
  getMessage
} from '@sequencemedia/gmail-api/src/gmail/messages'

const gmail = await getGmail()
const messageList = await getMessages(gmail, { max: 100 })
const messages = await Promise.all(messagesList.map((message) => getMessage(gmail, message)))

messages
  .forEach((message) => {
    console.log(message)
  })

Labels and drafts follow the same pattern.

Labels

import getGmail from '@sequencemedia/gmail-api/src/gmail'

import {
  getLabels
} from '@sequencemedia/gmail-api/src/gmail/labels/list'

import {
  getLabel
} from '@sequencemedia/gmail-api/src/gmail/labels'

const gmail = await getGmail()
const labelList = await getLabels(gmail)
const labels = await Promise.all(labelsList.map((label) => getLabel(gmail, label)))

labels
  .forEach((label) => {
    console.log(label)
  })

See also messages and drafts.

Drafts

import getGmail from '@sequencemedia/gmail-api/src/gmail'

import {
  getDrafts
} from '@sequencemedia/gmail-api/src/gmail/drafts/list'

import {
  getDraft
} from '@sequencemedia/gmail-api/src/gmail/drafts'

const gmail = await getGmail()
const draftList = await getDrafts(gmail, { max: 100 })
const drafts = await Promise.all(draftsList.map((draft) => getDraft(gmail, draft)))

drafts
  .forEach((draft) => {
    console.log(draft)
  })

See also labels and messages.

Credentials

You must supply public or internal oAuth 2.0 credentials for an application registered with the Google developer console which has the Gmail API enabled, and a credentials token authorising the application to access a Gmail account you control. (The credentials identify your application. The credentials token confirms that your application is authorised to access your Gmail account.)

Configuration

Credentials and credentials tokens can be supplied either as environment variables or as arguments on the command line.

Environment variables

You can supply paths to files on the file system:

CREDENTIALS_PATH
CREDENTIALS_TOKEN_PATH

Or, you can supply JSON:

CREDENTIALS_JSON
CREDENTIALS_TOKEN_JSON

Credentials and credentials tokens supplied as environment variables containing JSON are never written to the file system.

Command-line arguments

Similarly, you can supply paths to files on the file system:

--credentials-path
--credentials-token-path

Or, you can supply JSON:

--credentials-json
--credentials-token-json

Again, credentials and credentials tokens supplied as command-line arguments containing JSON are never written to the file system.

Precedence

  • Command-line arguments supersede environment variables (so if you have supplied both, the command line arguments will be used)
  • JSON supersedes paths (so if you have supplied both, the JSON will be used, and nothing will touch the file system)

Privacy Policy

The @sequencemedia/gmail-api package does not store any data from Gmail, nor does it gather usage data.

1.1.306

3 months ago

1.1.305

3 months ago

1.1.304

3 months ago

1.1.303

4 months ago

1.1.302

4 months ago

1.1.301

4 months ago

1.1.300

4 months ago

1.1.319

2 months ago

1.1.318

2 months ago

1.1.320

2 months ago

1.1.309

2 months ago

1.1.308

2 months ago

1.1.307

3 months ago

1.1.317

2 months ago

1.1.316

2 months ago

1.1.315

2 months ago

1.1.314

2 months ago

1.1.313

2 months ago

1.1.312

2 months ago

1.1.311

2 months ago

1.1.310

2 months ago

1.1.290

5 months ago

1.1.298

4 months ago

1.1.297

4 months ago

1.1.296

4 months ago

1.1.295

4 months ago

1.1.294

4 months ago

1.1.293

4 months ago

1.1.292

5 months ago

1.1.291

5 months ago

1.1.299

4 months ago

1.1.265

7 months ago

1.1.264

7 months ago

1.1.263

7 months ago

1.1.262

7 months ago

1.1.261

7 months ago

1.1.260

7 months ago

1.1.269

7 months ago

1.1.268

7 months ago

1.1.267

7 months ago

1.1.266

7 months ago

1.1.254

8 months ago

1.1.253

8 months ago

1.1.252

8 months ago

1.1.259

7 months ago

1.1.258

8 months ago

1.1.257

8 months ago

1.1.256

8 months ago

1.1.255

8 months ago

1.1.287

5 months ago

1.1.286

5 months ago

1.1.285

5 months ago

1.1.284

5 months ago

1.1.283

5 months ago

1.1.282

5 months ago

1.1.281

5 months ago

1.1.280

5 months ago

1.1.289

5 months ago

1.1.288

5 months ago

1.1.276

6 months ago

1.1.275

6 months ago

1.1.274

6 months ago

1.1.273

6 months ago

1.1.272

6 months ago

1.1.271

6 months ago

1.1.270

6 months ago

1.1.279

5 months ago

1.1.278

5 months ago

1.1.277

5 months ago

1.1.251

8 months ago

1.1.249

9 months ago

1.1.248

9 months ago

1.1.250

8 months ago

1.1.247

9 months ago

1.1.246

9 months ago

1.1.245

9 months ago

1.1.244

9 months ago

1.1.243

9 months ago

1.1.242

9 months ago

1.1.241

10 months ago

1.1.240

10 months ago

1.1.239

10 months ago

1.1.219

11 months ago

1.1.221

11 months ago

1.1.220

11 months ago

1.1.229

10 months ago

1.1.228

10 months ago

1.1.227

10 months ago

1.1.226

10 months ago

1.1.225

10 months ago

1.1.224

10 months ago

1.1.223

10 months ago

1.1.222

10 months ago

1.1.209

11 months ago

1.1.208

11 months ago

1.1.210

11 months ago

1.1.218

11 months ago

1.1.217

11 months ago

1.1.216

11 months ago

1.1.215

11 months ago

1.1.214

11 months ago

1.1.213

11 months ago

1.1.212

11 months ago

1.1.211

11 months ago

1.1.232

10 months ago

1.1.231

10 months ago

1.1.230

10 months ago

1.1.238

10 months ago

1.1.237

10 months ago

1.1.236

10 months ago

1.1.235

10 months ago

1.1.234

10 months ago

1.1.233

10 months ago

1.1.207

11 months ago

1.1.206

11 months ago

1.1.205

11 months ago

1.1.204

11 months ago

1.1.203

11 months ago

1.1.202

11 months ago

1.1.201

11 months ago

1.1.200

11 months ago

1.1.180

1 year ago

1.1.188

12 months ago

1.1.187

1 year ago

1.1.186

1 year ago

1.1.185

1 year ago

1.1.184

1 year ago

1.1.183

1 year ago

1.1.182

1 year ago

1.1.181

1 year ago

1.1.189

12 months ago

1.1.177

1 year ago

1.1.176

1 year ago

1.1.175

1 year ago

1.1.174

1 year ago

1.1.173

1 year ago

1.1.179

1 year ago

1.1.178

1 year ago

1.1.191

12 months ago

1.1.190

12 months ago

1.1.199

11 months ago

1.1.198

11 months ago

1.1.197

11 months ago

1.1.196

11 months ago

1.1.195

11 months ago

1.1.194

12 months ago

1.1.193

12 months ago

1.1.192

12 months ago

1.1.172

1 year ago

1.1.171

1 year ago

1.1.170

1 year ago

1.1.169

1 year ago

1.1.168

1 year ago

1.1.167

1 year ago

1.1.166

1 year ago

1.1.165

1 year ago

1.1.164

1 year ago

1.1.163

1 year ago

1.1.162

1 year ago

1.1.161

1 year ago

1.1.160

1 year ago

1.1.159

1 year ago

1.1.158

1 year ago

1.1.157

1 year ago

1.1.156

1 year ago

1.1.155

1 year ago

1.1.154

1 year ago

1.1.153

1 year ago

1.1.152

1 year ago

1.1.151

1 year ago

1.1.150

1 year ago

1.1.149

1 year ago

1.1.148

1 year ago

1.1.147

1 year ago

1.1.146

1 year ago

1.1.145

1 year ago

1.1.144

1 year ago

1.1.143

1 year ago

1.1.142

1 year ago

1.1.141

1 year ago

1.1.140

1 year ago

1.1.139

1 year ago

1.1.138

1 year ago

1.1.137

1 year ago

1.1.136

1 year ago

1.1.135

1 year ago

1.1.134

2 years ago

1.1.133

2 years ago

1.1.132

2 years ago

1.1.131

2 years ago

1.1.130

2 years ago

1.1.129

2 years ago

1.1.128

2 years ago

1.1.127

2 years ago

1.1.126

2 years ago

1.1.100

2 years ago

1.1.108

2 years ago

1.1.107

2 years ago

1.1.106

2 years ago

1.1.105

2 years ago

1.1.104

2 years ago

1.1.103

2 years ago

1.1.102

2 years ago

1.1.101

2 years ago

1.1.122

2 years ago

1.1.92

2 years ago

1.1.121

2 years ago

1.1.91

2 years ago

1.1.120

2 years ago

1.1.90

2 years ago

1.1.96

2 years ago

1.1.95

2 years ago

1.1.94

2 years ago

1.1.93

2 years ago

1.1.99

2 years ago

1.1.98

2 years ago

1.1.97

2 years ago

1.1.125

2 years ago

1.1.124

2 years ago

1.1.123

2 years ago

1.1.109

2 years ago

1.1.111

2 years ago

1.1.110

2 years ago

1.1.119

2 years ago

1.1.118

2 years ago

1.1.117

2 years ago

1.1.116

2 years ago

1.1.115

2 years ago

1.1.114

2 years ago

1.1.113

2 years ago

1.1.112

2 years ago

1.1.70

2 years ago

1.1.74

2 years ago

1.1.73

2 years ago

1.1.72

2 years ago

1.1.71

2 years ago

1.1.78

2 years ago

1.1.77

2 years ago

1.1.76

2 years ago

1.1.75

2 years ago

1.1.79

2 years ago

1.1.81

2 years ago

1.1.80

2 years ago

1.1.85

2 years ago

1.1.84

2 years ago

1.1.83

2 years ago

1.1.82

2 years ago

1.1.89

2 years ago

1.1.88

2 years ago

1.1.87

2 years ago

1.1.86

2 years ago

1.1.67

2 years ago

1.1.69

2 years ago

1.1.68

2 years ago

1.1.52

2 years ago

1.1.51

2 years ago

1.1.55

2 years ago

1.1.54

2 years ago

1.1.53

2 years ago

1.1.59

2 years ago

1.1.58

2 years ago

1.1.57

2 years ago

1.1.63

2 years ago

1.1.62

2 years ago

1.1.61

2 years ago

1.1.60

2 years ago

1.1.66

2 years ago

1.1.65

2 years ago

1.1.64

2 years ago

1.1.29

2 years ago

1.1.28

2 years ago

1.1.30

2 years ago

1.1.34

2 years ago

1.1.33

2 years ago

1.1.32

2 years ago

1.1.31

2 years ago

1.1.38

2 years ago

1.1.37

2 years ago

1.1.36

2 years ago

1.1.35

2 years ago

1.1.39

2 years ago

1.1.41

2 years ago

1.1.40

2 years ago

1.1.45

2 years ago

1.1.44

2 years ago

1.1.43

2 years ago

1.1.42

2 years ago

1.1.49

2 years ago

1.1.48

2 years ago

1.1.47

2 years ago

1.1.46

2 years ago

1.1.12

2 years ago

1.1.16

2 years ago

1.1.15

2 years ago

1.1.14

2 years ago

1.1.13

2 years ago

1.1.19

2 years ago

1.1.18

2 years ago

1.1.23

2 years ago

1.1.22

2 years ago

1.1.21

2 years ago

1.1.20

2 years ago

1.1.27

2 years ago

1.1.26

2 years ago

1.1.25

2 years ago

1.1.24

2 years ago

1.0.418

2 years ago

1.0.415

2 years ago

1.0.414

2 years ago

1.0.417

2 years ago

1.0.416

2 years ago

1.0.411

2 years ago

1.0.410

2 years ago

1.0.412

2 years ago

1.0.408

2 years ago

1.0.407

2 years ago

1.0.409

2 years ago

1.0.404

2 years ago

1.0.403

2 years ago

1.0.406

2 years ago

1.0.405

2 years ago

1.0.400

2 years ago

1.0.402

2 years ago

1.0.401

2 years ago

1.0.385

2 years ago

1.0.384

2 years ago

1.0.387

2 years ago

1.0.386

2 years ago

1.0.381

2 years ago

1.0.380

2 years ago

1.0.383

2 years ago

1.0.382

2 years ago

1.0.389

2 years ago

1.0.388

2 years ago

1.0.379

2 years ago

1.0.396

2 years ago

1.0.395

2 years ago

1.0.398

2 years ago

1.0.397

2 years ago

1.0.392

2 years ago

1.0.391

2 years ago

1.0.394

2 years ago

1.0.393

2 years ago

1.0.399

2 years ago

1.0.390

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.0.374

2 years ago

1.0.373

2 years ago

1.0.376

2 years ago

1.0.375

2 years ago

1.0.370

2 years ago

1.0.372

2 years ago

1.0.371

2 years ago

1.0.378

2 years ago

1.0.377

2 years ago

1.0.363

2 years ago

1.0.362

2 years ago

1.0.365

2 years ago

1.0.364

2 years ago

1.0.361

2 years ago

1.0.360

2 years ago

1.0.367

2 years ago

1.0.366

2 years ago

1.0.369

2 years ago

1.0.368

2 years ago

1.0.352

2 years ago

1.0.354

2 years ago

1.0.353

2 years ago

1.0.359

2 years ago

1.0.356

2 years ago

1.0.355

2 years ago

1.0.358

2 years ago

1.0.357

2 years ago

1.0.321

3 years ago

1.0.320

3 years ago

1.0.327

3 years ago

1.0.326

3 years ago

1.0.329

3 years ago

1.0.328

3 years ago

1.0.323

3 years ago

1.0.322

3 years ago

1.0.325

3 years ago

1.0.324

3 years ago

1.0.319

3 years ago

1.0.316

3 years ago

1.0.315

3 years ago

1.0.318

3 years ago

1.0.317

3 years ago

1.0.312

3 years ago

1.0.314

3 years ago

1.0.313

3 years ago

1.0.341

2 years ago

1.0.340

2 years ago

1.0.343

2 years ago

1.0.342

2 years ago

1.0.349

2 years ago

1.0.348

2 years ago

1.0.345

2 years ago

1.0.344

2 years ago

1.0.347

2 years ago

1.0.346

2 years ago

1.0.330

3 years ago

1.0.332

3 years ago

1.0.331

3 years ago

1.0.338

2 years ago

1.0.337

2 years ago

1.0.339

2 years ago

1.0.334

3 years ago

1.0.333

3 years ago

1.0.336

2 years ago

1.0.335

2 years ago

1.0.351

2 years ago

1.0.350

2 years ago

1.0.305

3 years ago

1.0.304

3 years ago

1.0.307

3 years ago

1.0.306

3 years ago

1.0.301

3 years ago

1.0.300

3 years ago

1.0.303

3 years ago

1.0.302

3 years ago

1.0.310

3 years ago

1.0.311

3 years ago

1.0.309

3 years ago

1.0.308

3 years ago

1.0.297

3 years ago

1.0.296

3 years ago

1.0.299

3 years ago

1.0.298

3 years ago

1.0.293

3 years ago

1.0.292

3 years ago

1.0.295

3 years ago

1.0.294

3 years ago

1.0.291

3 years ago

1.0.290

3 years ago

1.0.266

3 years ago

1.0.268

3 years ago

1.0.267

3 years ago

1.0.269

3 years ago

1.0.286

3 years ago

1.0.285

3 years ago

1.0.288

3 years ago

1.0.287

3 years ago

1.0.282

3 years ago

1.0.281

3 years ago

1.0.284

3 years ago

1.0.283

3 years ago

1.0.289

3 years ago

1.0.280

3 years ago

1.0.275

3 years ago

1.0.274

3 years ago

1.0.277

3 years ago

1.0.276

3 years ago

1.0.271

3 years ago

1.0.270

3 years ago

1.0.273

3 years ago

1.0.272

3 years ago

1.0.279

3 years ago

1.0.278

3 years ago

1.0.264

3 years ago

1.0.263

3 years ago

1.0.265

3 years ago

1.0.260

3 years ago

1.0.262

3 years ago

1.0.261

3 years ago

1.0.253

3 years ago

1.0.252

3 years ago

1.0.255

3 years ago

1.0.254

3 years ago

1.0.251

3 years ago

1.0.250

3 years ago

1.0.257

3 years ago

1.0.256

3 years ago

1.0.259

3 years ago

1.0.258

3 years ago

1.0.242

3 years ago

1.0.241

3 years ago

1.0.244

3 years ago

1.0.243

3 years ago

1.0.240

3 years ago

1.0.249

3 years ago

1.0.246

3 years ago

1.0.245

3 years ago

1.0.248

3 years ago

1.0.247

3 years ago

1.0.239

3 years ago

1.0.238

3 years ago

1.0.237

3 years ago

1.0.236

3 years ago

1.0.200

3 years ago

1.0.206

3 years ago

1.0.205

3 years ago

1.0.208

3 years ago

1.0.207

3 years ago

1.0.202

3 years ago

1.0.201

3 years ago

1.0.204

3 years ago

1.0.203

3 years ago

1.0.220

3 years ago

1.0.222

3 years ago

1.0.221

3 years ago

1.0.228

3 years ago

1.0.227

3 years ago

1.0.229

3 years ago

1.0.224

3 years ago

1.0.223

3 years ago

1.0.226

3 years ago

1.0.225

3 years ago

1.0.211

3 years ago

1.0.210

3 years ago

1.0.217

3 years ago

1.0.216

3 years ago

1.0.219

3 years ago

1.0.218

3 years ago

1.0.213

3 years ago

1.0.212

3 years ago

1.0.215

3 years ago

1.0.214

3 years ago

1.0.209

3 years ago

1.0.231

3 years ago

1.0.230

3 years ago

1.0.233

3 years ago

1.0.232

3 years ago

1.0.235

3 years ago

1.0.234

3 years ago

1.0.187

3 years ago

1.0.186

3 years ago

1.0.189

3 years ago

1.0.188

3 years ago

1.0.183

3 years ago

1.0.185

3 years ago

1.0.184

3 years ago

1.0.198

3 years ago

1.0.197

3 years ago

1.0.199

3 years ago

1.0.194

3 years ago

1.0.193

3 years ago

1.0.196

3 years ago

1.0.195

3 years ago

1.0.190

3 years ago

1.0.192

3 years ago

1.0.191

3 years ago

1.0.165

3 years ago

1.0.167

3 years ago

1.0.166

3 years ago

1.0.169

3 years ago

1.0.168

3 years ago

1.0.182

3 years ago

1.0.181

3 years ago

1.0.180

3 years ago

1.0.176

3 years ago

1.0.175

3 years ago

1.0.178

3 years ago

1.0.177

3 years ago

1.0.172

3 years ago

1.0.171

3 years ago

1.0.174

3 years ago

1.0.173

3 years ago

1.0.179

3 years ago

1.0.170

3 years ago

1.0.164

3 years ago

1.0.161

3 years ago

1.0.160

3 years ago

1.0.163

3 years ago

1.0.162

3 years ago

1.0.147

3 years ago

1.0.146

3 years ago

1.0.149

3 years ago

1.0.148

3 years ago

1.0.154

3 years ago

1.0.153

3 years ago

1.0.156

3 years ago

1.0.155

3 years ago

1.0.150

3 years ago

1.0.152

3 years ago

1.0.151

3 years ago

1.0.158

3 years ago

1.0.157

3 years ago

1.0.159

3 years ago

1.0.143

3 years ago

1.0.142

3 years ago

1.0.145

3 years ago

1.0.144

3 years ago

1.0.141

3 years ago

1.0.140

3 years ago

1.0.139

3 years ago

1.0.132

3 years ago

1.0.131

3 years ago

1.0.134

3 years ago

1.0.133

3 years ago

1.0.130

3 years ago

1.0.136

3 years ago

1.0.135

3 years ago

1.0.138

3 years ago

1.0.137

3 years ago

1.0.101

4 years ago

1.0.100

4 years ago

1.0.107

3 years ago

1.0.106

3 years ago

1.0.109

3 years ago

1.0.108

3 years ago

1.0.103

4 years ago

1.0.102

4 years ago

1.0.105

3 years ago

1.0.104

3 years ago

1.0.121

3 years ago

1.0.120

3 years ago

1.0.123

3 years ago

1.0.122

3 years ago

1.0.129

3 years ago

1.0.128

3 years ago

1.0.125

3 years ago

1.0.124

3 years ago

1.0.127

3 years ago

1.0.126

3 years ago

1.0.110

3 years ago

1.0.112

3 years ago

1.0.111

3 years ago

1.0.118

3 years ago

1.0.117

3 years ago

1.0.119

3 years ago

1.0.114

3 years ago

1.0.113

3 years ago

1.0.116

3 years ago

1.0.115

3 years ago

1.0.91

4 years ago

1.0.95

4 years ago

1.0.94

4 years ago

1.0.93

4 years ago

1.0.92

4 years ago

1.0.99

4 years ago

1.0.98

4 years ago

1.0.97

4 years ago

1.0.96

4 years ago

1.0.62

4 years ago

1.0.61

4 years ago

1.0.60

4 years ago

1.0.66

4 years ago

1.0.65

4 years ago

1.0.64

4 years ago

1.0.63

4 years ago

1.0.69

4 years ago

1.0.68

4 years ago

1.0.67

4 years ago

1.0.73

4 years ago

1.0.72

4 years ago

1.0.71

4 years ago

1.0.70

4 years ago

1.0.77

4 years ago

1.0.76

4 years ago

1.0.75

4 years ago

1.0.74

4 years ago

1.0.79

4 years ago

1.0.78

4 years ago

1.0.80

4 years ago

1.0.84

4 years ago

1.0.83

4 years ago

1.0.82

4 years ago

1.0.81

4 years ago

1.0.88

4 years ago

1.0.44

4 years ago

1.0.87

4 years ago

1.0.43

4 years ago

1.0.86

4 years ago

1.0.42

4 years ago

1.0.85

4 years ago

1.0.48

4 years ago

1.0.47

4 years ago

1.0.46

4 years ago

1.0.89

4 years ago

1.0.45

4 years ago

1.0.49

4 years ago

1.0.90

4 years ago

1.0.51

4 years ago

1.0.50

4 years ago

1.0.55

4 years ago

1.0.54

4 years ago

1.0.53

4 years ago

1.0.52

4 years ago

1.0.59

4 years ago

1.0.58

4 years ago

1.0.57

4 years ago

1.0.56

4 years ago

1.0.41

4 years ago

1.0.39

4 years ago

1.0.38

4 years ago

1.0.40

4 years ago

1.0.37

4 years ago

1.0.33

4 years ago

1.0.32

4 years ago

1.0.31

4 years ago

1.0.36

4 years ago

1.0.35

4 years ago

1.0.34

4 years ago

1.0.22

4 years ago

1.0.21

4 years ago

1.0.20

4 years ago

1.0.26

4 years ago

1.0.25

4 years ago

1.0.24

4 years ago

1.0.23

4 years ago

1.0.29

4 years ago

1.0.28

4 years ago

1.0.27

4 years ago

1.0.30

4 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

4 years ago

1.0.11

4 years ago

1.0.13

4 years ago

1.0.12

4 years ago

1.0.10

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago