InternetMail.SendMessage Method (String, Int32, String, String, Int32)

Submit the current message to a mail server for delivery.

[Visual Basic]
Overloads Public Function SendMessage( _
   ByVal hostName As String, _
   ByVal hostPort As Integer, _
   ByVal userName As String, _
   ByVal userPassword As String, _
   ByVal timeout As Integer _
) As Boolean

[C#]
public bool SendMessage(
   string hostName,
   int hostPort,
   string userName,
   string userPassword,
   int timeout
);

Parameters

hostName: A string value which specifies the host name or IP address of the mail server that the message will be submitted to for delivery.
hostPort: An integer value which specifies the port number which should be used to establish a connection with the mail server. The default port number is 25 for the Simple Mail Transfer Protocol.
userName: A string value which specifies the user name that will be used to authenticate the client session with the mail server.
userPassword: A string value which specifies the password that will be used to authenticate the client session with the mail server.
timeout: An integer value which specifies a timeout period in seconds. If the message cannot be submitted within the specified time period, the method will fail. The default timeout value for connections is 20 seconds.

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 the current e-mail message using the current mail server. The sender's return address will automatically be determined by the value of the From property. The recipients for the message will be automatically determined by the value of the To, Cc and Bcc properties.

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.

The mail server that is specified must be configured to permit relaying messages, or the submission may fail. In most cases, the server will require that the client authenticate the session with a username and password. Alternatively, some mail servers require that you connect and authenticate with their POP3 service before the SMTP service will accept a message. Consult the documentation for your mail service provider for more information on the requirements for submitting messages for delivery.

InternetMail.SendMessage Method (String, Int32, String, String, Int32)

Parameters

Return Value

Remarks

See Also