IAdmReportDeliveryEmail

The IAdmReportDeliveryEmail interface is used to configure email delivery of a report.

Inheritance: IUnknown

Properties

  • Property

  • Description

  • Enabled

  • Gets or sets a value indicating whether email delivery of a report is enabled.

  • UseCustomSubjectAndBody

  • Gets or sets a value indicating whether custom subject and body are used for the email.

  • CustomSubject

  • Gets or sets a custom email subject.

  • CustomBody

  • Gets or sets a custom email body.

  • FormatAsHtml

  • Gets or sets a value indicating whether the email body is in HTML format.

  • AttachFile

  • Gets or sets a value indicating whether to attach the report file to the email.

  • ZipAttachedFile

  • Gets or sets a value indicating whether to compress the attached report file to ZIP.

  • Gets or sets a value indicating whether a link to the report file is included into the email body.

  • EmbedIntoEmailBody

  • Gets or sets a value indicating whether to embed the report document into the email body.

Details

Enabled

Gets or sets a value indicating whether email delivery of a report is enabled.

  • Type:
  • bool
  • Access:
  • Read/Write

UseCustomSubjectAndBody

Gets or sets a value indicating whether custom subject and body are used for the email.

  • Type:
  • bool
  • Access:
  • Read/Write

CustomSubject

Gets or sets a custom email subject. You can use value references in the subject (e.g. %adm-ReportTitle%).

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

This property is ignored if the UseCustomSubjectAndBody property is set to false.

CustomBody

Gets or sets a custom email body. You can use value references in the email body (e.g. %fullname%). Value references will be replaced with the corresponding property values of the recipient.

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

This property is ignored if the UseCustomSubjectAndBody property is set to false.

FormatAsHtml

Gets or sets a value indicating whether the email body is in HTML format.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

If this property is set to false, the email is sent as plain text.

AttachFile

Gets or sets a value indicating whether to attach the report file to the email.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

This property is ignored if the IAdmReportDeliveryFile::Enabled property is set to false.

ZipAttachedFile

Gets or sets a value indicating whether to compress the attached report file to ZIP.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

This property is ignored if the AttachFile property is set to false.

Gets or sets a value indicating whether a link to the report file is included into the email body.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

This property is ignored if at least one of the following conditions is met:

  • The UseCustomSubjectAndBody property is set to true.
  • The IAdmReportDeliveryFile::Enabled property is set to false
  • The EmbedIntoEmailBody property is set to true.

EmbedIntoEmailBody

Gets or sets a value indicating whether to embed the report document into the email body.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

  • This property is ignored if the FormatAsHtml property is set to false or the UseCustomSubjectAndBody property is set to true.
  • The property is ignored for types of report documents that cannot be embedded into the email body.

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback