PowerTCP Mail for .NET
Add(String) Method
See Also  Example Send comments on this topic.
Dart.PowerTCP.Mail Namespace > MailHeader Class > Add Method : Add(String) Method




labelValueString
A string representing a header line.
Add a header line to the MailHeader collection.

Syntax

Visual Basic (Declaration) 
Public Overloads Function Add( _
   ByVal labelValueString As String _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As MailHeader
Dim labelValueString As String
Dim value As Integer
 
value = instance.Add(labelValueString)
C# 
public int Add( 
   string labelValueString
)
Managed Extensions for C++ 
public: int Add( 
   string* labelValueString
) 
C++/CLI 
public:
int Add( 
   String^ labelValueString
) 

Parameters

labelValueString
A string representing a header line.

Return Value

The index at which the labelValueString was added to the collection.

Example

The following example demonstrates the many ways a MIME message can be created.
Visual BasicCopy Code
' Be sure to import the namespace by putting "Imports Dart.PowerTCP.Mail"
' at the top of your class. In addition, import System.IO, as a FileStream will be used.

' Create a MessageStream object
Dim msg As New MessageStream()

' Add a normal recipient
msg.To.Add(New MailAddress("you@test.com"))

' Specify the sender
msg.From = New MailAddress("me@test.com")

' Specify the subject
msg.Subject = "Test"

' Add a MIME attachment
msg.Parts.Attachments.Add(New MimeAttachmentStream("C:\files\graph.bmp"))

' Add some MIME text (Setting MessageStream.Text also does this).
msg.Parts.Simple.Add(New MessagePartStream("More text here"))

' Create a complex MIME part from a stored message.
msg.Parts.Complex.Add(New MessageStream(New FileStream("C:\\message.eml", FileMode.Open)))

' Create a custom MIME boundary to use. (the component will 
' create a default MIME boundary to use if this isn't specified)
msg.MimeBoundary = "----MyBoundary-----"

' Override automatic date setting
msg.Date = ""

' Add a header line.
msg.Header.Add(HeaderLabelType.Organization, "My Organization")

' Now add a custom header line.
msg.Header.Add("X-My-Field: My Value")

' Specify the server
Smtp1.Server = "mail.test.com"

' Send the message
Smtp1.Send(msg)
C#Copy Code
// Be sure to import the namespace by putting "using Dart.PowerTCP.Mail;"
// at the top of your class. In addition, import System.IO, as a FileStream will be used.\

// Create a MessageStream object
MessageStream msg = new MessageStream();

// Add a normal recipient
msg.To.Add(new MailAddress("you@test.com"));

// Specify the sender
msg.From = new MailAddress("me@test.com");

// Specify the subject
msg.Subject = "Test";

// Add a MIME attachment
msg.Parts.Attachments.Add(new MimeAttachmentStream("C:\\files\\graph.bmp"));

// Add some MIME text (MessageStream.Text also does this).
msg.Parts.Simple.Add(new MessagePartStream("More text here"));
		
// Create a complex MIME part from a stored message.
msg.Parts.Complex.Add(new MessageStream(new FileStream("C:\\message.eml", FileMode.Open)));

// Create a custom MIME boundary to use. (the component will 
// create a default MIME boundary to use if this isn't specified)
msg.MimeBoundary = "----MyBoundary-----";

// Override automatic date setting
msg.Date = "";

// Add a header line.
msg.Header.Add(HeaderLabelType.Organization, "My Organization");

// Now add a custom header line.
msg.Header.Add("X-My-Field: My Value");

// Specify the server
smtp1.Server = "mail.test.com";

// Send the message
smtp1.Send(msg);

Remarks

Use this method to add a string representing a header line to the MailHeader collection. labelValueString should be in the format "Label: Value".

Some header lines are encapsulated by high-level properties. For example, the "Subject:" header line is also encapsulated by the MessageStream.Subject property. If a header line is added that is also encapsulated by a high-level property, the value of the header line will be propagated to the high-level property.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.