Export to MailMessage

• Apr 10, 2023
• 3 minutes to read

You can export a report as an email and use the .NET Framework SMTP client to send it.

To do this, call the XtraReport.ExportToMail method. This method returns an instance of the MailMessage class. The body of the resulting message contains a document in HTML format, optimized for email. Use the SmtpClient to send the email.

If you want to customize the email’s content and format, create an instance of the MailMessageExportOptions class and pass it as an argument to the XtraReport.ExportToMail(MailMessageExportOptions) method.

The following code creates an email with the report included in the message body in HTML format, and sends the email. Note that you should specify the SMTP hostname and port number. If your SMTP server requires authentication, specify the username and password.

View Example: How to Send a Report as HTML in an Email Body

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Mail;
using System.Text;
using DevExpress.XtraReports.UI;

namespace ConsoleApplication1 {
    class Program {
        static void Main(string[] args) {
            List<ReportData> list = new List<ReportData>();
            for(int i = 0; i < 10; i++)
                list.Add(new ReportData() { Value1 = i, Value2 = i, Value3 = i });

            XtraReport report = new XtraReport1() { DataSource = list };

            string SmtpHost = null;
            int SmtpPort = -1;
            if (string.IsNullOrEmpty(SmtpHost) || SmtpPort == -1)
            {
                System.Diagnostics.Debug.WriteLine("Please configure the SMTP server settings.");
                return;
            }

            string SmtpUserName = "Enter_Sender_User_Name";
            string SmtpUserPassword = "Enter_Sender_Password";

            using (var smtpClient = new SmtpClient(SmtpHost, SmtpPort))
            {
                smtpClient.DeliveryMethod = SmtpDeliveryMethod.Network;
                smtpClient.EnableSsl = false;

                if (!string.IsNullOrEmpty(SmtpUserName))
                {
                    smtpClient.Credentials = new NetworkCredential(SmtpUserName, SmtpUserPassword);
                }
                using(MailMessage message = report.ExportToMail("[e-mail]",
                        "[e-mail], [e-mail], [e-mail]", "Enter_Message_Subject")) {
                    smtpClient.Send(message);
                }
            }   
        }
    }
}

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Net
Imports System.Net.Mail
Imports System.Text
Imports DevExpress.XtraReports.UI

Namespace ConsoleApplication1
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Dim list As New List(Of ReportData)()
            For i As Integer = 0 To 9
                list.Add(New ReportData() With {.Value1 = i, .Value2 = i, .Value3 = i})
            Next i

            Dim report As XtraReport = New XtraReport1() With {.DataSource = list}

            Dim SmtpHost As String = Nothing
            Dim SmtpPort As Integer = -1
            If String.IsNullOrEmpty(SmtpHost) OrElse SmtpPort = -1 Then
                System.Diagnostics.Debug.WriteLine("Please configure the SMTP server settings.")
                Return
            End If

            Dim SmtpUserName As String = "Enter_Sender_User_Name"
            Dim SmtpUserPassword As String = "Enter_Sender_Password"

            Using smtpClient = New SmtpClient(SmtpHost, SmtpPort)
                smtpClient.DeliveryMethod = SmtpDeliveryMethod.Network
                smtpClient.EnableSsl = False

                If Not String.IsNullOrEmpty(SmtpUserName) Then
                    smtpClient.Credentials = New NetworkCredential(SmtpUserName, SmtpUserPassword)
                End If
                Using message As MailMessage = report.ExportToMail("[e-mail]", "[e-mail], [e-mail], [e-mail]", "Enter_Message_Subject")
                    smtpClient.Send(message)
                End Using
            End Using
        End Sub
    End Class
End Namespace

Note

Document navigation in a report is based on scripts. To use navigation based on HTML links, enable the UseHRefHyperlinks setting in the MailMessageExportOptions instance and pass this instance to the ExportToMail method as an argument.