Mail::AuthenticationResults::FoldableHeader(3)

NAME
Mail::AuthenticationResults::FoldableHeader - Class for modelling a foldable header string

VERSION
version 1.20200108

DESCRIPTION
Class representing a foldable Authentication Results header string

METHODS

  new( $args )
Return a new instance of this class

  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.

  set_indent( $indent )
Set the current base indent string.

  sub_indent()
Return the current fold indent string. This is added to the current indent for folded headers.

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.

  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.

  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.

  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.

  assignment( $string )
Add an assignment $string to this header string

In this context, as assignment is the = string.

  as_string()
Return the current header string

AUTHOR
Marc Bradshaw <marc@marcbradshaw.net>

COPYRIGHT AND LICENSE
This software is copyright (c) 2018 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.