maillist.h File Reference

Handle mailing lists. More...

#include <stddef.h>
#include <stdbool.h>

Include dependency graph for maillist.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
bool	check_for_mailing_list (struct AddressList *al, const char *pfx, char *buf, int buflen)
	Search list of addresses for a mailing list.
bool	check_for_mailing_list_addr (struct AddressList *al, char *buf, int buflen)
	Check an address list for a mailing list.
bool	first_mailing_list (char *buf, size_t buflen, struct AddressList *al)
	Get the first mailing list in the list of addresses.
bool	mutt_is_mail_list (const struct Address *addr)
	Is this the email address of a mailing list? - Implements addr_predicate_t -.
bool	mutt_is_subscribed_list (const struct Address *addr)
	Is this the email address of a user-subscribed mailing list? - Implements addr_predicate_t -.

Detailed Description

Handle mailing lists.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file maillist.h.

Function Documentation

check_for_mailing_list()

bool check_for_mailing_list	(	struct AddressList *	al,
		const char *	pfx,
		char *	buf,
		int	buflen
	)

Search list of addresses for a mailing list.

Parameters

al	AddressList to search
pfx	Prefix string
buf	Buffer to store results
buflen	Buffer length

Return values

1	Mailing list found
0	No list found

Search for a mailing list in the list of addresses pointed to by addr. If one is found, print pfx and the name of the list into buf.

Definition at line 79 of file maillist.c.

{
  struct Address *a = NULL;
  TAILQ_FOREACH(a, al, entries)
  {
    if (mutt_is_subscribed_list(a))
    {
      if (pfx && buf && buflen)
        snprintf(buf, buflen, "%s%s", pfx, mutt_get_name(a));
      return true;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

check_for_mailing_list_addr()

bool check_for_mailing_list_addr	(	struct AddressList *	al,
		char *	buf,
		int	buflen
	)

Check an address list for a mailing list.

Parameters

al	AddressList
buf	Buffer for the result
buflen	Length of buffer

Return values

true	Mailing list found

If one is found, print the address of the list into buf.

Definition at line 103 of file maillist.c.

{
  struct Address *a = NULL;
  TAILQ_FOREACH(a, al, entries)
  {
    if (mutt_is_subscribed_list(a))
    {
      if (buf && buflen)
        snprintf(buf, buflen, "%s", buf_string(a->mailbox));
      return true;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

first_mailing_list()

bool first_mailing_list	(	char *	buf,
		size_t	buflen,
		struct AddressList *	al
	)

Get the first mailing list in the list of addresses.

Parameters

buf	Buffer for the result
buflen	Length of buffer
al	AddressList

Return values

true	A mailing list was found

Definition at line 125 of file maillist.c.

{
  struct Address *a = NULL;
  TAILQ_FOREACH(a, al, entries)
  {
    if (mutt_is_subscribed_list(a))
    {
      mutt_save_path(buf, buflen, a);
      return true;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function: