X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.h;h=165fe85224e0c7b9dd48e176541fda7f74a4cbf7;hp=f4e59ab2ca47f47df30c81fba7323f3605b0033f;hb=a1135f0b7e67db7056a4ef02d61b8ad0ec46e88b;hpb=fbf55bfe2fdcdf3773ba37a9921875530e94c7b3 diff --git a/notmuch.h b/notmuch.h index f4e59ab2..165fe852 100644 --- a/notmuch.h +++ b/notmuch.h @@ -246,11 +246,14 @@ notmuch_database_get_timestamp (notmuch_database_t *database, /* Add a new message to the given notmuch database. * * Here,'filename' should be a path relative to the the path of - * 'database' (see notmuch_database_get_path). The file should be a - * single mail message (not a multi-message mbox) that is expected to - * remain at its current location, (since the notmuch database will - * reference the filename, and will not copy the entire contents of - * the file. + * 'database' (see notmuch_database_get_path), or else should be an + * absolute filename with initial components that match the path of + * 'database'. + * + * The file should be a single mail message (not a multi-message mbox) + * that is expected to remain at its current location, (since the + * notmuch database will reference the filename, and will not copy the + * entire contents of the file. * * If 'message' is not NULL, then, on successful return '*message' * will be initialized to a message object that can be used for things @@ -605,8 +608,9 @@ notmuch_message_get_thread_id (notmuch_message_t *message); /* Get the filename for the email corresponding to 'message'. * - * The returned filename is relative to the base of the database from - * which 'message' was obtained. See notmuch_database_get_path() . + * The returned filename is an absolute filename, (the initial + * component will match notmuch_database_get_path() ). + * * The returned string belongs to the message so should not be * modified or freed by the caller (nor should it be referenced after * the message is destroyed). */