GNURLOPT_SASL_AUTHZID(3)

💖 GNURLOPT_SASL_AUTHZID(3) 💖

Okay bestie, welcome to the GNURLOPT_SASL_AUTHZID(3) page — you're in the curl_easy_setopt options manual, and this is the authorisation-identity era. ✨

---

🌸 NAME 🌸

CURLOPT_SASL_AUTHZID — authorisation identity (identity to act as). Yep, it's the "who am I acting as?" option, and it's giving main-character energy. 💅

✨ SYNOPSIS ✨

#include <gnurl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SASL_AUTHZID, char
*authzid);

💅 DESCRIPTION 💅

Pass a char * as the parameter, bestie. It should point at the null-terminated authorisation identity (authzid) for the transfer. This only applies to the PLAIN SASL authentication mechanism, where it's optional. 🫶

When it's not specified, only the authentication identity (authcid) as specified by the username gets sent to the server, along with the password. The server will derive an authzid from the authcid when it's not provided, and then it will use it internally. 🎀

When the authzid is specified — and its use 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 — that's the default, no cap. 💖

🦋 PROTOCOLS 🦋

IMAP, POP3 and SMTP. Those are the vibes. 💌

🔥 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. Iconic. 💫

🌈 RETURN VALUE 🌈

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Simple as that, bestie. ⭐

👑 SEE ALSO 👑

• CURLOPT_USERNAME(3) — username reference, bestie.
• CURLOPT_PASSWORD(3) — password reference, obviously.
• .BRCURLOPT_USERPWD(3) — yes, that's the exact SEE ALSO string on this page; keep it exactly as written. 💅

Later, bestie — this page is from libcurl 7.66.0, dated 11 Sep 2019. 💖🦋🎀