{"id":22455893,"url":"https://github.com/theapache64/bugmailer","last_synced_at":"2025-03-27T13:21:20.271Z","repository":{"id":86799387,"uuid":"102722639","full_name":"theapache64/bugmailer","owner":"theapache64","description":"[DEPRECATED] An android library to send bug report via email","archived":false,"fork":false,"pushed_at":"2019-11-06T09:06:57.000Z","size":779,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-01T17:44:02.107Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theapache64.png","metadata":{"files":{"readme":"README.md","changelog":"newsletter.html","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}},"created_at":"2017-09-07T10:12:17.000Z","updated_at":"2022-03-28T18:27:04.000Z","dependencies_parsed_at":"2023-04-05T16:31:25.819Z","dependency_job_id":null,"html_url":"https://github.com/theapache64/bugmailer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theapache64%2Fbugmailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theapache64%2Fbugmailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theapache64%2Fbugmailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theapache64%2Fbugmailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theapache64","download_url":"https://codeload.github.com/theapache64/bugmailer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245850358,"owners_count":20682647,"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-06T07:13:45.009Z","updated_at":"2025-03-27T13:21:20.261Z","avatar_url":"https://github.com/theapache64.png","language":"Kotlin","readme":"# BugMailer\nA simple android library to get bug reports instantly via email\n\n### How to integrate this library ?\n\n**Step one - Add to build.gradle**\n\n```groovy\nimplementation 'com.theah64.bugmailer:bugmailer:3.0.2'\n```\n\n**Step two - Initialize BugMailer in application instance**\n```java\npublic class App extends Application {\n    \n    \n    @Override\n    public void onCreate() {\n        super.onCreate();\n        \n        BugMailer.init(this, new BugMailerConfig(\"youremail@ddress.com\"));\n    }\n}\n```\n\nThat's it!\n\n\n### Customization\n\n**Report manually**\n\nYou can also report exceptions manually\n\n```java\n        try {\n            ...\n        } catch (JSONException e) {\n            e.printStackTrace();\n            \n            //Manually reporting\n            BugMailer.report(e);\n        }\n```\n\n**Include your own model object**\n\nYou can also include object properties within the error report using `BugMailerNode` interface.\n\n***Example***\n\n```java\npublic class Person implements BugMailerNode {\n\n    private final String name;\n    private final String age;\n\n    Person(String name, String age) {\n        this.name = name;\n        this.age = age;\n    }\n\n    public String getName() {\n        return name;\n    }\n\n    public String getAge() {\n        return age;\n    }\n\n\n    @Override\n    public List\u003cNode\u003e getNodes() {\n        return new NodeBuilder()\n                .add(\"Name\", name)\n                .add(\"Age\", age)\n                .build();\n    }\n}\n```\n\nand pass the object to the `BugMailer.report()` method\n\n```java\n        final Person person = new Person(\"theapache64\", \"20\");\n\n        try {\n            ...\n        } catch (JSONException e) {\n            e.printStackTrace();\n\n            //Manually reporting with custom object\n            BugMailer.report(e, person);\n        }\n```\n\nand the error report will look like this\n\n![](https://i.stack.imgur.com/Utmwz.png)\n\n**Color customization**\n \n You can also change the theme color of the report using the `BugMailerConfig` class on `init`\n \n ```java\n BugMailer.init(this, new BugMailerConfig(\"theapache64@gmail.com\")\n                    .setThemeColor(Colors.MATERIAL_DEEP_BLUE_500)\n            );\n```\nThe  `Colors` class comes with all material `500` colors.\nYou can also use custom colors with `#RGB`, `#RRGGBB` and `#AARRGGBB` formats.\n\n**Multiple mails**\n\nYou can set CC to report mails using `BugMailerConfig.addRepientEmail()` method\n\n```java\n        try {\n            BugMailer.init(this, new BugMailerConfig(\"theapache64@gmail.com\")\n                    .setThemeColor(Colors.MATERIAL_DEEP_BLUE_500)\n                    .addRepientEmail(\"co-developer@email.com\")\n            );\n        } catch (BugMailerException e) {\n            e.printStackTrace();\n        }\n```\n\n**EMail with specific exception**\n\nYou can set custom exception type to emails, so that they'll get bug report only when that specific exception occurred.\n\n```java\n\ttry {\n            BugMailer.init(this, new BugMailerConfig(\"theapache64@gmail.com\")\n                    .addRecipientEmail(\"api_developer@example.com\", JSONException.class)\n                    .addRecipientEmail(\"web_developer_1@example.com\", JSONException.class)\n            );\n        } catch (BugMailerException e) {\n            e.printStackTrace();\n        }\n\n```\n\n**GitHub issue tracker integration**\n\nTo integrate your github repo's issue tracker with BugMailer, use `BugMailerConfig#enableGitHubIssueTracker`.\n\n```java\n    bugmailerConfig.enableGitHubIssueTracker(\"author-name\", \"your-repo-name\")\n```\n\n\n**Issue or Improvements**\n\nShoot me a mail to theapache64@gmail.com :) \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheapache64%2Fbugmailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheapache64%2Fbugmailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheapache64%2Fbugmailer/lists"}