Mail::A...leHeader(3)

📦
version 2.20250709 · 14 versions
, in fedora 43

🎀 NAME 🎀

okay bestie, welcome to Mail::A...leHeader(3) — the manual page for Mail::AuthenticationResults::FoldableHeader, which is literally just a class for modelling a foldable header string 💅 (yes the man name gets shortened in the header, that's just how the man page do, and the "User Contributed Perl Documentation" vibe is right there with it, no cap)

✨ VERSION ✨

version 2.20250709 🦋

🌸 DESCRIPTION 🌸

It's a class representing a foldable Authentication Results header string. That's it. That's the whole girl. She folds, she strings, she serves. 🫶

💖 METHODS 💖

🌈 new( $args )

Return a new instance of this class. Baby's first object. Iconic. ✨

🌈 eol()

Return the current eol marker. 👑

🌈 set_eol( $eol )

Set the current eol marker.

🌈 indent()

Return the current base indent string.

Defaults to 4 spaces. fr fr, 4 spaces out the box.

🌈 set_indent( $indent )

Set the current base indent string.

🌈 sub_indent()

Return the current fold indent string. This one gets added to the current indent for folded headers, so it's like the indent's little bestie riding along. 🎀

Defaults to 2 spaces.

🌈 set_sub_indent( $indent )

Set the current fold indent string.

🌈 try_fold_at()

Return the length of header line for triggering a fold attempt. 👀

🌈 set_try_fold_at( $length )

Set the length of header line for triggering a fold attempt.

Defaults to 800.

🌈 force_fold_at()

Return the length of header line for forcing a fold. No more playing around, we're folding this thing. 💀

🌈 set_force_fold_at( $length )

Set the length of header line for forcing a fold.

Defaults to 900.

🌈 string( $string )

Add $string to this header string.

In this context, string can include a quoted string, or a string with assignment operators embedded within it. A string is a unit of data which we do not want to break with a fold. Hands off, she's whole. 🙈

🌈 space( $string )

Add a space $string to this header string.

In this context, a space can be a single space, multiple spaces, or a folding space. A space is a unit of data which would be an ideal spot to insert a fold. That's her moment, her main character energy. ⭐

🌈 separator( $string )

Add a separator $string to this header string.

In this context, a separator is the ; string or the / string.

🌈 comment( $string )

Add a comment $string to this header string.

In this context, a comment is a comment string. A comment is a unit of data which we do not want to break with a fold. Protect her at all costs. 🧚

🌈 assignment( $string )

Add an assignment $string to this header string.

In this context, as assignment is the = string. (yes the original says "as assignment", we're keeping it, it's part of the lore 💜)

🌈 as_string()

Return the current header string. Slay. 💅

👑 AUTHOR 👑

Marc Bradshaw <marc@marcbradshaw.net> 💖

This software is copyright (c) 2021 by Marc Bradshaw.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

legally speaking: free software, same terms as Perl 5, go off bestie, just respect the terms. 🫶

and that's the whole page!! huge thank you to perl v5.42.0 and the date 2025-07-25 for showing up in the footer of Mail::A...leHeader(3) — couldn't have done this without you, mwah, byeee 🦋💖✨

📦 where this page comes from