API for mx backends. More...
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 |
Macros | |
| #define | MUTT_OPEN_NO_FLAGS 0 |
| No flags are set. | |
| #define | MUTT_NOSORT (1 << 0) |
| Do not sort the mailbox after opening it. | |
| #define | MUTT_APPEND (1 << 1) |
| Open mailbox for appending messages. | |
| #define | MUTT_READONLY (1 << 2) |
| Open in read-only mode. | |
| #define | MUTT_QUIET (1 << 3) |
| Do not print any messages. | |
| #define | MUTT_NEWFOLDER (1 << 4) |
| Create a new folder - same as MUTT_APPEND, but uses mutt_file_fopen() with mode "w" for mbox-style folders. | |
| #define | MUTT_PEEK (1 << 5) |
| Revert atime back after taking a look (if applicable) | |
| #define | MUTT_APPENDNEW (1 << 6) |
| Set in mx_open_mailbox_append if the mailbox doesn't exist. | |
| #define | MUTT_MAILBOX_CHECK_NO_FLAGS 0 |
| No flags are set. | |
| #define | MUTT_MAILBOX_CHECK_POSTPONED (1 << 0) |
| Make sure the number of postponed messages is updated. | |
| #define | MUTT_MAILBOX_CHECK_STATS (1 << 1) |
| Ignore mail_check_stats and calculate statistics (used by <check-stats>) | |
| #define | MUTT_MAILBOX_CHECK_IMMEDIATE (1 << 2) |
| Don't postpone the actual checking. | |
Typedefs | |
| typedef uint8_t | OpenMailboxFlags |
| Flags for mutt_open_mailbox(), e.g. MUTT_NOSORT. | |
| typedef uint8_t | CheckStatsFlags |
| Flags for mutt_mailbox_check. | |
Enumerations | |
| 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... | |
API for mx backends.
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.
| #define MUTT_NOSORT (1 << 0) |
| #define MUTT_APPEND (1 << 1) |
| #define MUTT_NEWFOLDER (1 << 4) |
Create a new folder - same as MUTT_APPEND, but uses mutt_file_fopen() with mode "w" for mbox-style folders.
This will truncate an existing file.
| #define MUTT_PEEK (1 << 5) |
| #define MUTT_APPENDNEW (1 << 6) |
| #define MUTT_MAILBOX_CHECK_POSTPONED (1 << 0) |
| #define MUTT_MAILBOX_CHECK_STATS (1 << 1) |
| #define MUTT_MAILBOX_CHECK_IMMEDIATE (1 << 2) |
| typedef uint8_t OpenMailboxFlags |
Flags for mutt_open_mailbox(), e.g. MUTT_NOSORT.
| typedef uint8_t CheckStatsFlags |
| 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) |
| 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. |
