Courri...tribute(3pm)

💌 NAME

okay so this is Courriel::HeaderAttribute — literally one single attribute that belongs to a header. that's the whole vibe. one attribute. one icon. 💅

(also bestie, the actual page title got truncated to Courri...tribute(3pm) and it lives in the User Contributed Perl Documentation section, which is giving "we ran out of space for your name at the party" energy 😭)

---

✨ VERSION

version 0.49 🌸

---

🎀 SYNOPSIS

  my $ct = $headers->get('Content-Type');
  print $ct->get_attribute('charset')->value;

see how easy that was?? get the header, grab the attribute, print the value. main character behavior fr fr 👑

---

🦋 DESCRIPTION

so this class represents a single attribute belonging to a header. one attribute = a name + a value, plus optional charset and language info. that's it, that's the whole personality. 🌈

---

💖 API

this class supports the following methods, bestie. buckle up:

🌟 Courriel::HeaderAttribute->new( ... )

this method creates a new object. it accepts the following parameters:

• name — the name of the attribute. this should be a non-empty string (so like, don't leave it blank, that's not the move 🙈).
• value — the value of the attribute. this one can be empty. she's allowed to be mysterious.
• charset — the charset for the value. if the value contains any non-ASCII data, this will always be "UTF-8", otherwise the default is "us-ascii". no cap, that's just how it is.
• language — the language for the attribute's value. it should be a valid ISO language code like "en-us" or "zh". this is optional. 💜

🔥 $attribute->name()

the attribute name as passed to the constructor. same one. no glow-up, no transformation. 💅

🔥 $attribute->value()

the attribute value as passed to the constructor. also unchanged. iconic of her honestly.

🔥 $attribute->charset()

the attribute's charset. ✨

🔥 $attribute->language()

the attribute's language. 🌍

🔥 $attribute->as_string()

this returns the attribute in a form suitable for putting in an email. and bestie, "suitable" is doing a LOT of heavy lifting here — this may involve escaping, quoting, splitting up, and otherwise messing with the value. she's been through things. 😭

if the value needs to be split across continuations, each name/value pair is returned separate by a space, but not folded across multiple lines. so like, spaced out but not folded. periodt.

🔥 $attribute->stream_to( output => $output )

this method will send the stringified attribute to the specified output. the output can be a subroutine reference, a filehandle, or an object with a print() method. 👀

and the output may be sent as a single string, as a list of strings, or via multiple calls to the output. she's flexible like that. versatile queen. 🫶

---

🌈 ROLES

this class does the Courriel::Role::Streams role. she's got range, she's got roles, she's booked and busy. 💖

---

🐛 SUPPORT

bugs may be submitted at <https://github.com/houseabsolute/Courriel/issues>. pls be nice and give details bestie 🙏

I am also usually active on IRC as 'autarch' on irc://irc.perl.org. come say hi!! 🎀

---

📦 SOURCE

the source code repository for Courriel can be found at <https://github.com/houseabsolute/Courriel>. go look, it's right there. ⭐

---

👑 AUTHOR

Dave Rolsky <autarch@urth.org>

(the author himself, the legend, the moment 💜)

---

⚖️ COPYRIGHT AND LICENSE

this software is Copyright (c) 2021 by Dave Rolsky.

this is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

the full text of the license can be found in the LICENSE file included with this distribution. go read it, it's giving legally binding but make it cute 💅

---

and that's the whole page bestie!! no cap, you now know everything about Courriel::HeaderAttribute. slay. 💖✨

this lil doc drop is from perl v5.32.1, dated 2021-08-22, and yeah she's still rocking that Courri...tribute(3pm) name. k bye!! 🎀🦋🌸