1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
|
%global _empty_manifest_terminate_build 0
Name: python-simplegmail
Version: 4.1.1
Release: 1
Summary: A simple Python API client for Gmail.
License: MIT License
URL: https://github.com/jeremyephron/simplegmail
Source0: https://mirrors.aliyun.com/pypi/web/packages/bc/82/bc78ebd7f1fa5b55450357397d43b83bae2d944106b17b1fb93af1e3d3a6/simplegmail-4.1.1.tar.gz
BuildArch: noarch
Requires: python3-google-api-python-client
Requires: python3-beautifulsoup4
Requires: python3-dateutil
Requires: python3-oauth2client
Requires: python3-lxml
%description
Currently Supported Behavior:
- Sending html messages
- Sending messages with attachments
- Sending messages with your Gmail account signature
- Retrieving messages with the full suite of Gmail's search capabilities
- Retrieving messages with attachments, and downloading attachments
- Modifying message labels (includes marking as read/unread, important/not
important, starred/unstarred, trash/untrash, inbox/archive)
## Table of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Send a simple message](#send-a-simple-message)
- [Send a message with attachments, cc, bcc fields](#send-a-message-with-attachments-cc-bcc-fields)
- [Retrieving messages](#retrieving-messages)
- [Marking messages](#marking-messages)
- [Changing message labels](#changing-message-labels)
- [Downloading attachments](#downloading-attachments)
- [Retrieving messages with queries](#retrieving-messages-advanced-with-queries)
- [Retrieving messages with more advanced queries](#retrieving-messages-more-advanced-with-more-queries)
- [Feedback](#feedback)
## Getting Started
The only setup required is to download an OAuth 2.0 Client ID file from Google
that will authorize your application.
This can be done at: https://console.developers.google.com/apis/credentials.
For those who haven't created a credential for Google's API, after clicking the
link above (and logging in to the appropriate account),
1. Select/create the project that this authentication is for (if creating a new
project make sure to configure the OAuth consent screen; you only need to set
an Application name)
2. Click on the "Dashboard" tab, then "Enable APIs and Services". Search for
Gmail and enable.
3. Click on the Credentials tab, then "Create Credentials" > "OAuth client ID".
4. Select what kind of application this is for, and give it a memorable name.
Fill out all necessary information for the credential (e.g., if choosing
"Web Application" make sure to add an Authorized Redirect URI. See
https://developers.google.com/identity/protocols/oauth2 for more infomation).
5. Back on the credentials screen, click the download icon next to the
credential you just created to download it as a JSON object.
6. Save this file as "client_secret.json" and place it in the root directory of
your application. (The `Gmail` class takes in an argument for the name of this
file if you choose to name it otherwise.)
The first time you create a new instance of the `Gmail` class, a browser window
will open, and you'll be asked to give permissions to the application. This
will save an access token in a file named "gmail-token.json", and only needs to
occur once.
You are now good to go!
Note about authentication method: I have opted not to use a username-password
authentication (through imap/smtp), since using Google's authorization is both
significantly safer and avoids clashing with Google's many security measures.
## Installation
Install using `pip` (Python3).
```bash
pip3 install simplegmail
```
## Usage
### Send a simple message:
```python
from simplegmail import Gmail
gmail = Gmail() # will open a browser window to ask you to log in and authenticate
params = {
"to": "you@youremail.com",
"sender": "me@myemail.com",
"subject": "My first email",
"msg_html": "<h1>Woah, my first email!</h1><br />This is an HTML email.",
"msg_plain": "Hi\nThis is a plain text email.",
"signature": True # use my account signature
}
message = gmail.send_message(**params) # equivalent to send_message(to="you@youremail.com", sender=...)
```
### Send a message with attachments, cc, bcc fields:
```python
from simplegmail import Gmail
gmail = Gmail()
params = {
"to": "you@youremail.com",
"sender": "me@myemail.com",
"cc": ["bob@bobsemail.com"],
"bcc": ["marie@gossip.com", "hidden@whereami.com"],
"subject": "My first email",
"msg_html": "<h1>Woah, my first email!</h1><br />This is an HTML email.",
"msg_plain": "Hi\nThis is a plain text email.",
"attachments": ["path/to/something/cool.pdf", "path/to/image.jpg", "path/to/script.py"],
"signature": True # use my account signature
}
message = gmail.send_message(**params) # equivalent to send_message(to="you@youremail.com", sender=...)
```
It couldn't be easier!
### Retrieving messages:
```python
from simplegmail import Gmail
gmail = Gmail()
# Unread messages in your inbox
messages = gmail.get_unread_inbox()
# Starred messages
messages = gmail.get_starred_messages()
# ...and many more easy to use functions can be found in gmail.py!
# Print them out!
for message in messages:
print("To: " + message.recipient)
print("From: " + message.sender)
print("Subject: " + message.subject)
print("Date: " + message.date)
print("Preview: " + message.snippet)
print("Message Body: " + message.plain) # or message.html
```
### Marking messages:
```python
from simplegmail import Gmail
gmail = Gmail()
messages = gmail.get_unread_inbox()
message_to_read = messages[0]
message_to_read.mark_as_read()
# Oops, I want to mark as unread now
message_to_read.mark_as_unread()
message_to_star = messages[1]
message_to_star.star()
message_to_trash = messages[2]
message_to_trash.trash()
# ...and many more functions can be found in message.py!
```
### Changing message labels:
```python
from simplegmail import Gmail
gmail = Gmail()
# Get the label objects for your account. Each label has a specific ID that
# you need, not just the name!
labels = gmail.list_labels()
# To find a label by the name that you know (just an example):
finance_label = list(filter(lambda x: x.name == 'Finance', labels))[0]
messages = gmail.get_unread_inbox()
# We can add/remove a label
message = messages[0]
message.add_label(finance_label)
# We can "move" a message from one label to another
message.modify_labels(to_add=labels[10], to_remove=finance_label)
# ...check out the code in message.py for more!
```
### Downloading attachments:
```python
from simplegmail import Gmail
gmail = Gmail()
messages = gmail.get_unread_inbox()
message = messages[0]
if message.attachments:
for attm in message.attachments:
print('File: ' + attm.filename)
attm.save() # downloads and saves each attachment under it's stored
# filename. You can download without saving with `attm.download()`
```
### Retrieving messages (advanced, with queries!):
```python
from simplegmail import Gmail
from simplegmail.query import construct_query
gmail = Gmail()
# Unread messages in inbox with label "Work"
labels = gmail.list_labels()
work_label = list(filter(lambda x: x.name == 'Work', labels))[0]
messages = gmail.get_unread_inbox(labels=[work_label])
# For even more control use queries:
# Messages that are: newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
query_params = {
"newer_than": (2, "day"),
"unread": True,
"labels":[["Work"], ["Homework", "CS"]]
}
messages = gmail.get_messages(query=construct_query(query_params))
# We could have also accomplished this with
# messages = gmail.get_unread_messages(query=construct_query(newer_than=(2, "day"), labels=[["Work"], ["Homework", "CS"]]))
# There are many, many different ways of achieving the same result with search.
```
### Retrieving messages (more advanced, with more queries!):
```python
from simplegmail import Gmail
from simplegmail.query import construct_query
gmail = Gmail()
# For even more control use queries:
# Messages that are either:
# newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
# or
# newer than 1 month old, unread, labeled "Top Secret", but not starred.
labels = gmail.list_labels()
# Construct our two queries separately
query_params_1 = {
"newer_than": (2, "day"),
"unread": True,
"labels":[["Finance"], ["Homework", "CS"]]
}
query_params_2 = {
"newer_than": (1, "month"),
"unread": True,
"labels": ["Top Secret"],
"exclude_starred": True
}
# construct_query() will create both query strings and "or" them together.
messages = gmail.get_messages(query=construct_query(query_params_1, query_params_2))
```
For more on what you can do with queries, read the docstring for `construct_query()` in `query.py`.
## Feedback
If there is functionality you'd like to see added, or any bugs in this project,
please let me know by posting an issue or submitting a pull request!
%package -n python3-simplegmail
Summary: A simple Python API client for Gmail.
Provides: python-simplegmail
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-simplegmail
Currently Supported Behavior:
- Sending html messages
- Sending messages with attachments
- Sending messages with your Gmail account signature
- Retrieving messages with the full suite of Gmail's search capabilities
- Retrieving messages with attachments, and downloading attachments
- Modifying message labels (includes marking as read/unread, important/not
important, starred/unstarred, trash/untrash, inbox/archive)
## Table of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Send a simple message](#send-a-simple-message)
- [Send a message with attachments, cc, bcc fields](#send-a-message-with-attachments-cc-bcc-fields)
- [Retrieving messages](#retrieving-messages)
- [Marking messages](#marking-messages)
- [Changing message labels](#changing-message-labels)
- [Downloading attachments](#downloading-attachments)
- [Retrieving messages with queries](#retrieving-messages-advanced-with-queries)
- [Retrieving messages with more advanced queries](#retrieving-messages-more-advanced-with-more-queries)
- [Feedback](#feedback)
## Getting Started
The only setup required is to download an OAuth 2.0 Client ID file from Google
that will authorize your application.
This can be done at: https://console.developers.google.com/apis/credentials.
For those who haven't created a credential for Google's API, after clicking the
link above (and logging in to the appropriate account),
1. Select/create the project that this authentication is for (if creating a new
project make sure to configure the OAuth consent screen; you only need to set
an Application name)
2. Click on the "Dashboard" tab, then "Enable APIs and Services". Search for
Gmail and enable.
3. Click on the Credentials tab, then "Create Credentials" > "OAuth client ID".
4. Select what kind of application this is for, and give it a memorable name.
Fill out all necessary information for the credential (e.g., if choosing
"Web Application" make sure to add an Authorized Redirect URI. See
https://developers.google.com/identity/protocols/oauth2 for more infomation).
5. Back on the credentials screen, click the download icon next to the
credential you just created to download it as a JSON object.
6. Save this file as "client_secret.json" and place it in the root directory of
your application. (The `Gmail` class takes in an argument for the name of this
file if you choose to name it otherwise.)
The first time you create a new instance of the `Gmail` class, a browser window
will open, and you'll be asked to give permissions to the application. This
will save an access token in a file named "gmail-token.json", and only needs to
occur once.
You are now good to go!
Note about authentication method: I have opted not to use a username-password
authentication (through imap/smtp), since using Google's authorization is both
significantly safer and avoids clashing with Google's many security measures.
## Installation
Install using `pip` (Python3).
```bash
pip3 install simplegmail
```
## Usage
### Send a simple message:
```python
from simplegmail import Gmail
gmail = Gmail() # will open a browser window to ask you to log in and authenticate
params = {
"to": "you@youremail.com",
"sender": "me@myemail.com",
"subject": "My first email",
"msg_html": "<h1>Woah, my first email!</h1><br />This is an HTML email.",
"msg_plain": "Hi\nThis is a plain text email.",
"signature": True # use my account signature
}
message = gmail.send_message(**params) # equivalent to send_message(to="you@youremail.com", sender=...)
```
### Send a message with attachments, cc, bcc fields:
```python
from simplegmail import Gmail
gmail = Gmail()
params = {
"to": "you@youremail.com",
"sender": "me@myemail.com",
"cc": ["bob@bobsemail.com"],
"bcc": ["marie@gossip.com", "hidden@whereami.com"],
"subject": "My first email",
"msg_html": "<h1>Woah, my first email!</h1><br />This is an HTML email.",
"msg_plain": "Hi\nThis is a plain text email.",
"attachments": ["path/to/something/cool.pdf", "path/to/image.jpg", "path/to/script.py"],
"signature": True # use my account signature
}
message = gmail.send_message(**params) # equivalent to send_message(to="you@youremail.com", sender=...)
```
It couldn't be easier!
### Retrieving messages:
```python
from simplegmail import Gmail
gmail = Gmail()
# Unread messages in your inbox
messages = gmail.get_unread_inbox()
# Starred messages
messages = gmail.get_starred_messages()
# ...and many more easy to use functions can be found in gmail.py!
# Print them out!
for message in messages:
print("To: " + message.recipient)
print("From: " + message.sender)
print("Subject: " + message.subject)
print("Date: " + message.date)
print("Preview: " + message.snippet)
print("Message Body: " + message.plain) # or message.html
```
### Marking messages:
```python
from simplegmail import Gmail
gmail = Gmail()
messages = gmail.get_unread_inbox()
message_to_read = messages[0]
message_to_read.mark_as_read()
# Oops, I want to mark as unread now
message_to_read.mark_as_unread()
message_to_star = messages[1]
message_to_star.star()
message_to_trash = messages[2]
message_to_trash.trash()
# ...and many more functions can be found in message.py!
```
### Changing message labels:
```python
from simplegmail import Gmail
gmail = Gmail()
# Get the label objects for your account. Each label has a specific ID that
# you need, not just the name!
labels = gmail.list_labels()
# To find a label by the name that you know (just an example):
finance_label = list(filter(lambda x: x.name == 'Finance', labels))[0]
messages = gmail.get_unread_inbox()
# We can add/remove a label
message = messages[0]
message.add_label(finance_label)
# We can "move" a message from one label to another
message.modify_labels(to_add=labels[10], to_remove=finance_label)
# ...check out the code in message.py for more!
```
### Downloading attachments:
```python
from simplegmail import Gmail
gmail = Gmail()
messages = gmail.get_unread_inbox()
message = messages[0]
if message.attachments:
for attm in message.attachments:
print('File: ' + attm.filename)
attm.save() # downloads and saves each attachment under it's stored
# filename. You can download without saving with `attm.download()`
```
### Retrieving messages (advanced, with queries!):
```python
from simplegmail import Gmail
from simplegmail.query import construct_query
gmail = Gmail()
# Unread messages in inbox with label "Work"
labels = gmail.list_labels()
work_label = list(filter(lambda x: x.name == 'Work', labels))[0]
messages = gmail.get_unread_inbox(labels=[work_label])
# For even more control use queries:
# Messages that are: newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
query_params = {
"newer_than": (2, "day"),
"unread": True,
"labels":[["Work"], ["Homework", "CS"]]
}
messages = gmail.get_messages(query=construct_query(query_params))
# We could have also accomplished this with
# messages = gmail.get_unread_messages(query=construct_query(newer_than=(2, "day"), labels=[["Work"], ["Homework", "CS"]]))
# There are many, many different ways of achieving the same result with search.
```
### Retrieving messages (more advanced, with more queries!):
```python
from simplegmail import Gmail
from simplegmail.query import construct_query
gmail = Gmail()
# For even more control use queries:
# Messages that are either:
# newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
# or
# newer than 1 month old, unread, labeled "Top Secret", but not starred.
labels = gmail.list_labels()
# Construct our two queries separately
query_params_1 = {
"newer_than": (2, "day"),
"unread": True,
"labels":[["Finance"], ["Homework", "CS"]]
}
query_params_2 = {
"newer_than": (1, "month"),
"unread": True,
"labels": ["Top Secret"],
"exclude_starred": True
}
# construct_query() will create both query strings and "or" them together.
messages = gmail.get_messages(query=construct_query(query_params_1, query_params_2))
```
For more on what you can do with queries, read the docstring for `construct_query()` in `query.py`.
## Feedback
If there is functionality you'd like to see added, or any bugs in this project,
please let me know by posting an issue or submitting a pull request!
%package help
Summary: Development documents and examples for simplegmail
Provides: python3-simplegmail-doc
%description help
Currently Supported Behavior:
- Sending html messages
- Sending messages with attachments
- Sending messages with your Gmail account signature
- Retrieving messages with the full suite of Gmail's search capabilities
- Retrieving messages with attachments, and downloading attachments
- Modifying message labels (includes marking as read/unread, important/not
important, starred/unstarred, trash/untrash, inbox/archive)
## Table of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Send a simple message](#send-a-simple-message)
- [Send a message with attachments, cc, bcc fields](#send-a-message-with-attachments-cc-bcc-fields)
- [Retrieving messages](#retrieving-messages)
- [Marking messages](#marking-messages)
- [Changing message labels](#changing-message-labels)
- [Downloading attachments](#downloading-attachments)
- [Retrieving messages with queries](#retrieving-messages-advanced-with-queries)
- [Retrieving messages with more advanced queries](#retrieving-messages-more-advanced-with-more-queries)
- [Feedback](#feedback)
## Getting Started
The only setup required is to download an OAuth 2.0 Client ID file from Google
that will authorize your application.
This can be done at: https://console.developers.google.com/apis/credentials.
For those who haven't created a credential for Google's API, after clicking the
link above (and logging in to the appropriate account),
1. Select/create the project that this authentication is for (if creating a new
project make sure to configure the OAuth consent screen; you only need to set
an Application name)
2. Click on the "Dashboard" tab, then "Enable APIs and Services". Search for
Gmail and enable.
3. Click on the Credentials tab, then "Create Credentials" > "OAuth client ID".
4. Select what kind of application this is for, and give it a memorable name.
Fill out all necessary information for the credential (e.g., if choosing
"Web Application" make sure to add an Authorized Redirect URI. See
https://developers.google.com/identity/protocols/oauth2 for more infomation).
5. Back on the credentials screen, click the download icon next to the
credential you just created to download it as a JSON object.
6. Save this file as "client_secret.json" and place it in the root directory of
your application. (The `Gmail` class takes in an argument for the name of this
file if you choose to name it otherwise.)
The first time you create a new instance of the `Gmail` class, a browser window
will open, and you'll be asked to give permissions to the application. This
will save an access token in a file named "gmail-token.json", and only needs to
occur once.
You are now good to go!
Note about authentication method: I have opted not to use a username-password
authentication (through imap/smtp), since using Google's authorization is both
significantly safer and avoids clashing with Google's many security measures.
## Installation
Install using `pip` (Python3).
```bash
pip3 install simplegmail
```
## Usage
### Send a simple message:
```python
from simplegmail import Gmail
gmail = Gmail() # will open a browser window to ask you to log in and authenticate
params = {
"to": "you@youremail.com",
"sender": "me@myemail.com",
"subject": "My first email",
"msg_html": "<h1>Woah, my first email!</h1><br />This is an HTML email.",
"msg_plain": "Hi\nThis is a plain text email.",
"signature": True # use my account signature
}
message = gmail.send_message(**params) # equivalent to send_message(to="you@youremail.com", sender=...)
```
### Send a message with attachments, cc, bcc fields:
```python
from simplegmail import Gmail
gmail = Gmail()
params = {
"to": "you@youremail.com",
"sender": "me@myemail.com",
"cc": ["bob@bobsemail.com"],
"bcc": ["marie@gossip.com", "hidden@whereami.com"],
"subject": "My first email",
"msg_html": "<h1>Woah, my first email!</h1><br />This is an HTML email.",
"msg_plain": "Hi\nThis is a plain text email.",
"attachments": ["path/to/something/cool.pdf", "path/to/image.jpg", "path/to/script.py"],
"signature": True # use my account signature
}
message = gmail.send_message(**params) # equivalent to send_message(to="you@youremail.com", sender=...)
```
It couldn't be easier!
### Retrieving messages:
```python
from simplegmail import Gmail
gmail = Gmail()
# Unread messages in your inbox
messages = gmail.get_unread_inbox()
# Starred messages
messages = gmail.get_starred_messages()
# ...and many more easy to use functions can be found in gmail.py!
# Print them out!
for message in messages:
print("To: " + message.recipient)
print("From: " + message.sender)
print("Subject: " + message.subject)
print("Date: " + message.date)
print("Preview: " + message.snippet)
print("Message Body: " + message.plain) # or message.html
```
### Marking messages:
```python
from simplegmail import Gmail
gmail = Gmail()
messages = gmail.get_unread_inbox()
message_to_read = messages[0]
message_to_read.mark_as_read()
# Oops, I want to mark as unread now
message_to_read.mark_as_unread()
message_to_star = messages[1]
message_to_star.star()
message_to_trash = messages[2]
message_to_trash.trash()
# ...and many more functions can be found in message.py!
```
### Changing message labels:
```python
from simplegmail import Gmail
gmail = Gmail()
# Get the label objects for your account. Each label has a specific ID that
# you need, not just the name!
labels = gmail.list_labels()
# To find a label by the name that you know (just an example):
finance_label = list(filter(lambda x: x.name == 'Finance', labels))[0]
messages = gmail.get_unread_inbox()
# We can add/remove a label
message = messages[0]
message.add_label(finance_label)
# We can "move" a message from one label to another
message.modify_labels(to_add=labels[10], to_remove=finance_label)
# ...check out the code in message.py for more!
```
### Downloading attachments:
```python
from simplegmail import Gmail
gmail = Gmail()
messages = gmail.get_unread_inbox()
message = messages[0]
if message.attachments:
for attm in message.attachments:
print('File: ' + attm.filename)
attm.save() # downloads and saves each attachment under it's stored
# filename. You can download without saving with `attm.download()`
```
### Retrieving messages (advanced, with queries!):
```python
from simplegmail import Gmail
from simplegmail.query import construct_query
gmail = Gmail()
# Unread messages in inbox with label "Work"
labels = gmail.list_labels()
work_label = list(filter(lambda x: x.name == 'Work', labels))[0]
messages = gmail.get_unread_inbox(labels=[work_label])
# For even more control use queries:
# Messages that are: newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
query_params = {
"newer_than": (2, "day"),
"unread": True,
"labels":[["Work"], ["Homework", "CS"]]
}
messages = gmail.get_messages(query=construct_query(query_params))
# We could have also accomplished this with
# messages = gmail.get_unread_messages(query=construct_query(newer_than=(2, "day"), labels=[["Work"], ["Homework", "CS"]]))
# There are many, many different ways of achieving the same result with search.
```
### Retrieving messages (more advanced, with more queries!):
```python
from simplegmail import Gmail
from simplegmail.query import construct_query
gmail = Gmail()
# For even more control use queries:
# Messages that are either:
# newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
# or
# newer than 1 month old, unread, labeled "Top Secret", but not starred.
labels = gmail.list_labels()
# Construct our two queries separately
query_params_1 = {
"newer_than": (2, "day"),
"unread": True,
"labels":[["Finance"], ["Homework", "CS"]]
}
query_params_2 = {
"newer_than": (1, "month"),
"unread": True,
"labels": ["Top Secret"],
"exclude_starred": True
}
# construct_query() will create both query strings and "or" them together.
messages = gmail.get_messages(query=construct_query(query_params_1, query_params_2))
```
For more on what you can do with queries, read the docstring for `construct_query()` in `query.py`.
## Feedback
If there is functionality you'd like to see added, or any bugs in this project,
please let me know by posting an issue or submitting a pull request!
%prep
%autosetup -n simplegmail-4.1.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-simplegmail -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 4.1.1-1
- Package Spec generated
|