SmtpClient.SendAsync Method (String, String, String, String, Object)
Assembly: System (in system.dll)
public: void SendAsync ( String^ from, String^ recipients, String^ subject, String^ body, Object^ userToken )
public void SendAsync ( String from, String recipients, String subject, String body, Object userToken )
public function SendAsync ( from : String, recipients : String, subject : String, body : String, userToken : Object )
Parameters
- from
A String that contains the address information of the message sender.
- recipients
A String that contains the address that the message is sent to.
- subject
A String that contains the subject line for the message.
- body
A String that contains the message body.
- userToken
A user-defined object that is passed to the method invoked when the asynchronous operation completes.
| Exception type | Condition |
|---|---|
| from is a null reference (Nothing in Visual Basic). -or- recipient is a null reference (Nothing in Visual Basic). | |
| from is Empty. -or- recipient is Empty. | |
| This SmtpClient has a SendAsync call in progress. -or- Host is a null reference (Nothing in Visual Basic). -or- Host is equal to the empty string (""). -or- Port is zero. | |
| This object has been disposed. | |
| The connection to the SMTP server failed. -or- Authentication failed. -or- The operation timed out. | |
| The message could not be delivered to one or more of the recipients in recipients. |
To receive notification when the e-mail has been sent or the operation has been canceled, add an event handler to the SendCompleted event. You can cancel a SendAsync operation by calling the SendAsyncCancel method.
After calling SendAsync, you must wait for the e-mail transmission to complete before attempting to send another e-mail message using Send or SendAsync.
Before calling this method, the Host and Port properties must be set either through the configuration files or by setting the properties or passing this information into the SmtpClient(String,Int32) constructor.
If the SMTP host requires credentials, you must set them before calling this method. To specify credentials, use the UseDefaultCredentials or Credentials property.
If you receive an SmtpException exception, check the StatusCode property to find the reason the operation failed. The SmtpException can also contain an inner exception that indicates the reason the operation failed.
Your application can detect a server certificate validation error by examining the Error property passed into the SendCompletedEventHandler delegate.
The Timeout property does not have any effect on a SendAsync call.
To send mail and block while it is transmitted to the SMTP server, use one of the Send methods.
- SmtpPermission To connect to the SMTP server. Associated enumeration: Connect
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.