{"componentChunkName":"component---src-templates-default-template-tsx","path":"/documentation/integration/Email/introduction/","result":{"data":{"asciidoc":{"id":"8f8a0f59-d204-5e21-8c49-b306c9cb31e2","html":"
\n
Table of Contents
\n\n
\n
\n

Introduction

\n
\n
\n

The SendEmail capability is designed to send either a HTML or Plain email to one or more pre-defined recipients.

\n
\n
\n
\n
\n

Example usage

\n
\n
\n
\n
ki\n  name: \"Send an email\"\n  description: \"Send an email\"\n  version: \"1\"\non\n  ogit/_id\nwhen\n  ShouldSendEmail==\"true\"\ndo\n  exec: LOCAL::RESULT,\n  stdout: LOCAL::OUTPUT,\n  stderr: LOCAL::ERROR,\n  exit: LOCAL::SYSTEMRC = action(\n      capability: \"SendEmail\",\n      from: \"user@example.com\",\n      to: \"user@example.com\",\n      subject: \"Hello\",\n      body: \"Hey dear customer! Click <a href=\\\"http://example.com\\\">this link</a>\",\n      type: \"html\")\n  log.info(LOCAL::RESULT)\n  log.info(LOCAL::OUTPUT)\n  log.error(LOCAL::ERROR)\n  log.info(LOCAL::SYSTEMRC)\n  delete(ShouldSendEmail)
\n
\n
\n
\n
    \n
  • \n

    The capability should be set to SendEmail

    \n
    • \n
  • \n

    The from email address needs to be authorised on the SMTP server with the SMTP credentials provided.

    \n
    • \n
  • \n

    The to is the recipient email address. cc and bcc can also be provided

    \n
    • \n
  • \n

    The body is the email content, and can be Plain or HTML

    \n
    • \n
  • \n

    The type should be set to plain or html depending on the email body content

    \n
    • \n
\n
\n
\n
","document":{"main":"Approval Action Handler","title":"Approval Action Handler","subtitle":""},"fields":{"toc":true,"location":["documentation","integration","Email","introduction"]}},"sidebarYaml":{"id":"6d066bdd-c982-5a69-b909-a31e6fc044e0","showIndex":null}},"pageContext":{"id":"8f8a0f59-d204-5e21-8c49-b306c9cb31e2","parent":"documentation"}},"staticQueryHashes":["1010459453","1010459453","2356112386","2356112386","2603905930","2603905930","3026652197","3026652197","3167850324","3167850324","63159454","63159454"]}