mxapi.h File Reference

API for mx backends. More...

#include <stdbool.h>
#include <stdint.h>
#include "mailbox.h"

Include dependency graph for mxapi.h:

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

Go to the source code of this file.

Data Structures
struct	MxOps

Typedefs
typedef uint8_t	OpenMailboxFlags
typedef uint8_t	CheckStatsFlags

Enumerations
enum	OpenMailboxFlag {   MUTT_OPEN_NONE = 0 , MUTT_NOSORT = 1U << 0 , MUTT_APPEND = 1U << 1 , MUTT_READONLY = 1U << 2 ,   MUTT_QUIET = 1U << 3 , MUTT_PEEK = 1U << 5 , MUTT_APPENDNEW = 1U << 6 }
	Flags for mutt_open_mailbox(), e.g. More...
enum	CheckStatsFlag { MUTT_MAILBOX_CHECK_NONE = 0 , MUTT_MAILBOX_CHECK_POSTPONED = 1U << 0 , MUTT_MAILBOX_CHECK_STATS = 1U << 1 , MUTT_MAILBOX_CHECK_IMMEDIATE = 1U << 2 }
	Flags for mutt_mailbox_check. More...
enum	MxStatus {   MX_STATUS_ERROR = -1 , MX_STATUS_OK , MX_STATUS_NEW_MAIL , MX_STATUS_LOCKED ,   MX_STATUS_REOPENED , MX_STATUS_FLAGS }
	Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close() More...
enum	MxOpenReturns { MX_OPEN_OK , MX_OPEN_ERROR , MX_OPEN_ABORT }
	Return values for mbox_open() More...

Detailed Description

API for mx backends.

Authors

• Pietro Cerutti
• 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 mxapi.h.

Typedef Documentation

OpenMailboxFlags

typedef uint8_t OpenMailboxFlags

Definition at line 51 of file mxapi.h.

CheckStatsFlags

typedef uint8_t CheckStatsFlags

Definition at line 63 of file mxapi.h.

Enumeration Type Documentation

OpenMailboxFlag

enum OpenMailboxFlag

Flags for mutt_open_mailbox(), e.g.

MUTT_NOSORT

Enumerator
MUTT_OPEN_NONE	No flags are set.
MUTT_NOSORT	Do not sort the mailbox after opening it.
MUTT_APPEND	Open mailbox for appending messages.
MUTT_READONLY	Open in read-only mode.
MUTT_QUIET	Do not print any messages.
MUTT_PEEK	Revert atime back after taking a look (if applicable)
MUTT_APPENDNEW	Set in mx_open_mailbox_append if the mailbox doesn't exist. Used by maildir/mh to create the mailbox.

Definition at line 40 of file mxapi.h.

{
  MUTT_OPEN_NONE =       0,  
  MUTT_NOSORT    = 1U << 0,  
  MUTT_APPEND    = 1U << 1,  
  MUTT_READONLY  = 1U << 2,  
  MUTT_QUIET     = 1U << 3,  
  MUTT_PEEK      = 1U << 5,  
  MUTT_APPENDNEW = 1U << 6,  
};

CheckStatsFlag

enum CheckStatsFlag

Flags for mutt_mailbox_check.

Enumerator
MUTT_MAILBOX_CHECK_NONE	No flags are set.
MUTT_MAILBOX_CHECK_POSTPONED	Make sure the number of postponed messages is updated.
MUTT_MAILBOX_CHECK_STATS	Ignore mail_check_stats and calculate statistics (used by <check-stats>)
MUTT_MAILBOX_CHECK_IMMEDIATE	Don't postpone the actual checking.

Definition at line 56 of file mxapi.h.

{
  MUTT_MAILBOX_CHECK_NONE      =       0,  
  MUTT_MAILBOX_CHECK_POSTPONED = 1U << 0,  
  MUTT_MAILBOX_CHECK_STATS     = 1U << 1,  
  MUTT_MAILBOX_CHECK_IMMEDIATE = 1U << 2,  
};

MxStatus

enum MxStatus

Return values from mbox_check(), mbox_check_stats(), mbox_sync(), and mbox_close()

Enumerator
MX_STATUS_ERROR	An error occurred.
MX_STATUS_OK	No changes.
MX_STATUS_NEW_MAIL	New mail received in Mailbox.
MX_STATUS_LOCKED	Couldn't lock the Mailbox.
MX_STATUS_REOPENED	Mailbox was reopened.
MX_STATUS_FLAGS	Nondestructive flags change (IMAP)

Definition at line 69 of file mxapi.h.

{
  MX_STATUS_ERROR = -1, 
  MX_STATUS_OK,         
  MX_STATUS_NEW_MAIL,   
  MX_STATUS_LOCKED,     
  MX_STATUS_REOPENED,   
  MX_STATUS_FLAGS,      
};

MxOpenReturns

enum MxOpenReturns

Return values for mbox_open()

Enumerator
MX_OPEN_OK	Open succeeded.
MX_OPEN_ERROR	Open failed with an error.
MX_OPEN_ABORT	Open was aborted.

Definition at line 82 of file mxapi.h.

{
  MX_OPEN_OK,           
  MX_OPEN_ERROR,        
  MX_OPEN_ABORT,        
};