{"id":16322736,"url":"https://github.com/shellscape/doiuse-email","last_synced_at":"2025-06-24T08:32:38.365Z","repository":{"id":65592212,"uuid":"483402488","full_name":"shellscape/doiuse-email","owner":"shellscape","description":"Lint HTML and CSS for email support against the `Can I email?` database.","archived":false,"fork":false,"pushed_at":"2024-10-29T00:28:16.000Z","size":883,"stargazers_count":20,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-20T01:08:20.091Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shellscape.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2022-04-19T20:39:32.000Z","updated_at":"2025-03-12T18:56:34.000Z","dependencies_parsed_at":"2023-12-03T05:21:10.650Z","dependency_job_id":"2138ef8c-3b9c-4bfd-88af-8e52f70f484d","html_url":"https://github.com/shellscape/doiuse-email","commit_stats":null,"previous_names":["leonzalion/doiuse-email","leondreamed/doiuse-email"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/shellscape/doiuse-email","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fdoiuse-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fdoiuse-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fdoiuse-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fdoiuse-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shellscape","download_url":"https://codeload.github.com/shellscape/doiuse-email/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellscape%2Fdoiuse-email/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261534436,"owners_count":23173403,"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-10-10T22:52:15.237Z","updated_at":"2025-06-24T08:32:38.340Z","avatar_url":"https://github.com/shellscape.png","language":"TypeScript","readme":"[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)\n\n# @jsx-email/doiuse-email\n\nThis package is a part of the [`jsx-email`](https://jsx.email) suite of tools.\n\n`@jsx-email/doiuse-email` is a tool for checking the HTML and CSS support of various email clients based on [Can I email](https://caniemail.com).\n\nInspired by the excellent [doiuse](https://github.com/anandthakker/doiuse) library.\n\n## Installation\n\nInstall the package from npm using your favourite package manager:\n\n```shell\nnpm install @jsx-email/doiuse-email\n```\n\n## Programmatic Usage\n\nImport it and run it by calling `doIUseEmail(html: string, options: DoIUseOptions)`:\n\n```typescript\nimport { doIUseEmail } from '@jsx-email/doiuse-email';\n\nconst result = doIUseEmail(\n  `\n  \u003c!doctype html\u003e\n  \u003chtml\u003e\n    \u003cbody\u003e\n      \u003cdiv style='background-color: orange'\u003e\u003c/div\u003e\n    \u003c/body\u003e\n  \u003c/html\u003e\n  `,\n  { emailClients: ['gmail.*'] }\n);\n\nconsole.log(result);\n/*\n  {\n    \"notes\": [\n      \"Note about `\u003cbody\u003e element` support for `gmail.desktop-webmail`: Partial. Replaced by a `\u003cdiv\u003e` with supported attributes.\",\n      \"Note about `\u003cbody\u003e element` support for `gmail.ios`: Partial. Replaced by a `\u003cdiv\u003e` with supported attributes.\",\n      \"Note about `\u003cbody\u003e element` support for `gmail.android`: Partial. Replaced by a `\u003cdiv\u003e` with supported attributes.\",\n      \"Note about `\u003cbody\u003e element` support for `gmail.mobile-webmail`: Partial. Replaced by a `\u003cdiv\u003e` with supported attributes.\",\n    ],\n    \"success\": true,\n  }\n*/\n\n// Output is based on https://caniemail.com\n```\n\n## API\n\n### doIUseEmail(html, options)\n\n#### html\n\nType: `string`\n\nThe HTML that represents the email.\n\n#### options\n\n##### emailClients\n\nType: `string[]`\n\nAn array of globs for matching email clients to be checked against the Can I Email database. For more information about the glob syntax that is used, refer to the [micromatch](https://www.npmjs.com/package/micromatch) package.\n\nPossible email clients:\n\n```javascript\n[\n  'apple-mail.macos',\n  'apple-mail.ios',\n  'gmail.desktop-webmail',\n  'gmail.ios',\n  'gmail.android',\n  'gmail.mobile-webmail',\n  'orange.desktop-webmail',\n  'orange.ios',\n  'orange.android',\n  'outlook.windows',\n  'outlook.windows-mail',\n  'outlook.macos',\n  'outlook.ios',\n  'outlook.android',\n  'yahoo.desktop-webmail',\n  'yahoo.ios',\n  'yahoo.android',\n  'aol.desktop-webmail',\n  'aol.ios',\n  'aol.android',\n  'samsung-email.android',\n  'sfr.desktop-webmail',\n  'sfr.ios',\n  'sfr.android',\n  'thunderbird.macos',\n  'protonmail.desktop-webmail',\n  'protonmail.ios',\n  'protonmail.android',\n  'hey.desktop-webmail',\n  'mail-ru.desktop-webmail',\n  'fastmail.desktop-webmail',\n  'laposte.desktop-webmail'\n];\n```\n\nExample: `[\"gmail.*\", \"*.desktop-webmail\"]`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellscape%2Fdoiuse-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshellscape%2Fdoiuse-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellscape%2Fdoiuse-email/lists"}