Class

# InternetHeaders

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

## Description

Used to manage HTTP and Email headers.

## Methods

<div class="rst-class">

table-centered_column_4

</div>

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

## Method descriptions

<div id="internetheaders.addheader">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.commaseparatedvalues">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.count">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.name">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.namecount">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.removeallheaders">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.RemoveAllHeaders

**RemoveAllHeaders**

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

<div id="internetheaders.removeheader">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.source">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.Source

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

> Returns a `String</api/data_types/string>` containing the raw source text of the headers.
>
> The Name and Value are separated by a colon for each header and the headers are delimited by an `EndOfLine</api/text/endofline>`.
>
> This example retrieves the internet headers and displays them in a `TextArea</api/user_interface/desktop/desktoptextarea>`.
>
> ``` xojo
> Var mail As New EmailMessage
> TextArea1.Text = mail.Headers.Source
> ```

<div id="internetheaders.value">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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="internetheaders.valueat">

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

</div>

<div class="rst-class">

forsearch

</div>

InternetHeaders.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)
> ```

## Compatibility

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

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class; `EmailAttachment</api/networking/emailattachment>`, `EmailHeaders</api/networking/emailheaders>`, `EmailMessage</api/networking/emailmessage>`, `URLConnection</api/networking/urlconnection>`, `POP3SecureSocket</api/networking/pop3securesocket>`, `SMTPSecureSocket</api/networking/smtpsecuresocket>`, `SMTPSecureSocket</api/networking/smtpsecuresocket>` classes.

</div>