.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "CiderWebmail::Message 3pm" .TH CiderWebmail::Message 3pm "2020-02-24" "perl v5.30.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SS "get_part_by_part_id({ part_id => '1.2.3' })" .IX Subsection "get_part_by_part_id({ part_id => '1.2.3' })" takes the part_id of a message part and returns the CiderWebmail::Part object of a bodypart of this message .ie n .SS "get_part_by_body_id({ body_id => $body_id })" .el .SS "get_part_by_body_id({ body_id => \f(CW$body_id\fP })" .IX Subsection "get_part_by_body_id({ body_id => $body_id })" takes the body_id (cid) of a message part and returns the CiderWebmail::Part object of a bodypart of this message .SS "get_header($header)" .IX Subsection "get_header($header)" Returns the first value found for the named header .SS "\fBflags()\fP" .IX Subsection "flags()" returns hashref of \s-1IMAP\s0 flags for this message .SS "\fBsubject()\fP" .IX Subsection "subject()" Shortcut getting the subject or 'No Subject' if none is available. .SS "\fBfrom()\fP" .IX Subsection "from()" Shortcut for getting the 'from' header .SS "\fBto()\fP" .IX Subsection "to()" Shortcut for getting the 'to' header .SS "\fBreply_to()\fP" .IX Subsection "reply_to()" Shortcut for getting the 'reply\-to' header .SS "\fBlist_post()\fP" .IX Subsection "list_post()" Shortcut for getting the 'list\-post' header .SS "\fBcc()\fP" .IX Subsection "cc()" Shortcut for getting the '\s-1CC\s0' header .SS "\fBmessage_id()\fP" .IX Subsection "message_id()" Shortcut for getting the 'Message\-ID' header .SS "\fBreferences()\fP" .IX Subsection "references()" Shortcut for getting the 'References' header .SS "\fBmark_read()\fP" .IX Subsection "mark_read()" Mark the message as read .SS "\fBmark_answered()\fP" .IX Subsection "mark_answered()" Mark the message as answered .SS "\fBdate()\fP" .IX Subsection "date()" Returns the 'date' header as datetime object .SS "\fBdelete()\fP" .IX Subsection "delete()" Deletes the message from the server. .SS "\fBtoggle_important()\fP" .IX Subsection "toggle_important()" Toggles the important/flagged \s-1IMAP\s0 flag of the message. .SS "move({target_folder => 'Folder 1'})" .IX Subsection "move({target_folder => 'Folder 1'})" Moves the message on the server to the named folder. .SS "as_string" .IX Subsection "as_string" Returns the full message source text.