Smtp.NET 3 Documentation

SmtpServer.DBFriendlyColumn Property

The name of the column in the data table that holds a friendly name for the recipient.

[Visual Basic]
Public Property DBFriendlyColumn As String
[C#]
public string DBFriendlyColumn {get; set;}

Property Value

A string

Remarks

Delimit multiple columns with a comma. For example, if the friendly name is contained in two columns, one named "first_name" and the second "last_name", set this property with "first_name,last_name". A space is automatically placed in between multiply specified columns.

For example, if you specify "first_name,last_name", the freindly name will appear as "John Doe" and not "JohnDoe"

For more control over this type of feature, use full mail merge.

Example

[C#]
            public void Send()
            {
                 SmtpServer oSmtpDotNet = new SmtpServer();
             
                 // Set the remote server name.  If left blank, "localhost" is used.
                 oSmtpDotNet.ServerAddress = "mail.domain.com";
                  
                 // Message Addressing
                 oSmtpDotNet.ToAddress = "to@domain.com";
                 oSmtpDotNet.FromAddress = "from@domain.com";
             
                 // Set the friendly column property
                 oSmtpDotNet.DBFriendlyColumn = "customerFirstName,customerLastName";
                 
                 // Set other DB properties
                 oSmtpDotNet.DBDataTable = myDataTable;
                 oSmtpDotNet.DBEmailColumn = "email";
            
                 // Set the message subject and body
                 oSmtpDotNet.Body = "This is the message";
                 oSmtpDotNet.Subject = "Routine email";
                  
                 ReturnCodes nRC = oSmtpDotNet.Send();
                 if ( nRC != ReturnCodes.SUCCESS )
                 {
                      Console.WriteLine("Error #"+nRC+" occurred.");
                      Console.WriteLine(oSmtpDotNet.LastError);
                      Console.Write(oSmtpDotNet.LogFileToString(false));
                      return;
                 }
             
                 // Success!
                 Console.WriteLine("Success!");
            }
            
[VB]
            Public Function Send() As Integer
                 Dim oSmtpDotNet As New SmtpServer()
                 Dim nRC As ReturnCodes
            
                 ' Set the remote server name.  If left blank, "localhost" is used.
                 oSmtpDotNet.ServerAddress = "mail.domain.com"
                 
                 ' Message Addressing
                 oSmtpDotNet.FromAddress = "from@domain.com"
                 oSmtpDotNet.ToAddress = "to@domain.com"
            
                 ' Set the friendly column property
                 oSmtpDotNet.DBFriendlyColumn = "customerFirstName,customerLastName"
                 
                 ' Set other DB properties
                 oSmtpDotNet.DBDataTable = myDataTable
                 oSmtpDotNet.DBEmailColumn = "email"
            
                 ' Set the message subject and body
                 oSmtpDotNet.Subject = "Routine email"
                 oSmtpDotNet.Body = "This is a briefing of the financials"
            
                 ' Send the message.  Get the return code and store it in the variable
                 ' nRC.  Then check nRC for success or failure
                 nRC = oSmtpDotNet.Send()
                 If (nRC <> ReturnCodes.SUCCESS) Then
                     ' A problem occurred.
                     ' Write out the last error encountered
                     Console.WriteLine(oSmtpDotNet.LastError)
                     ' Write out the log file contents
                     Console.WriteLine(oSmtpDotNet.LogFileToString(False))
                     Exit Function
                 End If
            
                 ' Success!
                 Console.WriteLine("Message Sent!")
            End Function
            

See Also

SmtpServer Class | SmtpServer Members | SmtpDotNet Namespace | DBDataTable | DBEmailColumn | DBRecipientLimit | DBRecipientType