{"id":18084956,"url":"https://github.com/jwodder/outgoing-mailgun","last_synced_at":"2025-04-12T20:10:38.012Z","repository":{"id":57449888,"uuid":"345459032","full_name":"jwodder/outgoing-mailgun","owner":"jwodder","description":"outgoing extension for Mailgun","archived":false,"fork":false,"pushed_at":"2025-01-24T13:11:33.000Z","size":83,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T23:35:39.420Z","etag":null,"topics":["available-on-pypi","e-mail","email","mailgun","outgoing","python"],"latest_commit_sha":null,"homepage":"","language":"Python","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/jwodder.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2021-03-07T21:38:50.000Z","updated_at":"2025-01-24T13:11:37.000Z","dependencies_parsed_at":"2023-01-31T01:55:13.414Z","dependency_job_id":"743ef80a-f73a-4eb3-8df4-be74aaa63c63","html_url":"https://github.com/jwodder/outgoing-mailgun","commit_stats":{"total_commits":53,"total_committers":1,"mean_commits":53.0,"dds":0.0,"last_synced_commit":"2b3010e2de443efda5c3e1c7444d278f2caf204d"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Foutgoing-mailgun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Foutgoing-mailgun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Foutgoing-mailgun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Foutgoing-mailgun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwodder","download_url":"https://codeload.github.com/jwodder/outgoing-mailgun/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625493,"owners_count":21135513,"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":["available-on-pypi","e-mail","email","mailgun","outgoing","python"],"created_at":"2024-10-31T15:08:46.962Z","updated_at":"2025-04-12T20:10:37.988Z","avatar_url":"https://github.com/jwodder.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"|repostatus| |ci-status| |coverage| |pyversions| |license|\n\n.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg\n    :target: https://www.repostatus.org/#active\n    :alt: Project Status: Active — The project has reached a stable, usable\n          state and is being actively developed.\n\n.. |ci-status| image:: https://github.com/jwodder/outgoing-mailgun/actions/workflows/test.yml/badge.svg\n    :target: https://github.com/jwodder/outgoing-mailgun/actions/workflows/test.yml\n    :alt: CI Status\n\n.. |coverage| image:: https://codecov.io/gh/jwodder/outgoing-mailgun/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/jwodder/outgoing-mailgun\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/outgoing-mailgun.svg\n    :target: https://pypi.org/project/outgoing-mailgun/\n\n.. |license| image:: https://img.shields.io/github/license/jwodder/outgoing-mailgun.svg\n    :target: https://opensource.org/licenses/MIT\n    :alt: MIT License\n\n`GitHub \u003chttps://github.com/jwodder/outgoing-mailgun\u003e`_\n| `PyPI \u003chttps://pypi.org/project/outgoing-mailgun/\u003e`_\n| `Issues \u003chttps://github.com/jwodder/outgoing-mailgun/issues\u003e`_\n| `Changelog \u003chttps://github.com/jwodder/outgoing-mailgun/blob/master/CHANGELOG.md\u003e`_\n\n``outgoing-mailgun`` is an extension for outgoing_ that adds the ability to\nsend e-mails via Mailgun_.  Simply install ``outgoing-mailgun`` alongside\n``outgoing``, and you'll be able to specify \"mailgun\" as a sending method in\nyour ``outgoing`` configuration.\n\n.. _outgoing: https://github.com/jwodder/outgoing\n.. _Mailgun: https://www.mailgun.com\n\nInstallation\n============\n``outgoing-mailgun`` requires Python 3.8 or higher.  Just use `pip\n\u003chttps://pip.pypa.io\u003e`_ for Python 3 (You have pip, right?) to install\n``outgoing-mailgun`` and its dependencies (including ``outgoing``)::\n\n    python3 -m pip install outgoing-mailgun\n\n\nConfiguration\n=============\n\nWhen using \"mailgun\" as the sending method in an ``outgoing`` configuration,\nthe following configuration fields are recognized:\n\n``base-url`` : HTTP URL (optional)\n    The base URL to use for Mailgun API requests.  This should be either\n    ``\"https://api.mailgun.net\"`` (the default) for domains in Mailgun's US\n    region or ``\"https://api.eu.mailgun.net\"`` for domains in Mailgun's EU\n    region.  Trailing slashes on the URL are optional.\n\n``domain`` : string (required)\n    The domain name you registered with Mailgun for sending e-mail\n\n``api-key`` : password (required)\n    A Mailgun API key for your domain; see |the outgoing documentation on\n    passwords|_ for ways to write this field.\n\n    .. |the outgoing documentation on passwords|\n       replace:: the ``outgoing`` documentation on passwords\n    .. _the outgoing documentation on passwords:\n       https://outgoing.readthedocs.io/en/latest/configuration.html#passwords\n\n    When using the ``keyring`` password scheme or another scheme that takes\n    optional host/service and username fields, if the service and/or username\n    is not supplied in the password specifier, then the service defaults to the\n    domain name of the ``base-url`` field, and the username defaults to the\n    value of the ``domain`` field.\n\n``tags`` : list of strings (optional)\n    A set of tags to apply to sent e-mails\n\n``deliverytime`` : datetime (optional)\n    Desired time of delivery for sent e-mails; if no timezone offset is given,\n    it is assumed to be in the local system timezone\n\n``dkim`` : boolean (optional)\n    Enable/disable DKIM signatures on sent e-mails\n\n``testmode`` : boolean (optional)\n    Whether to send in `test mode`_\n\n    .. _test mode: https://documentation.mailgun.com/en/latest/user_manual.html\n                   #sending-in-test-mode\n\n``tracking`` : boolean (optional)\n    Whether to enable `message tracking`_\n\n    .. _message tracking: https://documentation.mailgun.com/en/latest\n                          /user_manual.html#tracking-messages\n\n``tracking-clicks`` : boolean or ``\"htmlonly\"`` (optional)\n    Whether to enable clicks tracking in e-mails\n\n``tracking-opens`` : boolean (optional)\n    Whether to enable opens tracking in e-mails\n\n``headers`` : table with string values (optional)\n    A collection of custom MIME headers to append to sent e-mails\n\n``variables`` : table with string values (optional)\n    A collection of `Mailgun variables`_ to attach to sent e-mails\n\n    .. _Mailgun variables: https://documentation.mailgun.com/en/latest\n                           /user_manual.html#attaching-data-to-messages\n\n\nExample Configuration\n=====================\n\n.. code:: toml\n\n    [outgoing]\n    method = \"mailgun\"\n    domain = \"mydomain.nil\"\n    api-key = { file = \"~/secrets/mailgun.key\" }\n    dkim = true\n    tags = [ \"sent-with-outgoing\", \"my-campaign\" ]\n    tracking-clicks = \"htmlonly\"\n    headers = { Reply-To = \"me@mydomain.nil\" }\n    variables = { sender = \"outgoing\", foo = \"bar\" }\n\n\nSender-Specific Behavior\n========================\n\nThe ``MailgunSender`` class provided by this extension is a reentrant__ and\nreusable__ context manager, and its ``send()`` method can be called outside of\na context.  In addition, on success, the ``send()`` method returns the message\nID of the newly-sent e-mail (without enclosing angle brackets).\n\n__ https://docs.python.org/3/library/contextlib.html#reentrant-context-managers\n__ https://docs.python.org/3/library/contextlib.html#reusable-context-managers\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Foutgoing-mailgun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwodder%2Foutgoing-mailgun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Foutgoing-mailgun/lists"}