\n\n[Playground V2](https://messagecardplayground.azurewebsites.net/)\n\n[Send an actionable message via email in Office 365](https://docs.microsoft.com/en-gb/outlook/actionable-messages/send-via-email)\n\n[Outlook version requirements for actionable messages](https://docs.microsoft.com/en-us/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages)\n\n\n
Installation
\n\n`pip install git+https://github.com/utsurius/django-actionable-messages`\n\n`pip install django-actionable-messages`\n\nAdd \"django_actionable_messages\" to INSTALLED_APPS:\n\n```python\nINSTALLED_APPS = [\n ...\n \"django_actionable_messages\",\n]\n```\n\nSETTINGS\n\n```python\nACTIONABLE_MESSAGES = {\n \"JSON_ENCODER\": None,\n \"LANGUAGE_CODE\": \"en\"\n}\n```\n\n\"JSON_ENCODER\" - doted path to custom json encoder (default: BaseEncoder).\n\n\"LANGUAGE_CODE\" - language code used for translations (defaults to project settings.LANGUAGE_CODE). Each element of adaptive_card/message_card can set individual \"lang_code\".\n\n\n
Requirements
\n\n| Name | Version |\n|---------|------------|\n| python | 3.6 - 3.10 |\n| django | 3.2 - 4.2 |\n\n\n
Usage
\n\n**`examples/message_card/github.py`**\n\n```python\nfrom django_actionable_messages.message_card.actions import OpenUri, HttpPOST, ActionCard\nfrom django_actionable_messages.message_card.cards import MessageCard\nfrom django_actionable_messages.message_card.elements import Fact, ActionTarget\nfrom django_actionable_messages.message_card.inputs import TextInput\nfrom django_actionable_messages.message_card.sections import Section\nfrom django_actionable_messages.message_card.utils import OSType\n\n\nissue_opened = MessageCard(title=\"Issue opened: \\\"Push notifications not working\\\"\", summary=\"Issue 176715375\",\n theme_color=\"0078D7\")\nissue_opened.add_sections(\n Section(\n activity_title=\"Miguel Garcie\",\n activity_subtitle=\"9/13/2016, 11:46am\",\n activity_image=\"https://connectorsdemo.azurewebsites.net/images/MSC12_Oscar_002.jpg\",\n text=\"There is a problem with Push notifications, they don't seem to be picked up by the connector.\",\n facts=[\n Fact(\"Repository:\", \"mgarcia\\\\test\"),\n Fact(\"Issue #:\", \"176715375\")\n ]\n )\n)\nissue_opened.add_actions([\n ActionCard(\n name=\"Add a comment\",\n inputs=[\n TextInput(input_id=\"comment\", title=\"Enter a comment\", is_multiline=True)\n ],\n actions=[\n HttpPOST(\"OK\", target=\"http://...\")\n ]\n ),\n HttpPOST(\"Close\", target=\"http://...\"),\n OpenUri(name=\"View in Github\", targets=[\n ActionTarget(OSType.DEFAULT, \"http://...\")\n ])\n])\n```\n\n**`examples/adaptive_card/calendar_reminder.py`**\n\n```python\nfrom django_actionable_messages.adaptive_card.actions import Submit\nfrom django_actionable_messages.adaptive_card.cards import AdaptiveCard\nfrom django_actionable_messages.adaptive_card.elements import TextBlock\nfrom django_actionable_messages.adaptive_card.inputs import InputChoice, ChoiceSetInput\nfrom django_actionable_messages.adaptive_card.utils import SCHEMA, FontSize, FontWeight, SpacingStyle, ChoiceInputStyle\n\n\ncalendar_reminder = AdaptiveCard(version=\"1.0\", schema=SCHEMA)\ncalendar_reminder.set_speak(\"Your meeting about \\\"Adaptive Card design session\\\" is starting at 12:30pm\"\n \"Do you want to snooze or do you want to send a late notification to the attendees?\")\ncalendar_reminder.add_elements(TextBlock(\"Adaptive Card design session\", size=FontSize.LARGE, weight=FontWeight.BOLDER))\ncalendar_reminder.add_elements([\n TextBlock(\"Conf Room 112/3377 (10)\", is_subtle=True),\n TextBlock(\"12:30 PM - 1:30 PM\", is_subtle=True, spacing=SpacingStyle.NONE),\n TextBlock(\"Snooze for\")\n])\ncalendar_reminder.add_elements(ChoiceSetInput(\n item_id=\"snooze\", style=ChoiceInputStyle.COMPACT, value=\"5\", choices=[\n InputChoice(\"5 minutes\", \"5\"),\n InputChoice(\"15 minutes\", \"15\"),\n InputChoice(\"30 minutes\", \"30\")\n ]\n))\ncalendar_reminder.add_actions([\n Submit(title=\"Snooze\", data={\n \"x\": \"snooze\"\n }),\n Submit(title=\"I'll be late\", data={\n \"x\": \"late\"\n })\n])\n```\n\nFor more view **`examples`** folder\n\nTo get dictionary, json or html payload from card use:\n\n| Property | Type |\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| .payload | *dict* (raw data) |\n| .json_payload | json string |\n| .html_payload | html string - can be used to send card via email ([docs](https://docs.microsoft.com/en-gb/outlook/actionable-messages/send-via-email)) |\n| .signed_html_payload | html string1 - can be used to send card via email ([docs](https://docs.microsoft.com/en-us/outlook/actionable-messages/security-requirements)) |\n\n\\[1\\] you must overwrite **get_signed_payload()** in AdaptiveCard/MessageCard to sign the payload!\n\n\nProblem: **'... is not JSON serializable'** - probably invalid argument type was used. Default json serializer can handle translated strings and everything that `DjangoJSONEncoder` can handle. \n\nSolution: [Better Python Object Serialization](https://hynek.me/articles/serialization/). Remember to ALWAYS inherit from EncoderMixin or BaseEncoder (`django_actionable_messages.encoders import EncoderMixin, BaseEncoder`)\n\nYou can set JSON_ENCODER (globally) in SETTINGS(ACTIONABLE_MESSAGES) or set it by card(json_encoder):\n\n```python\nfrom django_actionable_messages.adaptive_card.cards import AdaptiveCard\n\n\nclass MyAdaptiveCard(AdaptiveCard):\n json_encoder = \"path.to.my.encoder\"\n```\nor\n```python\nfrom django_actionable_messages.adaptive_card.cards import AdaptiveCard\n\n\nclass MyAdaptiveCard(AdaptiveCard):\n json_encoder = MyJSONEncoder\n```\n\nTo customize json dump you can overwrite `get_json_dump_kwargs()` in card (AdaptiveCard/MessageCard)\n\n```python\nfrom django_actionable_messages.adaptive_card.cards import AdaptiveCard\n\n\nclass MyAdaptiveCard(AdaptiveCard):\n def get_json_dump_kwargs(self):\n return {\n 'ensure_ascii': False,\n 'indent': 2\n }\n```\n\nSend MessageCard to msteams using webhooks and `requests` library:\n```python\nimport requests\n\n\nrequests.post(\n webhook_url,\n data=card.json_payload,\n headers={\n \"Content-Type\": \"application/json; charset=utf-8\"\n }\n)\n``` \n\nTo get/add `webhook_url` see here: [Get the Microsoft Teams webhook URL](https://learning.getpostman.com/docs/postman_pro/integrations/microsoft_teams/#get-the-microsoft-teams-webhook-url), [Create and add an outgoing webhook in Teams](https://support.office.com/en-ie/article/create-and-add-an-outgoing-webhook-in-teams-8e1a1648-982f-4511-b342-6d8492437207)\n\n
\n\n| Argument name | Function | Property | Type |\n|----------------------|--------------------------|------------------|-------------------------------------------------------|\n| title | set_title() | title | *str*, trans2 |\n| text | set_text() | text | *str*, trans2 |\n| originator | set_originator() | originator | *str* |\n| summary | set_summary() | summary | *str*, trans2 |\n| theme_color | set_theme_color() | themeColor | *str* |\n| correlation_id | set_correlation_id() | correlationId | *str* |\n| auto_correlation_id* | - | correlationId | *bool* (default: *True*) |\n| expected_actors | set_expected_actors() | expectedActors | *list* of emails |\n| hide_original_body | set_hide_original_body() | hideOriginalBody | *bool* |\n| sections | add_sections() | sections | Section1 or *list* of Sections1 |\n| actions | add_actions() | potentialAction | action3 or *list* of actions3 |\n| lang_code | - | - | *str* |\n\nOther functions:\n\n| Name | Property | Type |\n|------------------------|-----------------|-------------------------|\n| add_expected_actors() | expectedActors | *str* or list of *str* |\n\n\\[1\\] `from django_actionable_messages.message_cards.sections import ...`\n\n\\[2\\] any translation like `from django.utils.translation import gettext, gettext_lazy, ...`\n\n\\[3\\] `from django_actionable_messages.message_cards.actions import ...`\n\n
HeroCard
\n\n
Elements
\n\n
OpenUrl
\n\n| Argument name | Function | Property | Type |\n|---------------|----------|----------|--------------------------|\n| **title** | - | title | *str*, trans1 |\n| **url** | - | value | *str* |\n\n\\[1\\] any translation like `from django.utils.translation import gettext, gettext_lazy, ...`\n\n
Image
\n\n| Argument name | Function | Property | Type |\n|---------------|-----------|----------|---------------------------|\n| **url** | - | value | *str* |\n| alt | set_alt() | alt | *str*, trans1 |\n\n\\[1\\] any translation like `from django.utils.translation import gettext, gettext_lazy, ...`\n\n
![\"github\"/](\"https://img.shields.io/github/release/utsurius/django-actionable-messages\")
\n \n \n ![\"pypi\"/](\"https://badge.fury.io/py/django-actionable-messages.svg\"){kind=icon}
\n \n \n ![\"python\"/](\"https://img.shields.io/pypi/pyversions/django_actionable_messages.svg\")
\n \n \n ![\"django\"/](\"https://img.shields.io/pypi/djversions/django_actionable_messages.svg\")
\n \n \n ![\"license\"/](\"https://img.shields.io/github/license/utsurius/django-actionable-messages\")
\n \n