Skip to content

Commit

Permalink
Document that mailboxes are created if they do not exist
Browse files Browse the repository at this point in the history
  • Loading branch information
jwodder committed Mar 8, 2021
1 parent be81993 commit 4700452
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ The ``mbox`` method appends e-mails to an mbox file on the local machine.
Configuration fields:

``path`` : filepath (required)
The location of the mbox file
The location of the mbox file. If the file does not exist, it will be
created when the sender object is entered.

Example ``mbox`` configuration:

Expand All @@ -161,8 +162,9 @@ machine.

Configuration fields:

``path`` : filepath (required)
The location of the Maildir mailbox
``path`` : directory path (required)
The location of the Maildir mailbox. If the directory does not exist, it
will be created when the sender object is entered.

``folder`` : string (optional)
A folder within the Maildir mailbox in which to place e-mails
Expand All @@ -175,8 +177,9 @@ The ``mh`` method adds e-mails to an MH mailbox directory on the local machine.

Configuration fields:

``path`` : filepath (required)
The location of the MH mailbox
``path`` : directory path (required)
The location of the MH mailbox. If the directory does not exist, it will
be created when the sender object is entered.

``folder`` : string or list of strings (optional)
A folder within the Maildir mailbox in which to place e-mails; can be
Expand All @@ -202,7 +205,8 @@ The ``mmdf`` method adds e-mails to an MMDF mailbox file on the local machine.
Configuration fields:

``path`` : filepath (required)
The location of the MMDF mailbox
The location of the MMDF mailbox. If the file does not exist, it will be
created when the sender object is entered.


``babyl``
Expand All @@ -213,7 +217,8 @@ The ``babyl`` method adds e-mails to a Babyl mailbox file on the local machine.
Configuration fields:

``path`` : filepath (required)
The location of the Babyl mailbox
The location of the Babyl mailbox. If the file does not exist, it will be
created when the sender object is entered.


``null``
Expand Down

0 comments on commit 4700452

Please sign in to comment.