Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CURLOPT_SASL_AUTHZID(3)	   curl_easy_setopt options    CURLOPT_SASL_AUTHZID(3)

NAME
       CURLOPT_SASL_AUTHZID - authorisation identity (identity to act as)

SYNOPSIS
       #include	<curl/curl.h>

       CURLcode	curl_easy_setopt(CURL *handle, CURLOPT_SASL_AUTHZID, char *au-
       thzid);

DESCRIPTION
       Pass a char * as	parameter, which should	be pointing to the null-termi-
       nated  authorisation identity (authzid) for the transfer. Only applica-
       ble to the PLAIN	SASL authentication mechanism where it is optional.

       When not	specified only the authentication identity (authcid) as	speci-
       fied  by	 the username will be sent to the server, along	with the pass-
       word. The server	will derive a authzid from the authcid when  not  pro-
       vided, which it will then uses internally.

       When the	authzid	is specified, the use of which is server dependent, it
       can be used to access another user's inbox,  that  the  user  has  been
       granted access to, or a shared mailbox for example.

DEFAULT
       blank

PROTOCOLS
       IMAP, POP3 and SMTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl)	{
	 curl_easy_setopt(curl,	CURLOPT_URL, "imap://example.com/");
	 curl_easy_setopt(curl,	CURLOPT_USERNAME, "Kurt");
	 curl_easy_setopt(curl,	CURLOPT_PASSWORD, "xipj3plmq");
	 curl_easy_setopt(curl,	CURLOPT_SASL_AUTHZID, "Ursel");
	 ret = curl_easy_perform(curl);
	 curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in	7.66.0

RETURN VALUE
       Returns	CURLE_OK  if the option	is supported, and CURLE_UNKNOWN_OPTION
       if not.

SEE ALSO
       CURLOPT_USERNAME(3), CURLOPT_PASSWORD(3), .BRCURLOPT_USERPWD(3)

libcurl	7.72.0			 June 25, 2020	       CURLOPT_SASL_AUTHZID(3)

NAME | SYNOPSIS | DESCRIPTION | DEFAULT | PROTOCOLS | EXAMPLE | AVAILABILITY | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CURLOPT_SASL_AUTHZID&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help