Skip to content

IAdmReportDeliveryEmail

The IAdmReportDeliveryEmail interface is used to configure e-mail delivery of a report.

Inheritance: The IAdmReportDeliveryEmail interface inherits from the IUnknown interface.

Properties

  • Property

  • Description

  • Enabled

  • Gets or sets a value indicating whether e-mail delivery of a report is enabled.

  • UseCustomSubjectAndBody

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

  • CustomSubject

  • Gets or sets a custom email subject.

  • CustomBody

  • Gets or sets a custom e-mail body.

  • FormatAsHtml

  • Gets or sets a value indicating whether the e-mail body is in HTML format.

  • AttachFile

  • Gets or sets a value indicating whether to attach the report file to the e-mail.

  • 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 e-mail body.

  • EmbedIntoEmailBody

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

Details

Enabled

Gets or sets a value indicating whether e-mail delivery of a report is enabled.

  • Type:
  • Boolean
  • Access:
  • Read/Write

UseCustomSubjectAndBody

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

  • Type:
  • Boolean
  • 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 e-mail body. You can use value references in the e-mail body (e.g. %fullname%). Value references are replaced with 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 e-mail body is in HTML format.

  • Type:
  • Boolean
  • Access:
  • Read/Write

Remarks

If this property is set to FALSE, the e-mail is sent as plain text.


AttachFile

Gets or sets a value indicating whether to attach the report file to the e-mail.

  • Type:
  • Boolean
  • 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:
  • Boolean
  • 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 e-mail body.

  • Type:
  • Boolean
  • 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 e-mail body.

  • Type:
  • Boolean
  • 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 e-mail body.

Requirements

Minimum required version: 2018.1

See also