Class

# EmailHeaders

<div class="rst-class">

forsearch

</div>

EMail

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

## Description

Used to hold the headers for an email.

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                      | Parameters                                                                                 | Returns                            | Shared |
|-----------------------------------------------------------|--------------------------------------------------------------------------------------------|------------------------------------|--------|
| `AddHeader<emailheaders.addheader>`                       | Name As `String</api/data_types/string>`, Value As `String</api/data_types/string>`        |                                    |        |
| `CommaSeparatedValues<emailheaders.commaseparatedvalues>` | Name As `String</api/data_types/string>`                                                   | `String</api/data_types/string>`   |        |
| `Count<emailheaders.count>`                               |                                                                                            | `Integer</api/data_types/integer>` |        |
| `Name<emailheaders.name>`                                 | Index As `Integer</api/data_types/integer>`                                                | `String</api/data_types/string>`   |        |
| `NameCount<emailheaders.namecount>`                       | Name As `String</api/data_types/string>`                                                   | `Integer</api/data_types/integer>` |        |
| `RemoveAllHeaders<emailheaders.removeallheaders>`         |                                                                                            |                                    |        |
| `RemoveHeader<emailheaders.removeheader>`                 | Name As `String</api/data_types/string>`, index As `Integer</api/data_types/integer>` = -1 |                                    |        |
| `Source<emailheaders.source>`                             |                                                                                            | `String</api/data_types/string>`   |        |
| `Value<emailheaders.value>`                               | Name As `String</api/data_types/string>`, index As `Integer</api/data_types/integer>` = -1 | `String</api/data_types/string>`   |        |
| `ValueAt<emailheaders.valueat>`                           | index As `Integer</api/data_types/integer>`                                                | `String</api/data_types/string>`   |        |

## Method descriptions

<div id="emailheaders.addheader">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.AddHeader

**AddHeader**(Name As `String</api/data_types/string>`, Value As `String</api/data_types/string>`)

> Adds a new header.
>
> ``` xojo
> ' populate a email message
> Var mail As New EmailMessage
> mail.FromAddress = FromAddressField.Text
> mail.Subject = SubjectField.Text
> mail.BodyPlainText = BodyField.Text
> mail.BodyHTML = HtmlField.Text
> mail.Headers.AddHeader("X-Mailer", "Example SMTP Demo")
> ```

<div id="emailheaders.commaseparatedvalues">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.CommaSeparatedValues

**CommaSeparatedValues**(Name As `String</api/data_types/string>`) As `String</api/data_types/string>`

> Returns the value of the header corresponding to the passed *Name*.
>
> The following example returns the value of the "X-Mailer" header.
>
> ``` xojo
> ' mail is an EmailMessage
> Var s As String
> s = mail.Headers.CommaSeparatedValues("X-Mailer")
> ```

<div id="emailheaders.count">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.Count

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

> Returns the number of headers as an `Integer</api/data_types/integer>`.
>
> ``` xojo
> Var i As Integer = mail.Headers.Count
> ```

<div id="emailheaders.name">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.Name

**Name**(Index As `Integer</api/data_types/integer>`) As `String</api/data_types/string>`

> Returns as a `String</api/data_types/string>` the name of the header specified by its index. *Index* is zero-based.
>
> This example reads the first header.
>
> ``` xojo
> Var s As String
> s = mail.Headers.Name(0)
> ```

<div id="emailheaders.namecount">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.NameCount

**NameCount**(Name As `String</api/data_types/string>`) As `Integer</api/data_types/integer>`

> Returns as an `Integer</api/data_types/integer>` the number of headers with the name passed to it.
>
> Internet headers can have multiple headers with the same name.
>
> ``` xojo
> Var i As Integer
> i = mail.Headers.NameCount("X-Mailer").ToString
> ```

<div id="emailheaders.removeallheaders">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.RemoveAllHeaders

**RemoveAllHeaders**

> Removes all headers.
>
> This example removes all the headers.
>
> ``` xojo
> Var mail As New EmailMessage
> mail.Headers.RemoveAllHeaders
> ```

<div id="emailheaders.removeheader">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.RemoveHeader

**RemoveHeader**(Name As `String</api/data_types/string>`, index As `Integer</api/data_types/integer>` = -1)

> Removes the specified header.
>
> ``` xojo
> mail.Headers.RemoveHeader("X-Mailer")
> ```

<div id="emailheaders.source">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.Source

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

> Returns a `String</api/data_types/string>` containing the raw source text of the headers.

<div id="emailheaders.value">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.Value

**Value**(Name As `String</api/data_types/string>`, index As `Integer</api/data_types/integer>` = -1) As `String</api/data_types/string>`

> Returns a `String</api/data_types/string>` containing the value of the specified header. More than one header can have the same name.
>
> ``` xojo
> Var s As String
> s = mail.Headers.Value("X-Mailer")
> ```
>
> ``` xojo
> Var s As String
> s = mail.Headers.Value(1)
> ```
>
> ``` xojo
> Var s As String
> s = mail.Headers.Value("X-Mailer", 1)
> ```

<div id="emailheaders.valueat">

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

</div>

<div class="rst-class">

forsearch

</div>

EmailHeaders.ValueAt

**ValueAt**(index As `Integer</api/data_types/integer>`) As `String</api/data_types/string>`

> Returns the header at the specified *index*.
>
> ``` xojo
> Var s As String
> s = mail.Headers.ValueAt(1)
> ```

## Notes

Please refer to `InternetHeaders</api/networking/internetheaders>` for descriptions of this class's methods.

## Sample code

The following sets the header of an outgoing email.

``` xojo
Var mail As EmailMessage
mail = New EmailMessage
mail.Headers.AddHeader("X-Mailer","Example SMTPSocket Demo")
```

## Compatibility

|                       |                       |
|-----------------------|-----------------------|
| **Project Types**     | Console, Desktop, Web |
| **Operating Systems** | All                   |

<div class="seealso">

`InternetHeaders</api/networking/internetheaders>` parent class; `EmailAttachment</api/networking/emailattachment>`, `EmailMessage</api/networking/emailmessage>`, `InternetHeaders</api/networking/internetheaders>`, `POP3SecureSocket</api/networking/pop3securesocket>`, `POP3SecureSocket</api/networking/pop3securesocket>`, `SMTPSecureSocket</api/networking/smtpsecuresocket>`, `SMTPSecureSocket</api/networking/smtpsecuresocket>`, `SocketCore</api/networking/socketcore>`, `SSLSocket</api/networking/sslsocket>`, `TCPSocket</api/networking/tcpsocket>` classes.

</div>