++ed by:

2 PAUSE users
2 non-PAUSE users.



App::ListOrgAnniversaries - List all anniversaries in Org files


This document describes version 0.32 of App::ListOrgAnniversaries (from Perl distribution App-OrgUtils), released on 2015-08-17.


 # See list-org-anniversaries script


list_org_anniversaries(%args) -> [status, msg, result, meta]

{en_US List all anniversaries in Org files}.

{en_US This function expects contacts in the following format:

 * First last                              :office:friend:
   :BIRTHDAY:     1900-06-07
   :EMAIL:        foo@example.com
   :OTHERFIELD:   ...


 * Some name                               :office:
   - birthday   :: [1900-06-07 ]
   - email      :: foo@example.com
   - otherfield :: ...

Using PROPERTIES, dates currently must be specified in "YYYY-MM-DD" format. Other format will be supported in the future. Using description list, dates can be specified using normal Org timestamps (repeaters and warning periods will be ignored).

By convention, if year is '1900' it is assumed to mean year is not specified.

By default, all contacts' anniversaries will be listed. You can filter contacts using tags ('has_tags' and 'lacks_tags' options), or by 'due_in' and 'max_overdue' options (due_in=14 and max_overdue=2 is what I commonly use in my startup script). }

Arguments ('*' denotes required arguments):

  • cache_dir => str

    {en_US Cache Org parse result}.

    {en_US Since Org::Parser can spend some time to parse largish Org files, this is an option to store the parse result. Caching is turned on if this argument is set. }

  • due_in => int

    {en_US Only show anniversaries that are due in this number of days}.

  • field_pattern => str (default: "(?:birthday|anniversary)")

    {en_US Field regex that specifies anniversaries}.

  • files* => array[str]

  • has_tags => array[str]

    {en_US Filter headlines that have the specified tags}.

  • lacks_tags => array[str]

    {en_US Filter headlines that don't have the specified tags}.

  • max_overdue => int

    {en_US Don't show dates that are overdue more than this number of days}.

  • sort => str|code (default: "due_date")

    {en_US Specify sorting}.

    {en_US If string, must be one of 'date', '-date' (descending).

    If code, sorting code will get [REC, DUE_DATE] as the items to compare, where REC is the final record that will be returned as final result (can be a string or a hash, if 'detail' is enabled), and DUE_DATE is the DateTime object. }

  • time_zone => str

    {en_US Will be passed to parser's options}.

    {en_US If not set, TZ environment variable will be picked as default. }

  • today => obj

    {en_US Assume today's date}.

    {en_US You can provide Unix timestamp or DateTime object. If you provide a DateTime object, remember to set the correct time zone. }

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)


Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.


Source repository is at https://github.com/perlancar/perl-App-OrgUtils.


Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-OrgUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.


perlancar <perlancar@cpan.org>


This software is copyright (c) 2015 by perlancar@cpan.org.

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