cloudcomponents.cdk-responsive-email-template


Namecloudcomponents.cdk-responsive-email-template JSON
Version 2.3.0 PyPI version JSON
download
home_pagehttps://github.com/cloudcomponents/cdk-constructs
SummaryResponsive email template for aws ses
upload_time2024-05-16 19:33:08
maintainerNone
docs_urlNone
authorhupe1980
requires_python~=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)

# @cloudcomponents/cdk-responsive-email-template

[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)
[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)
[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-responsive-email-template)
[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-responsive-email-template/)

> Responsive [mjml](https://documentation.mjml.io/) email template for aws ses

## Install

TypeScript/JavaScript:

```bash
npm i @cloudcomponents/cdk-responsive-email-template
```

Python:

```bash
pip install cloudcomponents.cdk-responsive-email-template
```

## How to use

```python
import { ResponsiveEmailTemplate, TemplatePart } from '@cloudcomponents/cdk-responsive-email-template';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class ResponsiveEmailTemplateStack extends Stack {
  constructor(scope: Construct, id: string, props: StackProps) {
    super(scope, id, props);

    new ResponsiveEmailTemplate(this, 'EmailTemplate', {
      templateName: 'demo',
      subjectPart: 'cloudcomponents - {{ title }}',
      textPart: TemplatePart.fromInline('text message'),
      htmlPart: TemplatePart.fromInline(`<mjml>
    <mj-head>
      <mj-title>cloudcomponents - {{ title }}</mj-title>
    </mj-head>
    <mj-body>
      <mj-section>
        <mj-column>
          <mj-text>
            Hello {{ name }}!
          </mj-text>
        </mj-column>
      </mj-section>
    </mj-body>
  </mjml>`),
      parsingOptions: {
        beautify: true,
      },
    });
  }
}
```

## API Reference

See [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-responsive-email-template/API.md).

## Example

See more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).

## License

[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-responsive-email-template/LICENSE)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cloudcomponents/cdk-constructs",
    "name": "cloudcomponents.cdk-responsive-email-template",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "hupe1980",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/c6/56/df201f6570694845144e6fe4626de7370d9eb873139f3196a296827550d9/cloudcomponents.cdk-responsive-email-template-2.3.0.tar.gz",
    "platform": null,
    "description": "[![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)\n\n# @cloudcomponents/cdk-responsive-email-template\n\n[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)\n[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)\n[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-responsive-email-template)\n[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-responsive-email-template/)\n\n> Responsive [mjml](https://documentation.mjml.io/) email template for aws ses\n\n## Install\n\nTypeScript/JavaScript:\n\n```bash\nnpm i @cloudcomponents/cdk-responsive-email-template\n```\n\nPython:\n\n```bash\npip install cloudcomponents.cdk-responsive-email-template\n```\n\n## How to use\n\n```python\nimport { ResponsiveEmailTemplate, TemplatePart } from '@cloudcomponents/cdk-responsive-email-template';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\n\nexport class ResponsiveEmailTemplateStack extends Stack {\n  constructor(scope: Construct, id: string, props: StackProps) {\n    super(scope, id, props);\n\n    new ResponsiveEmailTemplate(this, 'EmailTemplate', {\n      templateName: 'demo',\n      subjectPart: 'cloudcomponents - {{ title }}',\n      textPart: TemplatePart.fromInline('text message'),\n      htmlPart: TemplatePart.fromInline(`<mjml>\n    <mj-head>\n      <mj-title>cloudcomponents - {{ title }}</mj-title>\n    </mj-head>\n    <mj-body>\n      <mj-section>\n        <mj-column>\n          <mj-text>\n            Hello {{ name }}!\n          </mj-text>\n        </mj-column>\n      </mj-section>\n    </mj-body>\n  </mjml>`),\n      parsingOptions: {\n        beautify: true,\n      },\n    });\n  }\n}\n```\n\n## API Reference\n\nSee [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-responsive-email-template/API.md).\n\n## Example\n\nSee more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).\n\n## License\n\n[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-responsive-email-template/LICENSE)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Responsive email template for aws ses",
    "version": "2.3.0",
    "project_urls": {
        "Homepage": "https://github.com/cloudcomponents/cdk-constructs",
        "Source": "https://github.com/cloudcomponents/cdk-constructs.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dde7b816ec5a20e79dc5ae35bfc84e5592dcf73eb83b24ba13a6daf009c1ac66",
                "md5": "bb34751b0b7007cadc481acc666b3059",
                "sha256": "91654ee79c165dfa877391580a3032a78b8611aa5fc1b23cae11fef248fc0745"
            },
            "downloads": -1,
            "filename": "cloudcomponents.cdk_responsive_email_template-2.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bb34751b0b7007cadc481acc666b3059",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 57496,
            "upload_time": "2024-05-16T19:33:05",
            "upload_time_iso_8601": "2024-05-16T19:33:05.080679Z",
            "url": "https://files.pythonhosted.org/packages/dd/e7/b816ec5a20e79dc5ae35bfc84e5592dcf73eb83b24ba13a6daf009c1ac66/cloudcomponents.cdk_responsive_email_template-2.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c656df201f6570694845144e6fe4626de7370d9eb873139f3196a296827550d9",
                "md5": "ae242a5d39fe5cb015aabe7219b8db18",
                "sha256": "0fe4d459fdd23f71be0fbdc4cb4f4ab4130071b2d9a2361f64fc2d095e175ded"
            },
            "downloads": -1,
            "filename": "cloudcomponents.cdk-responsive-email-template-2.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ae242a5d39fe5cb015aabe7219b8db18",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 58405,
            "upload_time": "2024-05-16T19:33:08",
            "upload_time_iso_8601": "2024-05-16T19:33:08.579686Z",
            "url": "https://files.pythonhosted.org/packages/c6/56/df201f6570694845144e6fe4626de7370d9eb873139f3196a296827550d9/cloudcomponents.cdk-responsive-email-template-2.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-16 19:33:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cloudcomponents",
    "github_project": "cdk-constructs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cloudcomponents.cdk-responsive-email-template"
}
hupe1980
Elapsed time: 0.26810s