# <CookieOptions>

The CookieOptions element holds cookies used when retrieving files via HTTP during conversion of the document. Briefly, cookies allow web servers to store information on the client (e.g., requester, iSiloX) so that the information can be sent back to the web server. This information can be used for a variety of purposes such as maintaining a login state or for tracking purposes. For more information about cookies, please consult sources on the Web. By default, usage of cookies is disabled. These options require version 3.2 or later of iSiloX and iSiloXC.

## Full element example

        <CookieOptions>
          <SendCookies              value="no"/>
          <ReceiveCookies           value="no"/>
          <Cookies>
            <Cookie>
              <ReadOnly             value="no"/>
              <DoNotSend            value="no"/>
              <Discard              value="no"/>
              <Secure               value="no"/>
              <Name>TOKEN</Name>
              <Value>48A897ZUIO98</Value>
              <Expires>2015/12/25 08:52:12</Expires>
              <Version>1</Version>
              <Path>/</Path>
              <Port>80,8000</Port>
              <Domain>.foo.com</Domain>
              <Comments>none</Comments>
              <CommentURL>http://www.foo.com/cookies.htm</CommentURL>
            </Cookie>
          </Cookies>
        </CookieOptions>

## Sub-element summary

Tag | Type | Default | Description
--- | --- | --- | ---
`<SendCookies>` | value | no | Whether or not to send cookies.
`<ReceiveCookies>` | value | no | Whether or not to receive cookies.
`<Cookies>` | container | n/a | Holds cookies to send or cookies that have been received.

### <SendCookies>

Description
Set the value attribute of the tag to `yes` to enable the sending of cookies or `no` to prevent the sending of cookies.
Examples
This example specifies that cookies should be sent.

      <SendCookies              value="yes"/>

This example specifies that cookies should not be sent.

      <SendCookies              value="no"/>

### <ReceiveCookies>

Description
Set the value attribute of the tag to `yes` to enable receiving of cookies or `no` to prevent receiving of cookies.
Examples
This example specifies that cookies should be received.

      <ReceiveCookies           value="yes"/>

This example specifies that cookies should not be received.

      <ReceiveCookies           value="no"/>

## <Cookies> sub-element summary

The Cookies container element holds the document's cookies. A document may have zero or more cookies, each represented by its own Cookie container subelement within the Cookies container element.

Tag | Type | Default | Description
--- | --- | --- | ---
`<Cookie>` | container | n/a | Holds information about a cookie.

### <Cookie> sub-element summary

The Cookie container element holds information about a cookie. It has the following subelements:

Tag | Type | Default | Description
--- | --- | --- | ---
`<ReadOnly>` | value | no | Whether the cookie is read-only.
`<DoNotSend>` | value | no | Whether to allow the cookie to be sent.
`<Discard>` | value | no | Whether to make the cookie a secure cookie.
`<Secure>` | value | no | Whether to create bookmarks from hyperlinks in an HTML file
`<Name>` | string | n/a | Name of the cookie.
`<Value>` | string | n/a | Value or information of the cookie.
`<Expires>` | string | n/a | Expiration date and time of the cookie.
`<Version>` | string | n/a | Version number of the cookie specification used.
`<Path>` | string | n/a | Path to which the cookie applies.
`<Port>` | string | n/a | Port number to which the cookie applies.
`<Domain>` | string | n/a | Domain to which the cookie applies.
`<Comments>` | string | n/a | Optional comment about the cookie.
`<CommentURL>` | string | n/a | Optional URL with comment about the cookie.

#### <ReadOnly>

Description
Set the value attribute of the tag to `yes` to prevent a received cookie with the same name, path, and domain from replacing the current cookie. Set the value attribute to `no` to allow the cookie to be overwritten with a newly received cookie that matches the name, path, and domain of the cookie.
Examples
This example specifies that the cookie is read-only.

      <ReadOnly                 value="yes"/>

This example specifies that the cookie can be overwritten.

      <ReadOnly                 value="no"/>

#### <DoNotSend>

Description
Set the value attribute of the tag to `yes` to prevent the cookie from being sent. Note that the cookie can still be overwritten even if it can not be sent. Set the value attribute to `no` to allow the cookie to be sent.
Examples
This example specifies that the cookie can not be sent.

      <DoNotSend                value="yes"/>

This example specifies that the cookie can be sent.

      <DoNotSend                value="no"/>

#### <Discard>

Description
Set the value attribute of the tag to `yes` to have the cookie automatically deleted from the list after the next conversion. Set the value attribute of the tag to `no` to have the cookie deleted only when it expires.
Examples
This example specifies that the cookie should be deleted after the next conversion.

      <Discard                  value="yes"/>

This example specifies that the cookie should be deleted when it expires.

      <Discard                  value="no"/>

#### <Secure>

Description
Set the value attribute of the tag to `yes` to mark the cookie as a secure cookie. Secure cookies are not sent. Set the value attribute of the tag to `no` to mark the cookie as an unsecure cookie.
Examples
This example specifies that the cookie is secure.

      <Secure                   value="yes"/>

This example specifies that the cookie is not a secure cookie.

      <Secure                   value="no"/>

#### <Name>

Description
Set the content of the element to the name of the cookie. All cookies must have a name.

#### <Value>

Description
Set the content of the element to the value or information of the cookie.

#### <Expires>

Description
Set the content of the element to the cookie's expiration date and time in the form YYYY/MM/DD HH:MM:SS, where YYYY/MM/DD is the year, month, and day and HH:MM:SS is the hour, minute, and second. The date and time are interpreted as local time. The cookie either expires at the given date and time or never. When a cookie expires, it is deleted from the list. The check for expired cookies happens after each conversion.

#### <Version>

Description
Set the content of the element to the integer version number of the cookie specification used.

#### <Path>

Description
Set the content of the element to the path to which the cookie applies. In addition to the port and domain restrictions, the path of the request URL must have this value as its prefix in order for the cookie to be sent. If no path is specified, the cookie applies to all paths.

#### <Port>

Description
Set the content of the element to a comma separated list of port numbers to which the cookie applies. In addition to the path and domain restrictions, the port of the request URL must be one of the listed ports. If no ports are specified, the cookie applies to all ports.

#### <Domain>

Description
Set the content of the element to the domain to which the cookie applies. If the value of this field begins with a period and has at least one other embedded period, then the domain of the request URL must have this value as its postfix. Otherwise, the domain of the request URL must must match this value exactly. In addition to the path and port restrictions, the domain of the request URL must match for the cookie to be sent. All cookies must specify a domain.

#### <Comments>

Description
Set the content of the element to an optional comment about the cookie.

#### <CommentURL>

Description
Set the content of the element to an optional URL that provides an optional comment about the cookie.

©1999-2017 DC & Co. All rights reserved.