CURLOPT_SERVICE_NAME

Section: curl_easy_setopt options (3)
Updated: November 04, 2020
Page Index

NAME

CURLOPT_SERVICE_NAME - authentication service name

SYNOPSIS

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVICE_NAME, char *name);

DESCRIPTION

Pass a char * as parameter to a string holding the name of the service for DIGEST-MD5, SPNEGO and Kerberos 5 authentication mechanisms. The default service names are "ftp", "HTTP", "imap", "pop" and "smtp". This option allows you to change them.

The application does not have to keep the string around after setting this option.

DEFAULT

See above

PROTOCOLS

HTTP, FTP, IMAP, POP and SMTP

EXAMPLE

CURL *curl = curl_easy_init();
if(curl) {
  CURLcode ret;
  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  curl_easy_setopt(curl, CURLOPT_SERVICE_NAME, "custom");
  ret = curl_easy_perform(curl);
}

AVAILABILITY

Added in 7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP.

RETURN VALUE

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.