{"id":19311128,"url":"https://github.com/boxuk/groxy","last_synced_at":"2026-05-12T20:42:04.859Z","repository":{"id":7804451,"uuid":"9174859","full_name":"boxuk/groxy","owner":"boxuk","description":"Read-Only Gmail API Proxy","archived":false,"fork":false,"pushed_at":"2014-02-06T13:28:18.000Z","size":925,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-11-14T21:09:35.709Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","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/boxuk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-02T16:42:16.000Z","updated_at":"2022-03-30T15:07:27.000Z","dependencies_parsed_at":"2022-08-30T10:11:27.708Z","dependency_job_id":null,"html_url":"https://github.com/boxuk/groxy","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/boxuk/groxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boxuk%2Fgroxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boxuk%2Fgroxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boxuk%2Fgroxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boxuk%2Fgroxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boxuk","download_url":"https://codeload.github.com/boxuk/groxy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boxuk%2Fgroxy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32956818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-12T09:19:52.626Z","status":"ssl_error","status_checked_at":"2026-05-12T09:17:33.438Z","response_time":102,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-11-10T00:27:54.461Z","updated_at":"2026-05-12T20:42:04.824Z","avatar_url":"https://github.com/boxuk.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Groxy\n\nA JSON API proxy for talking to Gmail.  Allows using persistent IMAP connections for non-resident scripting languages.\n\n## Usage\n\nClone the repo and start the application.\n\n```\nlein run\n```\n\nYou can then browse the web application at:\n\n```\nhttp://localhost:4545\n```\n\n![](http://github.com/boxuk/groxy/raw/master/images/www.png)\n\n## Endpoints\n\nAll endpoints (except _/api_) require you send the following parameters:\n\n```\nemail - Your Gmail email address\naccess_token - A valid OAuth access token\n```\n\nBy default For the 'All Mail' folder Groxy uses '[Gmail]/All Mail' - which will be incorrect\nfor Google Mail accounts (and possibly others) which use '[Google Mail]/All Mail'.\n\nTo specify another folder to use the _folder_ parameter to give its name.  But be aware\nthat the message IDs returned are folder specific, so you'll need to use these consistently.\n\n### API Status\n\n```\nGET /api\n```\n\n### Searching\n\nThe endpoint searches the 'All Mail' folder.\n\n```\nGET /api/messages\n```\n\nWith parameters:\n\n```\nquery - Your query string (supports X-GM-RAW extension)\nfolder - The name of the folder to use\n```\n\n### Single Messages\n\n```\nGET /api/messages/:messageid\n```\n\nWith parameters:\n\n```\nmessageid - The ID of the message to fetch\nfolder - The name of the folder to use\n```\n\n### Attachments\n\n```\nGET /api/messages/:messageid/attachments/:attachmentid\n```\n\nYou will also need specify the following parameters.  This will stream back the\nraw content for the attachment.\n\n```\nmessageid - The ID of the attachments message\nattachmentid - The ID of the attachment to fetch\nfolder - The name of the folder to use\n```\n\n## Access Tokens\n\nObtaining and refreshing access tokens is not handled by Groxy, you need to do this yourself.\nIf you make a request with an invalid access token you'll receive a 403 response, which is \nyour notification to refresh your token and try again.\n\nTo try Groxy out the easiest way is to get an access token from the [OAuth Playground](https://developers.google.com/oauthplayground/).\nBut don't select the Gmail service listed, enter the scope explicitly as...\n\n```\nhttps://mail.google.com/\n```\n\n## Configuration\n\nConfiguration is supplied via environment variables with the _GROXY_ prefix.\n\n```\nGROXY_PORT=4545\nGROXY_LOGFILE=\"logs/access.log\"\nGROXY_LOGLEVEL=\"debug\"\nGROXY_LOGPATTERN=\"%d %m\"\n```\n\n## Caching\n\nBy default Groxy will cache messages in memory using an LRU cache.  To enable\na database cache (via JDBC) you can configure it as follows...\n\n```\nGROXY_DB_CACHE_TYPE=\"mysql\"\nGROXY_DB_CACHE_DSN=\"//127.0.0.1:3306/db_name\"\nGROXY_DB_CACHE_USER=\"root\"\nGROXY_DB_CACHE_PASS=\"\"\n```\n\nThis will provide a [durable cache](docs/dbcache.md) that survives restarts.\n\n## Logging\n\nLogging is configured to use log4j, and writes to the log file configured by _GROXY_LOGFILE_.\n\n## Java Classes\n\nThe library uses some Java classes to implement the custom Gmail X-GM-RAW IMAP extension.\nThere are stored in _src/java_.  You can compile these on their own using Leiningen.\n\n```\nlein javac\n```\n\nThey will be built automatically once though when running the project (or via REPL).\n\n## Documentation\n\nDocumentation can be generated with Marginalia via Leiningen:\n\n```\nlein marg\n```\n\nAnd is then available in the _docs_ folder.\n\n## Deployment\n\nYou can build a standalone WAR file for deployment using:\n\n```\nlein ring uberwar\n```\n\nThis will build a version numbered file in _target/groxy-X.X.X.war_. Alternatively you can\nbuild an executable:\n\n```\nlein bin\n```\n\nThe task will output the name of the executable built, but it should be _target/groxy_\n\n## Box UK\n\n * [Configuration](docs/configuration.md)\n * [Packaging](docs/packaging.md)\n * [Statistics](docs/statistics.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboxuk%2Fgroxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboxuk%2Fgroxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboxuk%2Fgroxy/lists"}