InternetMail.SendMessage Method (String, String, String)

Submit the current message to a mail server for delivery.

[Visual Basic]
Overloads Public Function SendMessage( _
   ByVal senderAddress As String, _
   ByVal recipientAddress As String, _
   ByVal messageText As String _
) As Boolean

[C#]
public bool SendMessage(
   string senderAddress,
   string recipientAddress,
   string messageText
);

Parameters

senderAddress: A string argument which specifies the e-mail address of the person sending the message. This typically corresponds to the address in the From header of the message, but it is not required that they be the same.
recipientAddress: A string argument which specifies the e-mail address of the person or persons to receive the message. Multiple addresses may be specified by separating each address with a comma. It should be noted that this protocol is only concerned with the delivery of a message and not its contents. Header fields in the message are not parsed to automatically determine the recipients. This argument should be a concatenation of all recipients, including carbon copies and blind carbon copies, with each address separated with a comma.
messageText: A string that contains the message to be delivered to the specified recipients. The message must be text and conform to the basic structure defined in RFC 822. There must be one or more headers separated by a blank line, followed by the body of the message. Each line of text must be terminated by a carriage return and linefeed character sequence.

Return Value

This method returns a boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The SendMessage method enables an application to send a formatted e-mail message using the current mail server. This provides a convenient one-step method of addressing and sending a message.

This method will cause the current thread to block until the message transfer completes, a timeout occurs or the transfer is canceled. During the transfer, the OnProgress event will fire periodically, enabling the application to update any user interface objects such as a progress bar.

For each recipient specified, the SendMessage method will determine the appropriate mail exchange server and deliver the message to that user. If the RelayServer and RelayPort properties are defined, then all messages will be relayed through that specific server, regardless of the recipient address. Note that the Secure property and related options only affects connections to relay mail servers. See the RelayServer and RelayPort properties for additional information.

If a relay server is being used, it may require authentication before accepting any messages for delivery. To enable authentication, specify the optionAuthLogin option by setting the Options property. Prior to calling the SendMessage method, the UserName and Password properties should be set to the values that will be used to authenticate the session. If the server does not support authentication, or the user name or password is invalid, an error will be returned. Note that authentication is only performed if a relay server is used, otherwise the option is ignored.

InternetMail.SendMessage Method (String, String, String)

Parameters

Return Value

Remarks

See Also