symmetry-imap 0.3.0
IMAP client library
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
IMAP for D / SIL and JMAP for SIL
Status - usable alpha
I am starting to use this daily, but there are probably many bugs - please file issues. PRs welcomed.
IMAP Features that should work (ones without a check may work but be more awkward to use)
- [X] session capabilities
- [X] copy message
- [X] create mailbox
- [X] createQuery (higher level API for IMAP search)
- [X] delete_ mailbox
- [X] esearch
- [X] examine
- [X] expunge
- [X] fetchFast
- [X] fetchFields
- [ ] fetchFlags
- [X] fetchHeader
- [ ] fetchPart
- [X] fetchRFC822 - whole email fetch and parse
- [ ] fetchSize
- [ ] fetchStructure
- [ ] fetchText
- [X] idle
- [X] list
- [X] login
- [X] logout
- [X] lsub
- [X] move
- [X] moveUIDs
- [X] multiMove
- [X] multiSearch - search multiple mailboxes (sadly not widely supported on IMAP servers)
- [X] noop
- [X] raw IMAP command
- [X] search
- [X] searchQuery
- [X] select
- [X] status
- [X] store
- [X] subscribe
- [X] unsubscribe
JMAP Features that should work (ones without a check may work but have not yet been tested)
- [X] Email
- [ ] Contacts
- [ ] Calendar
Heavily inspired by imapfilter.
Limitations
- currently IMAP literals are only parsed for returns of type responseBody
- only fetchRFC822 works for parsing results (works if you want whole email including attachments)
- more abstraction and better design needed for parsing
- synchronous and single threaded: use processes to start multiple connections for performance
- JMAP depends on internal Symmetry Variable type and will require changes to work without it
Features to add
- [ ] more IMAP extensions
- [ ] more JMAP capabilities
Example use
import imap;
int main(string[] args) {
import std.conv : to;
import std.stdio : writeln, stderr;
import std.range : back;
import std.process : environment;
import std.string : join;
import std.datetime : Date;
if (args.length != 4) {
stderr.writeln("imap-example <server> <port> <mailbox>");
return -1;
}
// user is set in IMAP_USER environmental variable
// password is set in IMAP_PASS environmental variable
auto user = environment.get("IMAP_USER", "");
auto pass = environment.get("IMAP_PASS", "");
if (user.length == 0 || pass.length == 0) {
stderr.writeln("IMAP_USER and IMAP_PASS environment variables must be set.");
return -1;
}
auto server = args[1];
auto port = args[2];
auto mailbox = args[3];
auto login = ImapLogin(user, pass);
auto imapServer = ImapServer(server, port);
auto session = new Session(imapServer, login);
session.sslProtocol = ProtocolSSL.ssl3;
session.options.debugMode = true;
session = session.openConnection;
session = session.login();
// Select Inbox
auto INBOX = new Mailbox(session, mailbox);
auto result = session.select(INBOX);
// search all messages since 29 Jan 2019 and get UIDs using raw query interface
auto searchResult = session.search("SINCE 29-Jan-2019");
writeln("--- Raw 'SINCE 29-Jan-2019' search results:");
writeln(searchResult.value);
writeln("--- Search result IDs: ", searchResult.ids);
// search all messages from GitHub since 29 Jan 2019 and get UIDs using high level query interface
auto query = new SearchQuery()
.and(DateTerm(DateTerm.When.Since, Date(2019, 1, 29)))
.and(FieldTerm(FieldTerm.Field.From, "GitHub"));
searchResult = session.search(query.to!string);
writeln("--- Structured 'since:Date(2019,1,29),fromContains:\"GitHub\"' search results:");
writeln(searchResult.value);
// fetch one of the messages from above
if (searchResult.ids.length > 0) {
auto exampleId = searchResult.ids.back.to!string;
auto messageResult = session.fetchText(exampleId);
writeln("--- Message text for ID ", exampleId, ":");
writeln(messageResult.value);
// just fetch the fields we care about
auto relevantFields = ["FROM", "TO"];
auto fieldsResult = session.fetchFields(exampleId, relevantFields.join(" "));
writeln("--- Message 'from' and 'to' fields for ID ", exampleId, ":");
writeln(fieldsResult.value);
}
return 0;
}
- Registered by Laeeth Isharc
- 0.3.0 released 10 months ago
- symmetryinvestments/imap-d
- MIT
- Dependencies:
- arsd-official:email, openssl, requests, mir-ion
- Versions:
-
0.3.0 2023-Nov-30 0.2.0 2022-Oct-19 0.1.20 2022-Sep-08 0.1.19 2022-Jun-07 0.1.18 2022-Jan-11 - Download Stats:
-
-
0 downloads today
-
1 downloads this week
-
2 downloads this month
-
87343 downloads total
-
- Score:
- 0.6
- Short URL:
- symmetry-imap.dub.pm