{"id":15201829,"url":"https://github.com/truemail-rb/truemail-java-client","last_synced_at":"2025-06-25T07:05:15.702Z","repository":{"id":43096226,"uuid":"293599133","full_name":"truemail-rb/truemail-java-client","owner":"truemail-rb","description":"Truemail web API client library for Java :coffee:","archived":false,"fork":false,"pushed_at":"2022-03-18T14:43:28.000Z","size":36,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T23:29:15.058Z","etag":null,"topics":["api-client","gradle","hacktoberfest","java","maven","truemail","truemail-api-client","truemail-client","truemail-family","truemail-rb"],"latest_commit_sha":null,"homepage":"https://truemail-rb.org/truemail-java-client","language":"Java","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/truemail-rb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["bestwebua"]}},"created_at":"2020-09-07T18:08:21.000Z","updated_at":"2023-08-20T18:16:46.000Z","dependencies_parsed_at":"2022-09-13T06:03:32.385Z","dependency_job_id":null,"html_url":"https://github.com/truemail-rb/truemail-java-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/truemail-rb/truemail-java-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/truemail-rb%2Ftruemail-java-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/truemail-rb%2Ftruemail-java-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/truemail-rb%2Ftruemail-java-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/truemail-rb%2Ftruemail-java-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/truemail-rb","download_url":"https://codeload.github.com/truemail-rb/truemail-java-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/truemail-rb%2Ftruemail-java-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261823738,"owners_count":23215141,"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":["api-client","gradle","hacktoberfest","java","maven","truemail","truemail-api-client","truemail-client","truemail-family","truemail-rb"],"created_at":"2024-09-28T03:41:23.502Z","updated_at":"2025-06-25T07:05:15.665Z","avatar_url":"https://github.com/truemail-rb.png","language":"Java","funding_links":["https://github.com/sponsors/bestwebua"],"categories":[],"sub_categories":[],"readme":"# ![Truemail web API client library for Java](https://truemail-rb.org/assets/images/truemail_logo.png)\n\n[![CircleCI](https://circleci.com/gh/truemail-rb/truemail-java-client/tree/develop.svg?style=svg)](https://circleci.com/gh/truemail-rb/truemail-java-client/tree/develop)\n[![Maven Central](https://img.shields.io/maven-central/v/org.truemail-rb/truemail-java-client.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.truemail-rb%22%20AND%20a:%22truemail-java-client%22)\n[![GitHub](https://img.shields.io/github/license/truemail-rb/truemail-java-client)](LICENSE.txt)\n[![Gitter](https://badges.gitter.im/truemail-rb/community.svg)](https://gitter.im/truemail-rb/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)\n\n`truemail-java-client` - Web API Java client for Truemail Server.\n\n\u003e Actual and maintainable documentation :books: for developers is living [here](https://truemail-rb.org/truemail-java-client).\n\n## Table of Contents\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n  - [Maven](#maven)\n  - [Gradle](#gradle)\n- [Usage](#usage)\n  - [Creating configuration instance](#creating-configuration-instance)\n  - [Establishing connection with Truemail API](#establishing-connection-with-truemail-api)\n- [Truemail family](#truemail-family)\n- [Contributing](#contributing)\n- [License](#license)\n- [Code of Conduct](#code-of-conduct)\n- [Credits](#credits)\n- [Versioning](#versioning)\n- [Changelog](CHANGELOG.md)\n- [Developers Documentation](https://truemail-rb.org/truemail-java-client)\n\n## Requirements\n\nJava 1.8+\n\n## Installation\n\n\u003e Please change {version} to needed version, for example 0.1.0. All available versions you can find [here](https://github.com/truemail-rb/truemail-java-client/releases).\n\n### Apache Maven\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.truemail-rb\u003c/groupId\u003e\n  \u003cartifactId\u003etruemail-java-client\u003c/artifactId\u003e\n  \u003cversion\u003e{version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle Groovy\n\n```groovy\nimplementation 'org.truemail-rb:truemail-java-client:{version}'\n```\n\n### Apache Ivy\n\n```xml\n\u003cdependency org=\"org.truemail-rb\" name=\"truemail-java-client\" rev=\"{version}\" /\u003e\n```\n\n### Groovy Grape\n\n```groovy\n@Grapes(\n  @Grab(group='org.truemail-rb', module='truemail-java-client', version='{version}')\n)\n```\n\n## Usage\n\n```java\nimport org.truemail_rb.TruemailClient;\nimport org.truemail_rb.client.TruemailConfiguration;\n```\n\nTo have an access for `TruemailClient#validate` you must create configuration instance first as in the example below:\n\n### Creating configuration instance\n\n```java\n// Required parameter. It should be true or false\nboolean secureConnection = true;\n\n// Required parameter. It should be a hostname or an ip address where Truemail server runs\nString host = \"example.com\";\n\n// Optional parameter. By default it is equal 9292\nint port = 80;\n\n// Required parameter. It should be valid Truemail server access token\nString token = \"token\";\n\nTruemailConfiguration truemailConfiguration = new TruemailConfiguration(secureConnection, host, token, port);\n\n// or without port, will be used 9292 port by default\n// TruemailConfiguration truemailConfiguration = new TruemailConfiguration(secureConnection, host, token);\n```\n\n### Establishing connection with Truemail API\n\nAfter successful configuration, you can establish connection with Truemail server.\n\n```java\nTruemailClient truemailClient = new TruemailClient(truemailConfiguration);\ntruemailClient.validate(\"admin@bestweb.com.ua\")\n\n=\u003e\n\n{\n  \"date\": \"2020-10-26 10:42:42 +0200\",\n  \"email\": \"admin@bestweb.com.ua\",\n  \"validation_type\": \"smtp\",\n  \"success\": true,\n  \"errors\": null,\n  \"smtp_debug\": null,\n  \"configuration\": {\n    \"validation_type_by_domain\": null,\n    \"whitelist_validation\": false,\n    \"whitelisted_domains\": null,\n    \"blacklisted_domains\": null,\n    \"smtp_safe_check\": false,\n    \"email_pattern\": \"default gem value\",\n    \"smtp_error_body_pattern\": \"default gem value\"\n  }\n}\n```\n\n`TruemailClient#validate` always returns JSON data. If something goes wrong you will receive JSON with error details:\n\n```json\n{\n  \"truemail_client_error\": \"error details\"\n}\n```\n\n---\n\n## Truemail family\n\nAll Truemail solutions: https://truemail-rb.org\n\n| Name | Type | Description |\n| --- | --- | --- |\n| [truemail](https://github.com/truemail-rb/truemail) | ruby gem | Configurable plain Ruby email validator, main core |\n| [truemail-go](https://github.com/truemail-rb/truemail-go) | go package | Configurable Golang email validator, main core |\n| [truemail server](https://github.com/truemail-rb/truemail-rack) | ruby app | Lightweight rack based web API wrapper for Truemail |\n| [truemail-rack-docker](https://github.com/truemail-rb/truemail-rack-docker-image) | docker image | Lightweight rack based web API [dockerized image](https://hub.docker.com/r/truemail/truemail-rack) :whale: of Truemail server |\n| [truemail-ruby-client](https://github.com/truemail-rb/truemail-ruby-client) | ruby gem | Web API Ruby client for Truemail Server |\n| [truemail-crystal-client](https://github.com/truemail-rb/truemail-crystal-client) | crystal shard | Web API Crystal client for Truemail Server |\n| [truemail-rspec](https://github.com/truemail-rb/truemail-rspec) | ruby gem | Truemail configuration, auditor and validator RSpec helpers |\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/truemail-rb/truemail-java-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Please check the [open tikets](https://github.com/truemail-rb/truemail-java-client/issues). Be shure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the `truemail-java-client` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).\n\n## Credits\n\n- [The Contributors](https://github.com/truemail-rb/truemail-java-client/graphs/contributors) for code and awesome suggestions\n- [The Stargazers](https://github.com/truemail-rb/truemail-java-client/stargazers) for showing their support\n\n## Versioning\n\n`truemail-java-client` uses [Semantic Versioning 2.0.0](https://semver.org)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftruemail-rb%2Ftruemail-java-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftruemail-rb%2Ftruemail-java-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftruemail-rb%2Ftruemail-java-client/lists"}