{"id":22192515,"url":"https://github.com/3sidedcube/nylas","last_synced_at":"2025-11-10T05:32:53.837Z","repository":{"id":232215271,"uuid":"493711265","full_name":"3sidedcube/nylas","owner":"3sidedcube","description":"NestJS module for the Nylas API","archived":false,"fork":false,"pushed_at":"2024-08-31T03:09:40.000Z","size":3015,"stargazers_count":0,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T20:45:38.288Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3sidedcube.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-18T15:02:05.000Z","updated_at":"2024-04-08T13:25:23.000Z","dependencies_parsed_at":"2025-01-30T01:32:18.808Z","dependency_job_id":null,"html_url":"https://github.com/3sidedcube/nylas","commit_stats":null,"previous_names":["3sidedcube/nylas"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/3sidedcube/nylas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Fnylas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Fnylas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Fnylas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Fnylas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3sidedcube","download_url":"https://codeload.github.com/3sidedcube/nylas/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Fnylas/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262547042,"owners_count":23327090,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T12:25:42.704Z","updated_at":"2025-11-10T05:32:51.671Z","avatar_url":"https://github.com/3sidedcube.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nylas\n\nHandle emails for users on Chelsea Apps projects.\n\n### Installation\n\nThe project is hosted on our private npm registry, so to install simply run\n\n##### npm\n\n```bash\nnpm i @chelseaapps/nylas\n```\n\n##### yarn\n\n```bash\nyarn add @chelseaapps/nylas\n```\n\n### Requirements\n\nTo be able to interact with the given endpoints valid `communicationToken` \u0026 `nylasAccountId`\nvalues are needed\n\n### Config\n\nImport the module into the module in which you wish to register, and call the static `registerAsync` function.\n\n#### Config options\n\n| Option                         | Description                                                | Example                            |\n| ------------------------------ | ---------------------------------------------------------- | ---------------------------------- |\n| isGlobal                       | Register the module globally across all modules in the app | True                               |\n| clientId                       | Client's ID                                                | 6c6wcj5j54qer74l72189ot2           |\n| clientSecret                   | Secret key for authentication                              | RXIARTJAQWWNM3Q3QEXQ               |\n| apiServer                      | Specify an alternative Nylas server                        | ireland.api.nylas.com              |\n| authentication \u003e redirectURI   | Redirect after connection                                  | `https://chelseaapps.com/callback` |\n| authentication \u003e defaultScopes | Default scopes to pass for all connections                 | [email.modify, email.read_only]    |\n| encryption\u003e key                | Encryption options                                         | 6c6wcj5j54qer74l72                 |\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { NylasModule } from '@chelseaapps/nylas';\n\n@Module({\n\timports: [\n        ... other imports here\n        NylasModule.registerAsync({\n\t\t\timports: [ConfigModule],\n\t\t\tinject: [HelperService, ConfigService],\n\t\t\tuseClass: NylasConfig,\n\t\t}),\n\t],\n\tcontrollers: [],\n\tproviders: [],\n})\nexport class AppModule {}\n```\n\n### Usage\n\n| Methods           | Returns               | Description                         |\n| ----------------- | --------------------- | ----------------------------------- |\n| connect           | Promise `\u003cstring\u003e`    | Generates an OAuth set up URL       |\n| findThreadByID    | Promise `\u003cThread\u003e`    | Return a Thread by its ID           |\n| findThreadByIDs   | Promise `\u003cThread[]\u003e`  | Returns List of Threads by its IDs  |\n| searchThreads     | Promise `\u003cThread[]\u003e`  | Returns Threads found               |\n| send              | Promise `\u003cMessage\u003e`   | Sends a message                     |\n| findMessageByID   | Promise `\u003cMessage\u003e`   | Returns a Message by its ID         |\n| findMessagesByIDs | Promise `\u003cMessage[]\u003e` | Returns List of Messages by its IDs |\n| findMessagesByID  | Promise `\u003cMessage[]\u003e` | Returns List of Messages by IDs     |\n| searchMessages    | Promise `\u003cMessage[]\u003e` | Returns Messages found              |\n| deleteMessage     | Promise `\u003cMessage\u003e`   | Deletes Message                     |\n| createDraft       | Promise `\u003cDraft\u003e`     | Create a Draft                      |\n| sendDraft         | Promise `\u003cDraft\u003e`     | Sends a Draft                       |\n| updateDraft       | Promise `\u003cDraft\u003e`     | Updates a Draft                     |\n| findDraftById     | Promise `\u003cDraft\u003e`     | Returns Drafts by Id                |\n| findDraftByIds    | Promise `\u003cDraft[]\u003e`   | Returns List of Drafts by IDs       |\n| deleteDraft       | Promise `\u003cDraft\u003e`     | Deletes a Draft                     |\n| fileUpload        | Promise `\u003cFile\u003e`      | Uploads a new File                  |\n| fileDownload      | Promise `\u003cany\u003e`       | Downloads the File Object           |\n| fileById          | Promise `\u003cFile\u003e`      | Return a File                       |\n| fileByIds         | Promise `\u003cFile[]\u003e`    | Return a List of Files              |\n| fileDelete        | Promise `\u003cBoolean\u003e`   | Deletes a File                      |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Fnylas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3sidedcube%2Fnylas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Fnylas/lists"}