53 lines
3.3 KiB
Markdown
53 lines
3.3 KiB
Markdown
# Gmail
|
|
Gmail is the email service provided by Google.
|
|
|
|
## Configuration
|
|
|
|
| Input | Type | Description | Default Value |
|
|
|-------|------|-------------|---------------|
|
|
| `client_id` | `string` | OAuth Client ID. | |
|
|
| `client_secret` | `string` | OAuth Client Secret. | |
|
|
| `client_refresh_token` | `string` | Refresh token. | |
|
|
| `include_spam_and_trash` | `boolean` | Include Spam & Trash. Include drafts/messages from SPAM and TRASH in the results. Defaults to false. | false |
|
|
|
|
Note that this connector uses the Google API OAuth2.0 for authentication. To get started, follow the steps [here](https://developers.google.com/gmail/api/auth/web-server#create_a_client_id_and_client_secret) to retrieve `client_id` and `client_secret`. See [here](https://developers.google.com/identity/protocols/oauth2/web-server) for more detailed guide on the OAuth flow to retrieve the `client_refresh_token`.
|
|
|
|
**Also note that the scope required here is `https://www.googleapis.com/auth/gmail.readonly`**
|
|
|
|
## Streams
|
|
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|
|
|-------------|-------------|------------|---------------------|----------------------|
|
|
| profile | | No pagination | ✅ | ❌ |
|
|
| drafts | id | DefaultPaginator | ✅ | ❌ |
|
|
| labels | id | No pagination | ✅ | ❌ |
|
|
| labels_details | id | No pagination | ✅ | ❌ |
|
|
| messages | id | DefaultPaginator | ✅ | ❌ |
|
|
| messages_details | id | No pagination | ✅ | ❌ |
|
|
| threads | id | DefaultPaginator | ✅ | ❌ |
|
|
| threads_details | id | No pagination | ✅ | ❌ |
|
|
|
|
## Changelog
|
|
|
|
<details>
|
|
<summary>Expand to review</summary>
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|------------------|-------------------|--------------|----------------|
|
|
| 0.0.15 | 2025-03-08 | [55265](https://github.com/airbytehq/airbyte/pull/55265) | Update dependencies |
|
|
| 0.0.14 | 2025-03-01 | [54937](https://github.com/airbytehq/airbyte/pull/54937) | Update dependencies |
|
|
| 0.0.13 | 2025-02-22 | [54417](https://github.com/airbytehq/airbyte/pull/54417) | Update dependencies |
|
|
| 0.0.12 | 2025-02-15 | [53369](https://github.com/airbytehq/airbyte/pull/53369) | Update dependencies |
|
|
| 0.0.11 | 2025-02-01 | [52831](https://github.com/airbytehq/airbyte/pull/52831) | Update dependencies |
|
|
| 0.0.10 | 2025-01-25 | [52329](https://github.com/airbytehq/airbyte/pull/52329) | Update dependencies |
|
|
| 0.0.9 | 2025-01-18 | [51700](https://github.com/airbytehq/airbyte/pull/51700) | Update dependencies |
|
|
| 0.0.8 | 2025-01-11 | [51110](https://github.com/airbytehq/airbyte/pull/51110) | Update dependencies |
|
|
| 0.0.7 | 2024-12-28 | [50536](https://github.com/airbytehq/airbyte/pull/50536) | Update dependencies |
|
|
| 0.0.6 | 2024-12-21 | [50008](https://github.com/airbytehq/airbyte/pull/50008) | Update dependencies |
|
|
| 0.0.5 | 2024-12-14 | [49474](https://github.com/airbytehq/airbyte/pull/49474) | Update dependencies |
|
|
| 0.0.4 | 2024-12-12 | [49185](https://github.com/airbytehq/airbyte/pull/49185) | Update dependencies |
|
|
| 0.0.3 | 2024-10-29 | [47852](https://github.com/airbytehq/airbyte/pull/47852) | Update dependencies |
|
|
| 0.0.2 | 2024-10-28 | [47570](https://github.com/airbytehq/airbyte/pull/47570) | Update dependencies |
|
|
| 0.0.1 | 2024-10-09 | | Initial release by [@topefolorunso](https://github.com/topefolorunso) via Connector Builder |
|
|
|
|
</details>
|