docs/en-US/about_ActionableMessages.help.txt
|
TOPIC
about_ActionableMessages SHORT DESCRIPTION Explains how to use the ActionableMessages PowerShell module to create interactive Adaptive Cards for use in Outlook and Microsoft 365. LONG DESCRIPTION The ActionableMessages module provides cmdlets for creating rich, interactive content that allows email recipients to take actions directly from within their email client without switching applications or context. ADAPTIVE CARDS BASICS --------------------- Adaptive Cards are a framework for exchanging card content in a common and consistent way. They automatically adapt to their host environment's look and feel while maintaining consistent behavior across different applications. Key components of an Adaptive Card: - Card: The root container for all content - Elements: Visual components like text blocks, images, columns, and containers - Actions: Interactive components like buttons that trigger specific behaviors - Inputs: Form fields for collecting user input BASIC WORKFLOW -------------- 1. Create a new card with `New-AMCard`. 2. Add elements to the card with `Add-AMElement`. 3. Export the card with `Export-AMCard` or `Export-AMCardForEmail`. PREBUILT CARDS -------------- The module includes several prebuilt Adaptive Cards for common scenarios, such as: - Account Verification (`New-AMAccountVerificationCard`) - Approval Workflow (`New-AMApprovalCard`) - IT Resource Request (`New-AMITResourceRequestCard`) - Service Alerts (`New-AMServiceAlertCard`) - Server Monitoring (`New-AMServerMonitoringCard`) - Feedback Forms (`New-AMFeedbackFormCard`) - Disk Space Alerts (`New-AMDiskSpaceAlertCard`) - Application Usage Surveys (`New-AMApplicationUsageSurveyCard`) These prebuilt cards simplify the process of creating Adaptive Cards by providing ready-to-use templates with customizable parameters. ORIGINATOR ID ------------- Every ActionableMessages card requires a valid Originator ID, which is a GUID that identifies the sender. For production use, you must register with Microsoft to obtain an approved ID through the Actionable Email Developer Dashboard. For testing, you can use the test option available in the Actionable Email Developer Dashboard. BEST PRACTICES -------------- - Register your Originator ID with Microsoft before deploying to production. - Keep cards focused on a single task or piece of information. - Use clear, concise language for buttons and instructions. - Test your cards in different Outlook clients (desktop, web, mobile). - Provide fallback text for email clients that don't support Adaptive Cards. - Use the `-Compress` parameter with `Export-AMCard` for production deployments to reduce card size. EXAMPLES Basic Card Creation: # Create a new card $card = New-AMCard -OriginatorId "your-originator-id" # Add elements $title = New-AMTextBlock -Text "Notification" -Size "Large" -Weight "Bolder" Add-AMElement -Card $card -Element $title $message = New-AMTextBlock -Text "This is an important notification." -Wrap $true Add-AMElement -Card $card -Element $message # Add an action $action = New-AMOpenUrlAction -Title "View Details" -Url "https://example.com" $actionSet = New-AMActionSet -Actions @($action) Add-AMElement -Card $card -Element $actionSet # Export Export-AMCard -Card $card -Path ".\notification.json" Using a Prebuilt Card: # Create an account verification card $card = New-AMAccountVerificationCard -Username "jsmith" -AccountOwner "John Smith" ` -Department "Marketing" -LastLoginDate (Get-Date).AddDays(-120) ` -ResponseEndpoint "https://api.example.com/account-verification" # Export Export-AMCard -Card $card -Path ".\account-verification.json" NOTES For more detailed documentation, examples, and function reference, see the module's README.md file. Before using Actionable Messages in production environments, you must register with Microsoft: https://learn.microsoft.com/en-us/outlook/actionable-messages/email-dev-dashboard SEE ALSO https://mynster9361.github.io/modules/actionablemessages/ https://adaptivecards.io/ https://learn.microsoft.com/en-us/outlook/actionable-messages/ New-AMCard Add-AMElement Export-AMCard Export-AMCardForEmail New-AMAccountVerificationCard New-AMApprovalCard New-AMITResourceRequestCard New-AMServiceAlertCard New-AMServerMonitoringCard New-AMFeedbackFormCard New-AMDiskSpaceAlertCard New-AMApplicationUsageSurveyCard |