<div class="meta" robots="noindex">

</div>

Class

# SMTPSocket

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

<div class="warning">

<div class="title">

Warning

</div>

This item was deprecated in version 2018r4. Please use `SMTPSecureSocket</api/networking/smtpsecuresocket>` as a replacement.

</div>

## Description

Used to send email via the SMTP protocol. Use the `EmailMessage</api/networking/emailmessage>` class to create the email message to send.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                            | Type                                                 | Read-Only | Shared |
|-------------------------------------------------|------------------------------------------------------|-----------|--------|
| `Address<smtpsocket.address>`                   | `String</api/data_types/string>`                     |           |        |
| `BytesAvailable<smtpsocket.bytesavailable>`     | `Integer</api/data_types/integer>`                   | ✓         |        |
| `BytesLeftToSend<smtpsocket.byteslefttosend>`   | `Integer</api/data_types/integer>`                   | ✓         |        |
| `Handle<smtpsocket.handle>`                     | `Integer</api/data_types/integer>`                   | ✓         |        |
| `IsConnected<smtpsocket.isconnected>`           | `Boolean</api/data_types/boolean>`                   | ✓         |        |
| `LocalAddress<smtpsocket.localaddress>`         | `String</api/data_types/string>`                     | ✓         |        |
| `Messages<smtpsocket.messages>`                 | `EmailMessage</api/networking/emailmessage>`         |           |        |
| `NetworkInterface<smtpsocket.networkinterface>` | `NetworkInterface</api/networking/networkinterface>` |           |        |
| `Password<smtpsocket.password>`                 | `String</api/data_types/string>`                     |           |        |
| `Port<smtpsocket.port>`                         | `Integer</api/data_types/integer>`                   |           |        |
| `RemoteAddress<smtpsocket.remoteaddress>`       | `String</api/data_types/string>`                     | ✓         |        |
| `UserName<smtpsocket.username>`                 | `String</api/data_types/string>`                     |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                    | Parameters                                                                                                   | Returns                            | Shared |
|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|------------------------------------|--------|
| `Close<smtpsocket.close>`                               |                                                                                                              |                                    |        |
| `Connect<smtpsocket.connect>`                           |                                                                                                              |                                    |        |
| `DeleteAllMessages<smtpsocket.deleteallmessages>`       |                                                                                                              |                                    |        |
| `Disconnect<smtpsocket.disconnect>`                     |                                                                                                              |                                    |        |
| `DisconnectFromServer<smtpsocket.disconnectfromserver>` |                                                                                                              |                                    |        |
| `EndOfFile<smtpsocket.endoffile>`                       |                                                                                                              | `Boolean</api/data_types/boolean>` |        |
| `Flush<smtpsocket.flush>`                               |                                                                                                              |                                    |        |
| `Listen<smtpsocket.listen>`                             |                                                                                                              |                                    |        |
| `Lookahead<smtpsocket.lookahead>`                       | \[Encoding As `TextEncoding</api/text/encoding_text/textencoding>`\]                                         | `String</api/data_types/string>`   |        |
| `Poll<smtpsocket.poll>`                                 |                                                                                                              |                                    |        |
| `Purge<smtpsocket.purge>`                               |                                                                                                              |                                    |        |
| `Read<smtpsocket.read>`                                 | Count As `Integer</api/data_types/integer>`, \[Enc As `TextEncoding</api/text/encoding_text/textencoding>`\] | `String</api/data_types/string>`   |        |
| `ReadAll<smtpsocket.readall>`                           | \[Encoding As `TextEncoding</api/text/encoding_text/textencoding>`\]                                         | `String</api/data_types/string>`   |        |
| `SendMail<smtpsocket.sendmail>`                         |                                                                                                              |                                    |        |
| `Write<smtpsocket.write>`                               | Data As `String</api/data_types/string>`                                                                     |                                    |        |

## Events

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                      | Parameters                                                                                                                                             | Returns |
|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `ConnectionEstablished<smtpsocket.connectionestablished>` | Greeting As `String</api/data_types/string>`                                                                                                           |         |
| `DataAvailable<smtpsocket.dataavailable>`                 |                                                                                                                                                        |         |
| `Error<smtpsocket.error>`                                 | e As `RuntimeException</api/exceptions/runtimeexception>`                                                                                              |         |
| `MailSent<smtpsocket.mailsent>`                           |                                                                                                                                                        |         |
| `MessageSent<smtpsocket.messagesent>`                     | Email As `EmailMessage</api/networking/emailmessage>`                                                                                                  |         |
| `SendProgress<smtpsocket.sendprogress>`                   | BytesSent As `Integer</api/data_types/integer>`, BytesLeft As `Integer</api/data_types/integer>`                                                       |         |
| `ServerError<smtpsocket.servererror>`                     | ErrorID As `Integer</api/data_types/integer>`, ErrorMessage As `String</api/data_types/string>`, Email As `EmailMessage</api/networking/emailmessage>` |         |

## Property descriptions

<div id="smtpsocket.address">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Address

**Address** As `String</api/data_types/string>`

The TCP/IP address to try to connect to.

In this example, the address has been entered into a `TextField</api/user_interface/desktop/desktoptextfield>`.

``` xojo
TCPSocket1.Address = TextField1.Text
```

<div id="smtpsocket.bytesavailable">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.BytesAvailable

**BytesAvailable** As `Integer</api/data_types/integer>`

The number of bytes of data are available in the internal receive buffer.

This property is read-only.

``` xojo
TextField1.Text = Me.BytesAvailable.ToString
```

<div id="smtpsocket.byteslefttosend">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.BytesLeftToSend

**BytesLeftToSend** As `Integer</api/data_types/integer>`

The number of bytes left in the queue remaining to be sent.

This property is read-only.

This enables you to create a synchronous socket without needing to subclass it.

``` xojo
TextField1.Text = Me.BytesLeftToSend.ToString
```

<div id="smtpsocket.handle">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Handle

**Handle** As `Integer</api/data_types/integer>`

This is the socket's internal descriptor and it can be used with `Declare</api/language/declare>` statements.

This property is read-only.

- On Windows, Handle is a Socket, suitable for use in `Declares</api/language/declare>` on Windows.
- On macOS and Linux, Handle is a UNIX socket descriptor.

The descriptor is platform-specific. If *Handle* is less than zero, the descriptor is not available.

<div id="smtpsocket.isconnected">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.IsConnected

**IsConnected** As `Boolean</api/data_types/boolean>`

Indicates whether the socket is currently connected.

This property is read-only.

For `TCPSockets</api/networking/tcpsocket>`, a connection means you can send and receive data and are connected to a remote machine. For `UDPSockets</api/networking/udpsocket>`, this means that you are bound to the port and are able to send, receive, join or leave multicast groups, or set socket options.

``` xojo
If EasyUDPSocket1.IsConnected Then
  ' proceed using the connection
Else
  MessageBox("Connection failed!")
End If
```

<div id="smtpsocket.localaddress">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.LocalAddress

**LocalAddress** As `String</api/data_types/string>`

The local IP address of the computer.

This property is read-only.

``` xojo
Var localIP As String = Socket1.LocalAddress
```

<div id="smtpsocket.messages">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Messages

**Messages** As `EmailMessage</api/networking/emailmessage>`

The queue of messages that is waiting to be sent.

This is an array of which the 0th element is the next message to be sent. When a message is sent, it is removed from the queue and passed to the MessageSent event. To append a message to the queue, use the `Arrays<arrays.add>` method. To remove a message, use the `Arrays<arrays.removeat>` method.

Send a simple email:

``` xojo
Dim mail As EmailMessage

' set up the socket
Socket1.Address = "smtp.myserver.com"
Socket1.Port = 25

Socket1.UserName = "<username>"
Socket1.Password = "<password>"

' populate the email message
mail = New EmailMessage
mail.FromAddress = "test@testsite.org"
mail.Subject = "My Subject"
mail.BodyPlainText = "Hello!"
mail.Headers.AppendHeader("X-Mailer","SMTP Test")

' send the email
Socket1.Messages.Append(mail)
Socket1.SendMail
```

<div id="smtpsocket.networkinterface">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.NetworkInterface

**NetworkInterface** As `NetworkInterface</api/networking/networkinterface>`

Specifies which network interface the socket should use when binding.

You can get the network interface(s) of the user's computer by calling the `GetNetworkInterface<system.networkinterface>` method of the `System</api/os/system>` module.

Leaving this property set to `Nil</api/language/nil>` will use the currently selected interface. In the case of `UDPSockets</api/networking/udpsocket>`, if you assign a non-`Nil</api/language/nil>` value, the socket may not be able to receive broadcast messages. The behavior is OS-dependent; it appears to work on Windows but not on other supported operating systems. If you wish to send broadcast packets out, then you should not bind to a specific interface because the behavior is undefined.

This example specifies that the `TCPSocket</api/networking/tcpsocket>` will use the first Network Interface on the user's computer.

``` xojo
TCPSocket1.NetworkInterface = System.NetworkInterface(0)
```

<div id="smtpsocket.password">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Password

**Password** As `String</api/data_types/string>`

The Password to use to log into the SMTP server.

<div id="smtpsocket.port">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Port

**Port** As `Integer</api/data_types/integer>`

The port to bind on or connect to.

On most operating systems, attempting to bind to a port less than 1024 causes a `Error<socketcore.error>` event to fire with an error number 107 unless the application is running with administrative permissions. This is due to security features built into the underlying OS.

You need to set the port property explicitly before any call to Listen or Connect as the Port property will be modified to reflect what the actual bound port is during the various stages of operation.

For instance, if you listen on port 8080 and a connection comes in, you can check the Port property to ensure that you're still listening on port 8080 (that the port hasn't been hijacked). Or, if you connect to a socket on port 8080, once the connection occurs, you can check to see what port the OS has bound you to. This will be a random-seeming port number.

This trick can be very useful when you do things like Listen on port 0. In that case, the OS will pick a port for you and listen on it. Then you can check the Port property to see which port the OS picked. This functionality is used for various protocols, such as FTP.

This example sets the Port to 8080.

``` xojo
TCPSocket1.Port = 8080
```

<div id="smtpsocket.remoteaddress">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.RemoteAddress

**RemoteAddress** As `String</api/data_types/string>`

The address of the remote machine you are connected to.

This property is read-only.

Use this instead of the Address property to determine the address of the machine you are actually connected to.

This example reports the address of the remote machine that the user is connected to. It is in the Connected event.

``` xojo
TextField1.Text = Me.RemoteAddress
```

<div id="smtpsocket.username">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.UserName

**UserName** As `String</api/data_types/string>`

The UserName to use to log into the SMTP server.

## Method descriptions

<div id="smtpsocket.close">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Close

**Close**

Closes the socket's connection, closes any connections the socket may have, and resets the socket.

The only information that is retained after calling Close is the socket's port, address (in the case of `TCPSockets</api/networking/tcpsocket>`), LastErrorCode properties, and data left in the socket's receive buffer. All other information is discarded.

This example closes the `EasyTCPSockets</api/networking/easytcpsocket>` that were open. The sockets were added to the main window.

``` xojo
Connector.Close
Listener.Close
```

<div id="smtpsocket.connect">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Connect

**Connect**

Attempts to connect.

For `TCPSockets</api/networking/tcpsocket>`, the address and port properties must be set. For `UDPSockets</api/networking/udpsocket>`, the port property must be set. The Connect method binds a socket to a port. After calling Connect, the Port property will report the actual port you are bound to.

<div id="smtpsocket.deleteallmessages">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.DeleteAllMessages

**DeleteAllMessages**

Deletes all messages from the send queue.

This example deletes all the messages in the queue. Socket1 is an SPTPSocket in the window.

``` xojo
Socket1.DeleteAllMessages
```

<div id="smtpsocket.disconnect">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Disconnect

**Disconnect**

Disconnects the socket, resets it, and fires a `SocketCore</api/networking/socketcore>` Error event with a 102 error to let you know that the socket has been disconnected.

This example disconnects the `EasyTCPSockets</api/networking/easytcpsocket>` that were opened.

``` xojo
Connector.Disconnect
Listener.Disconnect
```

<div id="smtpsocket.disconnectfromserver">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.DisconnectFromServer

**DisconnectFromServer**

Closes the connection with the mail server.

<div id="smtpsocket.endoffile">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.EndOfFile

**EndOfFile** As `Boolean</api/data_types/boolean>`

Returns `True</api/language/true>` when there's no more data left to read.

This code reads the rows and columns of data from a tab-delimited text file into a `ListBox</api/deprecated/listbox>`:

``` xojo
Var f As FolderItem
Var textInput As TextInputStream
Var rowFromFile, oneCell As String

f = FolderItem.ShowOpenFileDialog("text/plain") ' defined as a FileType
If f <> Nil Then
  textInput = TextInputStream.Open(f)
  textInput.Encoding = Encodings.UTF8

  Do
    rowFromFile = textInput.ReadLine
    Var values() As String = rowFromFile.Split(Chr(9))
    ListBox1.ColumnCount = values.Count
    ListBox1.AddRow("")
    Var col As Integer
    For Each value As String In values
      ListBox1.CellTextAt(ListBox1.LastAddedRowIndex, col) = value
      col = col + 1
    End For
  Loop Until textInput.EndOfFile

  textInput.Close
End If
```

This example reads each pair of bytes from a file and writes them in reverse order to a new file. The user chooses the source file using the Open-file dialog box and saves the new file using the Save as dialog box. The EOF property is used to terminate the `Do...Loop</api/language/loops/do...loop>`.

``` xojo
Var readFile As FolderItem = FolderItem.ShowOpenFileDialog("text")
If readFile <> Nil Then
  Var ReadStream As BinaryStream = BinaryStream.Open(readFile, False)
  ReadStream.LittleEndian = True
  Var writeFile As FolderItem = FolderItem.ShowSaveFileDialog("", "")
  If writeFile <> Nil Then
    Var writeStream As BinaryStream = BinaryStream.Create(writeFile, True)
    writeStream.LittleEndian = True
    Do Until ReadStream.EndOfFile
      writeStream.WriteInt8(ReadStream.ReadInt8)
    Loop
    writeStream = Nil
  End If
  readStream = Nil
End If
```

<div id="smtpsocket.flush">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Flush

**Flush**

Immediately sends the contents of internal write buffers to disk or to the output stream.

This function can be useful in point-to-point communication over sockets and similar connections: To optimize for transmission performance, some types of output streams try to collect small pieces of written data into one larger piece for sending instead of sending each piece out individually. By calling Flush, the data collection is stopped and the data is sent without further delay, reducing latency.

When using this on a stream that ends up as a file on disk, it is useful, too: Any short parts of previously written data are written to disk right away, ensuring the data is actually on disk if the application terminates abruptly, e.g. due to a crash.

Avoid calling this method too often. For example, do not call it between successive Write calls because you'll slow down performance without getting much benefit.

A typical use case would look like this:

``` xojo
mySocket.Write("you typed: ")
mySocket.Write(key)
mySocket.Write(".")
mySocket.Flush
```

<div id="smtpsocket.listen">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Listen

**Listen**

Attempts to listen for incoming connections on the currently specified port.

After calling Listen, the Port property will report the actual port you are bound to.

<div id="smtpsocket.lookahead">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Lookahead

**Lookahead**(\[Encoding As `TextEncoding</api/text/encoding_text/textencoding>`\]) As `String</api/data_types/string>`

Returns a `String</api/data_types/string>`, containing the data that is available in the internal queue without removing it.

The optional *Encoding* parameter enables you to specify the text encoding of the data to be returned. The default is `Nil</api/language/nil>`. Use the `Encodings</api/text/encoding_text/encodings>` module to specify an encoding.

This example adds the contents of the internal queue to a `TextArea</api/deprecated/textarea>`. The Listener `EasyTCPSocket</api/networking/easytcpsocket>` has been added to the window.

``` xojo
TextArea1.AddText(listener.Lookahead)
```

<div id="smtpsocket.poll">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Poll

**Poll**

Polls the socket manually, which allows a socket to be used synchronously.

The `EasyTCPSocket</api/networking/easytcpsocket>` "Listener" has been added to the window.

``` xojo
Listener.Poll
```

<div id="smtpsocket.purge">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Purge

**Purge**

Removes all data from the socket's internal receive buffer. It does not affect the socket's internal send buffer.

``` xojo
Listener.Purge
```

<div id="smtpsocket.read">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Read

**Read**(Count As `Integer</api/data_types/integer>`, \[Enc As `TextEncoding</api/text/encoding_text/textencoding>`\]) As `String</api/data_types/string>`

Reads *Count* bytes from the input stream and returns a `String</api/data_types/string>`.

If provided, the optional parameter *Enc* specifies the text encoding to be defined for the `String</api/data_types/string>` to be read.

If *Count* is higher than the amount of bytes currently available in the stream, all available bytes will be returned. Therefore, make sure to always consider the case that you get less than you requested. To see if you received all requested bytes, check the returned string's `String<string.bytes>` property (avoid using `Length<binarystream.length>` as it may give a different number if the encoding is not nil).

If not enough memory is available, you get back an empty string.

This example reads the first 1000 bytes from a `BinaryStream</api/files/binarystream>`.

``` xojo
Var readFile As FolderItem = FolderItem.ShowOpenFileDialog("text/plain")
If readFile <> Nil Then
  Var ReadStream As BinaryStream = BinaryStream.Open(readFile, False)
  ReadStream.LittleEndian = True
  TextArea1.Text = ReadStream.Read(1000, Encodings.UTF8)
End If
```

<div id="smtpsocket.readall">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.ReadAll

**ReadAll**(\[Encoding As `TextEncoding</api/text/encoding_text/textencoding>`\]) As `String</api/data_types/string>`

Reads all the data from the internal buffer.

This example reads all the data in the buffer into a `TextArea</api/deprecated/textarea>`.

``` xojo
TextField1.AddText(listener.ReadAll)
```

<div id="smtpsocket.sendmail">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.SendMail

**SendMail**

Connects to the mail server, sends the messages in the queue, and disconnects.

This method works asynchronously. So keep the reference to this <span class="title-ref">SMTPSocket</span> object alive while mail is sent: e.g. as a property of a window.

This example is the Action event of the Send button on the Send Mail Demo main window. It sends the new message after adding it to the array of messages.

``` xojo
Dim mail As EmailMessage

' set up the socket
Socket1.Address = "smtp.myserver.com"
Socket1.Port = 25

Socket1.UserName = "<username>"
Socket1.Password = "<password>"

' populate the email message
mail = New EmailMessage
mail.FromAddress = "test@testsite.org"
mail.Subject = "My Subject"
mail.BodyPlainText = "Hello!"
mail.Headers.AppendHeader("X-Mailer","SMTP Test")

' send the email
Socket1.Messages.Append(mail)
Socket1.SendMail
```

<div id="smtpsocket.write">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Write

**Write**(Data As `String</api/data_types/string>`)

Writes the passed data to the output stream.

Note that in order to make sure that the data actually ends up on disk or gets sent to the socket it is connected to, the stream must either get closed or the `Flush<writeable.flush>` method be called. Otherwise, the data, if small, may end up temporarily in a write buffer before either a certain time has passed or more data is written. This buffering increases performance when writing lots of small pieces of data, but may be causing unwanted delays when another process, e.g. the other end of a socket connection, is waiting for the data. Consider calling the `Flush<writeable.flush>` method to reduce latencies that this buffering may cause in such cases.

If Write fails, an `IOException</api/exceptions/ioexception>` will be raised.

This example displays the Save As dialog box and writes the contents of the TextArea1 to a text file.

``` xojo
Var f As FolderItem
Var stream As BinaryStream
f = FolderItem.ShowSaveFileDialog(FileTypes1.Text, "Untitled.txt")
If f<> Nil Then
  stream = BinaryStream.Create(f, True)
  stream.Write(TextArea1.Text)
  stream.Close
End If
```

## Event descriptions

<div id="smtpsocket.connectionestablished">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.ConnectionEstablished

**ConnectionEstablished**(Greeting As `String</api/data_types/string>`)

Executes when the connection has been established with the mail server and passes the greeting string that the server returned.

<div id="smtpsocket.dataavailable">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.DataAvailable

**DataAvailable**

Occurs when additional data has come into the internal receive buffer.

<div id="smtpsocket.error">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.Error

**Error**(e As `RuntimeException</api/exceptions/runtimeexception>`)

Occurs when an error occurs with the socket.

These error codes provide you with key information about your socket, and it is not advisable to ignore them.

When an error occurs, the `RuntimeException<runtimeexception.errornumber>` property will likely contain one of the following error codes:

| Error Code | Description                                                                                                             |
|------------|-------------------------------------------------------------------------------------------------------------------------|
| 0          | No error occurred.                                                                                                      |
| 100        | There was an error opening and initializing the drivers.                                                                |
| 101        | This error code is no longer used.                                                                                      |
| 102        | This code means that you lost your connection.                                                                          |
| 103        | The socket was unable to resolve the address that was specified.                                                        |
| 104        | This error code is no longer used.                                                                                      |
| 105        | The address is currently in use.                                                                                        |
| 106        | This is an invalid state error, which means that the socket is not in the proper state to be doing a certain operation. |
| 107        | This error means that the port you specified is invalid.                                                                |
| 108        | This error indicates that your application has run out of memory.                                                       |

These are not the only errors that are returned. For Windows, additional error codes are usually positive numbers in the range \[10004, 11004\]. For Windows error codes, see WinSock.h. MacOS and Linux use POSIX error codes. For a description of macOS and Linux error codes, see <http://www.ioplex.com/~miallen/errcmp.html>.

e.g. error 64 is for "host is down".

The following example in the Error event handler displays the error code.

``` xojo
MessageBox(Me.e.ErrorNumber.ToString)
```

<div id="smtpsocket.mailsent">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.MailSent

**MailSent**

Executes when all of the messages in the queue have been sent.

<div id="smtpsocket.messagesent">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.MessageSent

**MessageSent**(Email As `EmailMessage</api/networking/emailmessage>`)

Executes when a message has been sent.

<div id="smtpsocket.sendprogress">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.SendProgress

**SendProgress**(BytesSent As `Integer</api/data_types/integer>`, BytesLeft As `Integer</api/data_types/integer>`)

Occurs when your network provider queues your data in chunks and is about to send the next chunk.

The parameters indicate the amount of progress that has been made during the send. Returns a `Boolean</api/data_types/boolean>`.

Returning `True</api/language/true>` from this event causes the send to be cancelled. This does not close the socket's connection; it only clears the buffer. After all of the data has been transferred you will get a final SendProgress event followed by a `SendComplete<socketcore.sendcomplete>` event.

*bytesSent* is the number of bytes that were sent in the chunk, not the total number of bytes sent.

<div id="smtpsocket.servererror">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

SMTPSocket.ServerError

**ServerError**(ErrorID As `Integer</api/data_types/integer>`, ErrorMessage As `String</api/data_types/string>`, Email As `EmailMessage</api/networking/emailmessage>`)

Executes when an error occured while sending a message.

*ErrorID* and *ErrorMessage* are sent by the mail server and *Email* is the message that was being sent when the error occurred. *Email* is removed from the queue at the time the event executes.

## Notes

The `POP3SecureSocket</api/networking/pop3securesocket>` and <span class="title-ref">SMTPSocket</span> classes are used together to form the basis of an email client. POP3 is the standard internet protocol for receiving messages and SMTP (Simple Mail Transfer Protocol) is the standard internet protocol for sending emails.

SMTPSocket supports the 'login' authentication type as well as 'plain.' This increases the authentication compatibility with some servers.

If you use a constructor in a subclass of <span class="title-ref">SMTPSocket</span>, you must call the Super class's constructor in your subclass's constructor. The subclass will not work unless this is done.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Gmail

Use `SMTPSecureSocket</api/networking/smtpsecuresocket>` to connect to Gmail.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Xojo cloud

To access an SMTP server from web apps running on Xojo Cloud, you will first have to use the `FirewallPort</api/xojocloud/firewallport>` class to open the port used to connect to the SMTP Server:

``` xojo
Dim fwp As New XojoCloud.FirewallPort(587,  _
  XojoCloud.FirewallPort.Direction.Outgoing)
fwp.Open ' This call is synchronous
If fwp.isOpen Then
  ' Do what you need to do
End If
```

## Sample code

The following code assumes an <span class="title-ref">SMTPSocket</span> named SendMailSocket, has been added to the window.

``` xojo
SendMailSocket.Address = "mail.mySMTPServer.com" ' your SMTP email server
SendMailSocket.Port = 25 ' Check your server for the property port # to use

' Create the actual email message
Dim mail As New EmailMessage
mail.FromAddress = "bill@yourdomain.com"
mail.Subject = "Test Email from Xojo"
mail.BodyPlainText = "Hello, World!"
mail.Headers.AppendHeader("X-Mailer", "Xojo SMTP Example") ' Sample header
mail.AddRecipient("john@domain.com")

' Add the message to the SMTPSocket and send it
SendMailSocket.Messages.Append(mail)
SendMailSocket.SendMail
```

## Compatibility

All project types on all supported operating systems.

## See also

`TCPSocket</api/networking/tcpsocket>` parent class; `EmailAttachment</api/networking/emailattachment>`, `EmailHeaders</api/networking/emailheaders>`, `EmailMessage</api/networking/emailmessage>`, `URLConnection</api/networking/urlconnection>`, `URLConnection</api/networking/urlconnection>`, `POP3SecureSocket</api/networking/pop3securesocket>`, `POP3SecureSocket</api/networking/pop3securesocket>`, `SMTPSecureSocket</api/networking/smtpsecuresocket>`, `SocketCore</api/networking/socketcore>`, `TCPSocket</api/networking/tcpsocket>` classes.
