client.Calendar
Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.
Методы
Calendar events found in mail or put on the calendar here, expanded into occurrences, with invitations, changes, cancellations and answers sent by email.
Calendar.ListEventsAsync
List one page of event occurrences inside a time window
Task<Page> ListEventsAsync( DateTimeOffset from, DateTimeOffset to, string? timezone = null, int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Expands every event in the workspace into its occurrences between from and to and returns one page of them, sorted by start time and then by event id. A recurring series gives one row per instance in the window, with its excluded dates left out, and every row points back to its event through eventId. The window is required because a repeating series has no end to list up to. Follow nextCursor while hasMore is true, with the same from, to and timezone:, to read every occurrence, or let ListAllEventsAsync and IterateEventsAsync do that walk.
to must be after from and at most 366 days later. A missing from or to is a 422 invalid_parameter, while a value that does not parse, a reversed or overlong window, or an unknown zone is a 400 invalid_parameter naming the field. Both bounds take a DateTimeOffset or an ISO 8601 string, and the SDK sends a DateTimeOffset as an ISO 8601 instant in UTC.
timezone is an IANA zone and defaults to UTC on the server. It is used to expand any event stored without a zone of its own, which is what decides the day an all day event lands on.
Параметры
fromDateTimeOffsetОбязательноStart of the window.
toDateTimeOffsetОбязательноEnd of the window, after
fromand at most 366 days later.timezonestring?IANA zone such as
Europe/London, at most 64 characters. Defaults toUTC.limitint?Occurrences per page, a whole number from 1 to 100. The server defaults to 25.
cursorstring?The
nextCursorof the previous page, sent with the same window. It is opaque, so never build one yourself.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A Page of occurrence objects with items, hasMore and nextCursor. Each item has eventId, uid, start, end, allDay, summary, location, status, transparency, isOrganizer, organizerEmail, recurring, myPartstat and attendeeCount.
Пример
var today = new DateTimeOffset(DateTime.UtcNow.Date, TimeSpan.Zero); var page = await client.Calendar.ListEventsAsync(today, today.AddDays(7), timezone: "Europe/London", limit: 50); foreach (var occurrence in page){ Console.WriteLine($"{occurrence["start"]} {occurrence["summary"]} {occurrence["myPartstat"]?.ToString() ?? "not invited"}");} if (page.HasMore){ Console.WriteLine($"More from cursor {page.NextCursor}");}Примечания
myPartstatis the response recorded for any address this workspace holds on its own domains, or for the addresses a narrowed key covers, and null when none of them is an attendee. A workspace with no address on its own domains matches no attendee, so every row reads null.A narrowed key only sees occurrences whose organiser is one of the addresses it covers or where one of them is an attendee.
Cancelled events are not filtered out. Check
statusforCANCELLED.Nothing in the window is dropped. A series repeats at most once a day, so one series gives at most one row per day of the window, and every one of them is reachable through the pages.
The cursor holds the start time and event id of the last row, so an event deleted or moved between pages never breaks the walk. A cursor this list did not hand out is a 400
invalid_cursor.
Также доступно в
Calendar.ListAllEventsAsync
Collect every occurrence inside a time window into one object
Task<IReadOnlyList<JsonObject>> ListAllEventsAsync( DateTimeOffset from, DateTimeOffset to, string? timezone = null, int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Walks every page of ListEventsAsync for one window and returns all of its occurrences, sorted by start time and then by event id. It follows nextCursor until hasMore is false, sending the same from, to and timezone: with each request.
A window of up to 366 days of a busy calendar can hold thousands of occurrences, so prefer IterateEventsAsync when you can stop early.
Параметры
fromDateTimeOffsetОбязательноStart of the window.
toDateTimeOffsetОбязательноEnd of the window, after
fromand at most 366 days later.timezonestring?IANA zone such as
Europe/London, at most 64 characters. Defaults toUTC.limitint?Page size for each request, 1 to 100. The server defaults to 25.
cursorstring?Starts the walk from this cursor instead of the start of the window.
apiKeystring?Overrides the client API key for every page of this walk.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A list of occurrence objects holding every occurrence in the window, earliest first.
Пример
using OpenEmail.Constants; var occurrences = await client.Calendar.ListAllEventsAsync(DateTimeOffset.Parse("2026-10-01T00:00:00Z"), DateTimeOffset.Parse("2026-11-01T00:00:00Z"), limit: 100); foreach (var occurrence in occurrences){ if ((string?)occurrence["transparency"] == CalendarTransparencies.Opaque) { Console.WriteLine($"Busy {occurrence["start"]} to {occurrence["end"]}"); }}Примечания
If any page fails the call throws and the occurrences already fetched are discarded.
Также доступно в
Calendar.IterateEventsAsync
Stream the occurrences inside a time window one at a time
IAsyncEnumerable<JsonObject> IterateEventsAsync( DateTimeOffset from, DateTimeOffset to, string? timezone = null, int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Returns an IAsyncEnumerable<JsonObject> over the occurrences in one window that yields them individually, earliest first, and fetches the next page only when the current one is drained. Nothing is requested until you consume it, and breaking out of the loop stops further requests, which makes it the way to find the next free slot or the next meeting without reading the whole window.
The walk ends when hasMore is false, when a page carries no nextCursor, or when the server repeats a cursor.
Параметры
fromDateTimeOffsetОбязательноStart of the window.
toDateTimeOffsetОбязательноEnd of the window, after
fromand at most 366 days later.timezonestring?IANA zone such as
Europe/London, at most 64 characters. Defaults toUTC.limitint?Page size per request, 1 to 100. The server defaults to 25.
cursorstring?Starts the walk from this cursor instead of the start of the window.
apiKeystring?Overrides the client API key for every page of this walk.
cancellationTokenCancellationTokenCancels the request.
Возвращает
An IAsyncEnumerable<JsonObject> that yields one occurrence per step.
Пример
var from = DateTimeOffset.UtcNow;var to = DateTimeOffset.UtcNow.AddDays(30); await foreach (var occurrence in client.Calendar.IterateEventsAsync(from, to)){ if (occurrence["myPartstat"] is not null) { Console.WriteLine($"Next meeting: {occurrence["start"]} {occurrence["summary"]}"); break; }}Примечания
A page request that fails throws out of the
foreachloop, after every occurrence of the pages before it has been yielded.
Также доступно в
Calendar.GetEventAsync
Read an event with its attendees
Task<JsonObject> GetEventAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Returns a stored event with its attendees and their responses. What the server understood from the iCalendar data is structured here: recurrence holds the RRULE text, exdates the excluded instances, organizer the organiser and alarms the reminders, each an object with minutesBefore and action. The raw iCalendar source is not included, and GetEventIcsAsync serves the event as a document.
id is the event id, the eventId on an occurrence, and not the iCalendar uid. A recurring series is one event however many occurrences it has, so start and end describe its first instance. messageId and threadId link the event to mail in the mailbox when there is any.
Attendees come back in the order they were added, each with partstat, role, rsvp, cutype and respondedAt. A narrowed key gets a 404 unless one of the addresses it covers organises the event or is on the attendee list, and a key that holds a whole domain covers every address on it.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject with id, uid, sequence, summary, description, location, url, start, end, allDay, timezone, recurrence, exdates, status, transparency, visibility, organizer, isOrganizer, source, messageId, threadId, alarms, attendees, createdAt and updatedAt.
Пример
var entry = await client.Calendar.GetEventAsync("cal_3f9a1c7e5b2d48a06c1e9f4b"); Console.WriteLine($"{entry["summary"]}, {entry["recurrence"]?.ToString() ?? "one off"}"); foreach (var attendee in entry["attendees"]?.AsArray() ?? []){ Console.WriteLine($"{attendee?["email"]}: {attendee?["partstat"]}");}Примечания
status,transparencyandvisibilitycarry iCalendar values, and default toCONFIRMED,OPAQUEandPUBLIC.An attendee's
partstatdefaults toNEEDS-ACTIONandroletoREQ-PARTICIPANTuntil a response is recorded.
Также доступно в
Calendar.GetEventIcsAsync
Download an event as an iCalendar document
Task<string> GetEventIcsAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Returns the event serialised as an .ics document, as a raw string rather than parsed JSON. The server sends it as text/calendar; charset=utf-8 with a download filename built from the event's uid, and the SDK requests that type and returns the body untouched.
The document declares METHOD:PUBLISH, and the content type carries no method parameter. That is deliberate: a REQUEST document makes a calendar client offer accept and decline and reply to the organiser, and this endpoint has no authority to invite anyone. Import it to show what the event currently is, not to send an invitation.
It holds one VEVENT with the attendees and their participation status, the recurrence rule, excluded dates and alarms. Lines end in CRLF and long lines are folded. DTSTAMP is the time of the request, so two downloads of an unchanged event differ on that line.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A string, the iCalendar text from BEGIN:VCALENDAR to END:VCALENDAR.
Пример
var ics = (await client.Calendar.GetEventIcsAsync("cal_8d3f0a2b9c4e41f7a6b5c2d1")); Console.WriteLine(ics);Примечания
Errors still come back as JSON and throw
OpenEmailApiException, so a failure never comes back as a string.Timed events are written in the zone they were created in, as local times with a
TZIDand aVTIMEZONEthat carries the rules of that zone, and all day events asDATEvalues.A narrowed key gets a 404 on the same terms as
GetEventAsync.
Также доступно в
Calendar.CreateEventAsync
Put an event on the calendar
Task<JsonObject> CreateEventAsync( IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Creates an event, as New event on the Calendar page of the app does. start and end take a DateTimeOffset or ISO 8601 with a zone, and the SDK sends a DateTimeOffset as a UTC instant. timezone is the IANA zone the event belongs to, which decides what an all-day event means.
With attendees, an invitation goes to each of them by email from from, which has to be an address the key may send as, so the call also needs emails:send. Send ["sendInvites"] = false to keep it to your own calendar.
Параметры
summarystringОбязательноThe title, 1 to 255 characters.
startDateTimeOffset or stringОбязательноWhen it starts, a
DateTimeOffsetor ISO 8601 with a zone. ADateTimeOffsetis sent as an instant in UTC.endDateTimeOffset or stringОбязательноWhen it ends, after
startand at most two years later.descriptionstringNotes about the event, up to 8,000 characters.
locationstringWhere it is: a room, an address or a link.
urlstringA link that belongs to the event.
allDayboolWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.recurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.attendeeslistUp to 200 people to invite, each a dictionary with
emailand, if you like,nameandoptional.reminderslistUp to five reminders, each a dictionary with
minutesBeforeand, if you like,action(DISPLAY,EMAILorAUDIO, as inOpenEmail\Constants\CalendarReminderActions).transparencystringOPAQUEshows you busy andTRANSPARENTfree, as inOpenEmail\Constants\CalendarTransparencies.visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL, as inOpenEmail\Constants\CalendarVisibilities.sendInvitesboolFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the new event, shaped like the one Calendar.GetEventAsync returns, with its attendees and their responses.
Пример
var entry = await client.Calendar.CreateEventAsync(new Body{ ["summary"] = "Planning", ["start"] = DateTimeOffset.Parse("2026-10-12 09:00Z"), ["end"] = DateTimeOffset.Parse("2026-10-12 09:30Z"), ["timezone"] = "Europe/London", ["attendees"] = new[] { new Body { ["email"] = "[email protected]", ["name"] = "Ada Lovelace" } }, ["reminders"] = new[] { new Body { ["minutesBefore"] = 10 } }, ["from"] = "[email protected]",}); Console.WriteLine($"{entry["id"]} {entry["start"]}");Примечания
The SDK does not retry it, because a second call makes a second event and invites everybody again.
A key that may not send as
fromis refused with 403from_address_forbidden, and an event with attendees and nofromwith 422invalid_parameter. Invitations withoutemails:sendare a 403insufficient_scope.
Также доступно в
Calendar.UpdateEventAsync
Change an event
Task<JsonObject> UpdateEventAsync( string id, IReadOnlyDictionary<string, object?> patch, string? apiKey = null, CancellationToken cancellationToken = default)Changes an event you organise. A field you leave out keeps its value, and attendees replaces the whole list. Everyone invited gets the updated invitation by email from from, so a change to an event with attendees needs emails:send too, unless sendInvites is false.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.summarystringThe title, 1 to 255 characters.
startDateTimeOffset or stringWhen it starts, a
DateTimeOffsetor ISO 8601 with a zone. ADateTimeOffsetis sent as an instant in UTC.endDateTimeOffset or stringWhen it ends, after
startand at most two years later.descriptionstringNotes about the event, up to 8,000 characters.
locationstringWhere it is: a room, an address or a link.
urlstringA link that belongs to the event.
allDayboolWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.recurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.attendeeslistUp to 200 people to invite, each a dictionary with
emailand, if you like,nameandoptional. It replaces the whole list.reminderslistUp to five reminders, each a dictionary with
minutesBeforeand, if you like,action(DISPLAY,EMAILorAUDIO, as inOpenEmail\Constants\CalendarReminderActions).transparencystringOPAQUEshows you busy andTRANSPARENTfree, as inOpenEmail\Constants\CalendarTransparencies.visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL, as inOpenEmail\Constants\CalendarVisibilities.sendInvitesboolFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the event as it stands after the change, shaped like the one Calendar.GetEventAsync returns, with sequence one higher.
Пример
var entry = await client.Calendar.UpdateEventAsync("cal_3f9a1c7e5b2d48a06c1e9f4b", new Body{ ["start"] = "2026-10-12T10:00:00Z", ["end"] = "2026-10-12T10:30:00Z", ["from"] = "[email protected]",}); Console.WriteLine($"{entry["start"]}, sequence {entry["sequence"]}");Примечания
The SDK does not retry it, because a retry after a lost response sends the update to everybody again.
An event organised by somebody else is refused with 403
not_organizer: answer it withRespondToEventAsyncinstead. An event the key does not reach is a 404.
Также доступно в
Calendar.DeleteEventAsync
Remove an event from the calendar
Task<JsonObject> DeleteEventAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Removes an event for good, as Remove does in the app. Nobody else is told, so call off a meeting with others in it with CancelEventAsync instead.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject with object, id and deleted set to true.
Пример
var deleted = await client.Calendar.DeleteEventAsync("cal_3f9a1c7e5b2d48a06c1e9f4b"); Console.WriteLine($"{deleted["id"]} is off the calendar");Примечания
An event organised by somebody else is refused with 403
not_organizer, and an event that is gone or that the key does not reach is a 404.
Также доступно в
Calendar.CancelEventAsync
Call off a meeting
Task<JsonObject> CancelEventAsync( string id, IReadOnlyDictionary<string, object?>? body = null, string? apiKey = null, CancellationToken cancellationToken = default)Cancels a meeting you organise, as Cancel meeting does in the app. It stays on the calendar with status CANCELLED, and everyone invited is told it is off by email from from, so a meeting with attendees also needs emails:send.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.fromstringThe address the cancellation comes from. It has to be one the key may send as.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the event, shaped like the one Calendar.GetEventAsync returns, with status set to CANCELLED.
Пример
var entry = await client.Calendar.CancelEventAsync("cal_3f9a1c7e5b2d48a06c1e9f4b", body: new Body { ["from"] = "[email protected]" }); Console.WriteLine($"{entry["summary"]} is now {entry["status"]}");Примечания
The SDK does not retry it, because a retry sends the cancellation again.
An event organised by somebody else is refused with 403
not_organizer.
Также доступно в
Calendar.RespondToEventAsync
Answer an invitation
Task<JsonObject> RespondToEventAsync( string id, IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Accepts, declines or tentatively accepts an invitation, as the buttons of an invitation do in the app. The answer goes to the organiser by email from the invited address the key may send as, or from respondingAs when the invitation went to more than one of yours, so it needs emails:send as well.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.responsestringОбязательноACCEPTED,DECLINEDorTENTATIVE, as inOpenEmail\Constants\CalendarResponses.respondingAsstringWhich of your invited addresses answers, when there is more than one.
proposedStartDateTimeOffset or stringA new start to propose with your answer, a
DateTimeOffsetor ISO 8601 with a zone, sent together withproposedEnd. ADateTimeOffsetis sent as an instant in UTC.proposedEndDateTimeOffset or stringThe end of the proposed time.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the event, shaped like the one Calendar.GetEventAsync returns, with your answer on your attendee row.
Пример
using OpenEmail.Constants; var entry = await client.Calendar.RespondToEventAsync("cal_3f9a1c7e5b2d48a06c1e9f4b", new Body { ["response"] = CalendarResponses.Accepted }); foreach (var attendee in entry["attendees"]?.AsArray() ?? []){ Console.WriteLine($"{attendee?["email"]}: {attendee?["partstat"]}");}Примечания
An event that invited none of the addresses the key may send as is refused with 403
not_invited, and a cancelled meeting with 409event_cancelled.When the organiser cannot be reached, nothing changes and the call is a 409
reply_not_sent.With
proposedStartandproposedEndthe organiser gets a counter-proposal, as Propose a new time sends from Google Calendar and Outlook, and decides whether to move the meeting.
Также доступно в
Calendar.DeclineProposalAsync
Decline a proposed time
Task<JsonObject> DeclineProposalAsync( string id, IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Keeps the original time of a meeting you organise after a guest proposed another one, as Keep the original does on the event in the app. The guest is told by email from from, or from the organising address, so it needs emails:send as well. To take the proposed time instead, change the event with Calendar.UpdateEventAsync.
Параметры
idstringОбязательноEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.attendeestringОбязательноThe guest whose proposal you decline, by email address.
fromstringThe address the answer is sent from, when it is not the organising address.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the event, shaped like the one Calendar.GetEventAsync returns, with the guest's proposedStart and proposedEnd cleared.
Пример
var entry = await client.Calendar.DeclineProposalAsync("cal_3f9a1c7e5b2d48a06c1e9f4b", new Body { ["attendee"] = "[email protected]" }); Console.WriteLine($"{entry["summary"]} keeps its time");Примечания
A guest who has not proposed a new time is refused with 404
proposal_not_found, and an event somebody else organises with 403not_organizer.
Также доступно в
Calendar.ListFeedsAsync
List calendar links
Task<IReadOnlyList<JsonObject>> ListFeedsAsync( string? apiKey = null, CancellationToken cancellationToken = default)Returns the secret links that publish your calendar to other calendar apps, as the Share tab of the calendar settings in the app lists them. Anyone with a link can read what it shows, so treat url and webcalUrl like passwords.
Параметры
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A list of JsonObject items, each with id, name, mode, url, webcalUrl and when calendar apps last read it.
Пример
foreach (var feed in (await client.Calendar.ListFeedsAsync())){ Console.WriteLine($"{feed["name"]} ({feed["mode"]}): {feed["url"]}");}Примечания
A key limited to particular addresses or domains is refused with 422
capability_unsupported, because a link covers the whole calendar.
Также доступно в
Calendar.CreateFeedAsync
Create a calendar link
Task<JsonObject> CreateFeedAsync( IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Makes a secret link that publishes your calendar as an iCalendar feed, for Google Calendar (From URL), Outlook (Subscribe from web) or Apple Calendar (New subscription). full shows every detail, busy only the times you are busy. The calendar app reads the link again on its own schedule, usually every few hours.
Параметры
namestringОбязательноThe name calendar apps show for the calendar, up to 100 characters.
modestringОбязательноfullfor every detail,busyfor busy times only, as inOpenEmail\Constants\CalendarFeedModes.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the link with the new url and webcalUrl.
Пример
using OpenEmail.Constants; var feed = await client.Calendar.CreateFeedAsync(new Body { ["name"] = "Work (busy)", ["mode"] = CalendarFeedModes.Busy }); Console.WriteLine($"Paste into Google Calendar: {feed["url"]}");Примечания
One person may keep 10 links. One more is refused with 409
calendar_feed_limit.
Также доступно в
Calendar.ResetFeedAsync
Reset a calendar link
Task<JsonObject> ResetFeedAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Replaces the secret in a calendar link, so the old address stops working everywhere it was shared. Paste the new address into the calendar apps you still want to update.
Параметры
idstringОбязательноCalendar link id,
cfd_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the link with its new url and webcalUrl.
Пример
var feed = await client.Calendar.ResetFeedAsync("cfd_3f9a1c7e5b2d48a06c1e9f4b"); Console.WriteLine($"{feed["url"]}");Примечания
A link that is not yours is a 404
calendar_feed_not_found.
Также доступно в
Calendar.DeleteFeedAsync
Delete a calendar link
Task<JsonObject> DeleteFeedAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Turns a calendar link off for good. Calendar apps that subscribed to it stop getting updates.
Параметры
idstringОбязательноCalendar link id,
cfd_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject with object, id and deleted set to true.
Пример
var deleted = await client.Calendar.DeleteFeedAsync("cfd_3f9a1c7e5b2d48a06c1e9f4b"); Console.WriteLine($"{deleted["id"]}");Примечания
A link that is not yours is a 404
calendar_feed_not_found.
Также доступно в
Calendar.ListSubscriptionsAsync
List calendar subscriptions
Task<IReadOnlyList<JsonObject>> ListSubscriptionsAsync( string? apiKey = null, CancellationToken cancellationToken = default)Returns the other calendars you subscribe to by link, such as a Google or Outlook calendar address, a team rota or public holidays, as Other calendars in the app lists them. Their events show on your calendar, read-only.
Параметры
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A list of JsonObject items, each with name, url, color, status, lastError and how many events it holds.
Пример
foreach (var subscription in (await client.Calendar.ListSubscriptionsAsync())){ Console.WriteLine($"{subscription["name"]}: {subscription["status"]}, {subscription["eventCount"]} events");}Примечания
statusisfailingwhile reads fail and are retried, andstoppedafter ten failures in a row until you refresh it.
Также доступно в
Calendar.CreateSubscriptionAsync
Subscribe to a calendar
Task<JsonObject> CreateSubscriptionAsync( IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Adds a calendar by its iCalendar link, an https, http or webcal address, such as the secret address of a Google calendar or a published Outlook calendar. It is read at once, then again about every half hour. name defaults to the name the calendar gives itself.
Параметры
urlstringОбязательноThe calendar link,
https,httporwebcal.namestringThe name to show, up to 100 characters.
colorstringThe colour of its events, as in
OpenEmail\Constants\CalendarColors.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the subscription with its first events read.
Пример
using OpenEmail.Constants; var holidays = await client.Calendar.CreateSubscriptionAsync(new Body { ["url"] = "webcal://example.com/holidays.ics", ["color"] = CalendarColors.Green }); Console.WriteLine($"{holidays["name"]}: {holidays["eventCount"]} events");Примечания
An address that does not answer with a calendar is refused with 422
calendar_subscription_unreadable, and one you already subscribe to with 409calendar_subscription_exists.One person may subscribe to 20 calendars.
Также доступно в
Calendar.UpdateSubscriptionAsync
Change a calendar subscription
Task<JsonObject> UpdateSubscriptionAsync( string id, IReadOnlyDictionary<string, object?> patch, string? apiKey = null, CancellationToken cancellationToken = default)Renames a subscription or gives it another colour.
Параметры
idstringОбязательноSubscription id,
csb_followed by 24 hex characters.namestringThe new name, up to 100 characters.
colorstringThe new colour, as in
OpenEmail\Constants\CalendarColors.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the subscription as it stands now.
Пример
using OpenEmail.Constants; var subscription = await client.Calendar.UpdateSubscriptionAsync("csb_3f9a1c7e5b2d48a06c1e9f4b", new Body { ["name"] = "Team rota", ["color"] = CalendarColors.Purple }); Console.WriteLine($"{subscription["name"]}");Примечания
A subscription that is not yours is a 404
calendar_subscription_not_found.
Также доступно в
Calendar.RefreshSubscriptionAsync
Refresh a calendar subscription
Task<JsonObject> RefreshSubscriptionAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Reads a subscribed calendar again now instead of waiting for the next half-hourly read, and restarts one that stopped after repeated failures.
Параметры
idstringОбязательноSubscription id,
csb_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject for the subscription after the read, with status and lastError.
Пример
var subscription = await client.Calendar.RefreshSubscriptionAsync("csb_3f9a1c7e5b2d48a06c1e9f4b"); if (subscription["lastError"] is not null){ Console.WriteLine($"Could not read it: {subscription["lastError"]}");}Примечания
A calendar read less than a minute ago is refused with 429
calendar_subscription_refresh_too_soon.
Также доступно в
Calendar.DeleteSubscriptionAsync
Unsubscribe from a calendar
Task<JsonObject> DeleteSubscriptionAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Removes a subscription and every event it brought onto your calendar.
Параметры
idstringОбязательноSubscription id,
csb_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Возвращает
A JsonObject with object, id and deleted set to true.
Пример
var deleted = await client.Calendar.DeleteSubscriptionAsync("csb_3f9a1c7e5b2d48a06c1e9f4b"); Console.WriteLine($"{deleted["id"]}");Примечания
A subscription that is not yours is a 404
calendar_subscription_not_found.
Также доступно в
Calendar.ImportIcsAsync
Import a calendar file
Task<JsonObject> ImportIcsAsync( Stream data, string? filename = null, string? apiKey = null, CancellationToken cancellationToken = default)Sends an iCalendar (.ics) file as the request body and queues it. Its events become events of your own that you can edit, and nobody on them is sent anything, now or when you change them later, unless you ask for that on the change. Poll GetImportAsync until status is completed.
The file may be 10 MB and hold 25,000 events. Several calendars in one file are merged, and the report keeps their names. An event whose UID is already in the workspace is skipped and counted, never overwritten, so sending the same file twice adds nothing.
data is a readable Stream, and it goes out as text/calendar.
Параметры
dataStreamОбязательноThe .ics file: a readable
Stream.filenamestring?The name to show for the file in the list of imports, at most 255 characters.
cancellationTokenCancellationTokenCancels the request.
apiKeystring?Overrides the client API key for this call only.
Возвращает
A JsonObject with status: queued.
Пример
await using var file = File.OpenRead("calendar.ics"); var import = await client.Calendar.ImportIcsAsync(file, filename: "calendar.ics"); Console.WriteLine($"{import["id"]} is {import["status"]}");Примечания
A body that is not an iCalendar file is a 400
not_a_calendar_file, an empty one a 400item_import_empty, and one holding more than 25,000 events a 400too_many_events.A file over 10 MB is a 413
item_import_too_large.To send text you already hold, such as what
GetEventIcsAsyncreturns, encode it first withnew TextEncoder().encode(text).An upload that outlasts the client
Timeoutfails as a network error, so raise it on the client for a large file on a slow connection.Not retried automatically.
Также доступно в
Calendar.ListImportsAsync
List calendar imports
Task<Page> ListImportsAsync( int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Returns one page of the calendar files and calendars brought in, newest first, each with what it added and what it left out. Beside the files sent with ImportIcsAsync it lists the calendars that came with a mailbox import, and those carry the id of that import in parentImportId.
Paging is keyset. limit: takes 1 to 100 and defaults to 25, and nextCursor goes back as cursor: while hasMore is true. ListAllImportsAsync and IterateImportsAsync do that walk for you.
Параметры
limitint?Imports per page, a whole number from 1 to 100. The server defaults to 25.
cursorstring?The
nextCursorfrom the previous page. Never build one yourself.cancellationTokenCancellationTokenCancels the request.
apiKeystring?Overrides the client API key for this call only.
Возвращает
A Page with items, hasMore and nextCursor.
Пример
var page = await client.Calendar.ListImportsAsync(limit: 10); foreach (var import in page){ Console.WriteLine($"{import["id"]} {import["source"]} {import["status"]}: {import["counts"]?["imported"]} events added");}Примечания
sourceisfilefor an upload.takeout,caldavandmicrosoftcame with a mailbox import.A cursor that names no import is a 400
invalid_cursor.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client
MaxRetries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Также доступно в
Calendar.ListAllImportsAsync
Collect every calendar import into one list
Task<IReadOnlyList<JsonObject>> ListAllImportsAsync( int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Follows nextCursor from page to page and returns every calendar import, newest first.
Everything is held in memory before the call returns. Prefer IterateImportsAsync when you can stop early. limit sets the page size of each request, not the total.
Параметры
limitint?Page size per request, from 1 to 100, defaulting to 25 on the server.
cursorstring?A cursor from an earlier page to start after.
cancellationTokenCancellationTokenCancels the request in flight and rejects the whole walk.
apiKeystring?Overrides the client API key for every page of this walk.
Возвращает
A list of JsonObject items holding every import across all pages.
Пример
var imports = await client.Calendar.ListAllImportsAsync(); Console.WriteLine($"{imports.Count} calendar imports, {imports.Count(import => (bool?)import["undoable"] == true)} of them can be undone");Примечания
A failure on any page rejects the whole call, and the imports already fetched are discarded.
Также доступно в
Calendar.IterateImportsAsync
Stream calendar imports one at a time
IAsyncEnumerable<JsonObject> IterateImportsAsync( int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Returns an IAsyncEnumerable<JsonObject> that yields calendar imports one by one, newest first, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.
Параметры
limitint?Page size per request, from 1 to 100, defaulting to 25 on the server.
cursorstring?A cursor from an earlier page to start after.
cancellationTokenCancellationTokenCancels the request in flight and rejects the whole walk.
apiKeystring?Overrides the client API key for every page of this walk.
Возвращает
An IAsyncEnumerable<JsonObject> yielding one import per step.
Пример
await foreach (var import in client.Calendar.IterateImportsAsync(limit: 50)){ if ((string?)import["status"] == "failed") { Console.WriteLine($"{import["id"]} failed"); break; }}Примечания
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Также доступно в
Calendar.GetImportAsync
Get a calendar import
Task<JsonObject> GetImportAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Returns one calendar import with its counts and its report: the calendars it read, how many events it left out and why, and up to 20 of the events it left out. Poll it after ImportIcsAsync until status is completed or failed.
counts.imported is what was added and counts.skipped what was left out, which report.skipped breaks down by reason: uid-taken for an event that was already here, no-start for one with no start time, invalid for one that could not be read and empty for a file or calendar that held no events.
Параметры
idstringОбязательноCalendar import id,
iimp_followed by 24 hex characters.cancellationTokenCancellationTokenCancels the request.
apiKeystring?Overrides the client API key for this call only.
Возвращает
A JsonObject with status, counts, report, undoable and when it started, finished and was undone.
Пример
var import = await client.Calendar.GetImportAsync("iimp_3f9a1c07d2b84e6a9c5b1f20"); Console.WriteLine($"{import["status"]}: {import["counts"]?["imported"]} added, {import["counts"]?["skipped"]} left out");Примечания
An id that names no calendar import is a 404
item_import_not_found.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client
MaxRetries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Также доступно в
Calendar.UndoImportAsync
Remove what a calendar import added
Task<JsonObject> UndoImportAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Deletes every event the import added, changed since or not, and marks the import undone. Nobody is told. Events that were skipped because they were already here are not touched.
Параметры
idstringОбязательноCalendar import id,
iimp_followed by 24 hex characters.cancellationTokenCancellationTokenCancels the request.
apiKeystring?Overrides the client API key for this call only.
Возвращает
A JsonObject with status: undone and undoneAt set.
Пример
try{ var undone = await client.Calendar.UndoImportAsync("iimp_3f9a1c07d2b84e6a9c5b1f20"); Console.WriteLine($"{undone["id"]} is {undone["status"]} since {undone["undoneAt"]}");}catch (OpenEmailApiException error) when (error.IsConflict){ Console.WriteLine("That import is still running or was already removed");}Примечания
An import that is still running, or was already removed, is a 409
item_import_not_undoable.undoableon the import says whether the call would remove anything.An id that names no calendar import is a 404
item_import_not_found.Not retried automatically.