Close popover

Table of Contents

Sending a meeting request to Outlook or to a vCalendar email client

The SendEmailMessage utility allows your application to send an email to any valid email address. This utility can also send meeting requests to any email client that supports the vCalendar format. Recipients can select the Accept or Decline options in the vCalendar to respond to the meeting request.

For another approach to sending meeting requests to Microsoft Outlook calendars, see Integrating with Outlook calendars.

Procedure

To allow your application to send email messages or meeting requests, do the following tasks:

  • Create an activity
  • Define parameters and properties for email messages
  • Define parameters and properties for meeting requests
  • Connect to the SendEmailMessage utility
  • Test the activity

After completing the tasks, you can add a utility shape to your flow that calls the activity and allows your application to send email messages and meeting requests. You can add this activity to a flow action rule to run either before or after the action.

Creating an activity

Create an activity that sets the properties for the email message or meeting request, and then calls the SendEmailMessage utility.

  1. Create an activity from the Technical category in the Records Explorer.
  2. On the Pages & Classes tab, enter MessageData in the Page name field
  3. Enter Data-Corr-Email in the Class field.
  4. On the Steps tab, add the following steps with parameters:
    Step Method Step page Description
    1 Page-New MessageData Create the Data-Corr-Email page.
    2 Property-Set MessageData Set required parameters.
    3 Property-Set MessageData Set optional parameters.
    4 Property-Set MessageData Set Calendar request parameters.
    5 Property-Set MessageData SendEmailMessage.

Defining parameters and properties for email messages

Define the required inbound parameters for email messages.

  1. On the Parameters tab, define the parameter names for the required email message properties that are used in the standard SendEmailMessage utility:
    Name Data type Required In/Out
    SmtpHost String Yes In
    FromUserID String Yes In
    FromPassword String Yes In
    UseSSL True or False No In
    From String Yes In
    ToString String Yes In
    MeetingStartDate Date Time No In
    MeetingEndDate Date Time No In
    MeetingLocation String No In
    MeetingOrganizer String No In
    MeetingDescription String No In
    MeetingSetReminder String No In
    MeetingReminderTime String No In
  2. Optional: You can also set the following inbound parameters:
    Name Data type Required In/Out
    FromFullName String No In
    ReplyTo String No In
    CC String No In
    BCC String No In
    Priority String No In
    Subject String No In
    Body String No In
    ProdID String No In
  3. On the Steps tab, click the Expand method step icon for the Set required parameters step and configure the properties in the Method Parameters section:
    PropertiesName PropertiesValue Description
    .pySmtpHost Param.SmtpHost The name of the SMTP host.
    .pyFromUserID Param.FromUserID The user ID for the SMTP mail account sending the email.
    .pyFromPassword Param.FromPassword The SMTP mail account password.
    .pyUseSSL Param.UseSSL A flag for sending encrypted mail by using SMTPS.
    .pyFrom Param.From The email address of the message sender.
    .pyToString Param.ToString The recipient address or addresses, separated by commas. All the specified recipients are added as required attendees.
  4. On the Steps tab, click the Expand method step icon for the Set optional parameters step and configure the properties in the Method Parameters section:
    PropertiesName PropertiesValue Description
    .pyFromFullName Param.FromFullName Displays the name of the message sender, as it appears in the recipient's inbox.
    .pyReplyTo Param.ReplyTo The reply-to email address.
    .pyCCString Param.CC The CC recipient address or addresses, separated by commas. All the specified recipients are added as optional attendees.
    .pyBCCString Param.BCC The BCC recipient address or addresses, separated by commas.
    .pyPriority Param.Priority Sets the priority of the email message. It can be set to High, Normal, or Low. The default setting is Normal.
    .pySubject Param.Subject The subject of the email message.
    .pyBody Param.Body The body of the email message.

Defining required parameters and properties for meeting requests

Define the required inbound parameters for the meeting.

  1. On the Steps tab, click the Expand method step icon for the Set Calendar request parameters step and configure the properties in the Method Parameters section :
    PropertiesName PropertiesValue Description
    .pyMeetingData.pyStartDate Param.MeetingStartDate Sets the meeting start date and time.
    .pyMeetingData.pyEndDate Param.MeetingEndDate Sets the meeting end date and time.
    .pyMeetingData.pyLocation Param.MeetingLocation The location of the meeting.
    .pyMeetingData.pyOrganizer Param.MeetingOrganizer

    The meeting organizer name and email address. Enter: Organizer Name <OrganizerMailID@Domain>. You can enter the name or address, or both the values. If you do not enter a value in this field, the system populates the name from the pyFromFullName property.

    .pyMeetingData.pyDescription Param.MeetingDescription The description of the meeting.
    .pyMeetingData.pySetReminder Param.MeetingSetTimer A flag for activating a pop-up reminder for the meeting attendee.
    .pyMeetingData.pyReminderTime Param.MeetingReminderTimer The number of minutes prior to the meeting for the pop-up reminder to display.
    .pyMeetingData.pyProdID Param.ProdID Describes the product and product version that was used to create the meeting request. The default value is //Microsoft Corporation//Outlook 9.0 MIMEDIR//EN.

Connecting to the SendEmailMessage utility

Define the required parameters to send the email message.

  1. On the Parameters tab, create a local variable in the Local variable section.
  2. In the Name field, enter status.
  3. In the Data type field, select String.
  4. On the Steps tab, click the Expand method step icon for the SendEmailMessage step, and then enter the properties configuration in the Method Parameters section .
  5. In the PropertiesName field, enter: local.status.
  6. In the PropertiesValue field, enter: @(Pega-IntegrationEngine:Default).SendEmailMessage(MessageDate).
  7. Click Save.

Test the activity

You can test the SendEmailMeassage utility to ensure that all the parameters have been correctly entered.

  1. Edit the created activity for sending email messages.
  2. Click Action > Run.
  3. Enter appropriate values for all parameters.

Run rule dialog box with example values

Run rule dialog box

  1. Click Run.
    A successful test returns a message "The Operation completed successfully, but returned no content" and a meeting request is sent.
Suggest Edit

50% found this useful

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.