Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Auto Reply / Update Automatic Reply Settings

  • Article
  • 4 minutes to read

Operation Information

Gets the automatic reply settings of a user.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type **Microsoft Office 365 Mail To iBridge **.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose **Microsoft Office 365 Mail To iBridge ** in the Type pick list;
  • Give the Microsoft Office 365 Mail To iBridge KeySafe key a Title (this is the name / identifier for the Microsoft Office 365 Mail To iBridge account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked **Microsoft Office 365 Mail To iBridge ** account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
ID userId string ID of the user Yes None provided
Status of the Automatic Reply Settings settingStatus string Can be disabled, always enabled, scheduled No disabled, alwaysEnabled, scheduled
External audience exernalAudience string The set of audience external to the signed-in user’s organization who will receive the ExternalReplyMessage, if Status is AlwaysEnabled or Scheduled. The possible values are: none, contactsOnly, all No one, contactsOnly, all
External Reply Message externalReplyMessage string The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled. No None provided
Internal Reply Message internalReplyMessage string The automatic reply to send to the specified internal audience, if Status is AlwaysEnabled or Scheduled. No None provided
scheduled Start Date Time scheduledStartDateTime string A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000). No None provided
Timezone of the scheduled start date scheduledStartDateTimeTimezone string Represents a time zone, for example, Pacific Standard Time. No None provided
scheduled Start End Time scheduledEndDateTime string A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000). No None provided
Timezone of the scheduled end date scheduledEndDateTimeTimezone string Represents a time zone, for example, Pacific Standard Time. No None provided

Output Parameters

Display Name ID Type Description
Status status string API Response status
Errors error string An errors returned from the API
Status of the Automatic Reply Settings settingStatus string Can be disabled, always enabled, scheduled
External audience exernalAudience string The set of audience external to the signed-in user’s organization who will receive the ExternalReplyMessage, if Status is AlwaysEnabled or Scheduled. The possible values are: none, contactsOnly, all
scheduled Start Date Time scheduledStartDateTime string The date and time that automatic replies are set to begin, if Status is set to Scheduled.
Scheduled Start Timezone scheduledStartDateTimezone string Scheduled Start Timezone
Scheduled End Datetime scheduledEndDateTime string The date and time that automatic replies are set to end, if Status is set to Scheduled.
Scheduled End Timezone scheduledEndDateTimeTimezone string Scheduled End Timezone
Internal Reply Message interalReplyMessage string The automatic reply to send to the audience internal to the signed-in user’s organization, if Status is AlwaysEnabled or Scheduled.
External Reply Message externalReplyMessage string The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document