Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Guides   Examples
New in version: 7.5   8.0   8.1   8.2   8.3   8.4   8.5   9.0   9.1   9.2    Statistic  


Sets the cookie storage file.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
CURL 2.5 Yes Yes Yes Yes Yes
MBS( "CURL.SetOptionCookieJar"; curl; Value { ; Encoding } )   More


Parameter Description Example value
curl The CURL session handle. $curl
Value The file path. "/tmp/cookies.txt"
Encoding Optional
The text encoding for text parameter.
Default is UTF-8.
Possible encoding names: ANSI, Arabic-Mac, Arabic-Win, Baltic-Win, CentralEurope-Mac, ChineseSimp-Mac, ChineseSimp-Win, ChineseTrad-Mac, ChineseTrad-Win, Cyrillic-Mac, Cyrillic-Win, EasternEurope-Win, Greek-Mac, Greek-Win, Hebrew-Mac, Hebrew-Win, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-15, Korean-Johab, Korean-Mac, Korean-Win, Latin1, Mac, Native, ShiftJIS-Mac, ShiftJIS-Win, Turkish-Mac, Turkish-Win, UTF-8, DOS or Windows. Pass native to use the native encoding of the current platform.


Returns "OK" on success.


Sets the cookie storage file.
Pass a file name as string. This will make libcurl write all internally known cookies to the specified file when CURL.Cleanup is called. If no cookies are known, no file will be created. Specify "-" to instead have the cookies written to stdout. Using this option also enables cookies for this session, so if you for example follow a location it will make matching cookies get sent accordingly.

If the cookie jar file can't be created or written to (when the CURL.Cleanup is called), libcurl will not and cannot report an error for this. Using CURL.SetOptionVerbose or using Debug output will get a warning to display, but that is the only visible feedback you get about this possibly lethal situation.

Starting with version 8.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.

See also COOKIEJAR option in CURL manual.


Activate cookie engine without cookie file:

MBS( "CURL.SetOptionCookieFile"; $curl; "")

See also

Blog Entries

Created 18th August 2014, last changed 27th February 2019

CURL.SetOptionCookieFile   -   CURL.SetOptionCookieList

Feedback: Report problem or ask question.

MBS Xojo Plugins