IFsrmReportJob::MailTo property

Retrieves or sets the email addresses of those that will receive the reports via email.

This property is read/write.

Syntax


HRESULT put_MailTo(
  [in]  BSTR mailTo
);

HRESULT get_MailTo(
  [out] BSTR mailTo
);

Property value

A string that contains the email addresses of those receiving the reports via email. Use a semicolon to delimit the addresses. The maximum length of each address is 255 characters.

Error codes

The method returns the following return values.

S_OK

Success

E_INVALIDARG

Returned for the following reasons:

  • The list of addresses is too long.
  • One or more of the addresses are not formatted correctly.

Remarks

This property is optional.

The email message is sent only if the job finishes successfully. Email is not sent for FsrmReportType_ExportReport report types. The reports are attached to the email message. You can specify [Admin Email] to send notification to the administrator (if the IFsrmSetting::AdminEmail property is set). The subject is "<ReportType>: <ReportName>". The body of the email message is empty.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmReports.h

DLL

SrmSvc.dll

IID

IID_IFsrmReportJob is defined as 38e87280-715c-4c7d-a280-ea1651a19fef

See also

IFsrmReportJob

 

 

Show: