Package-level declarations

Types

Link copied to clipboard
public class AbstractNylasApiError extends Exception

Base class for all Nylas API errors.

Link copied to clipboard
public class AbstractNylasSdkError extends Exception

Base class for all Nylas SDK errors.

Link copied to clipboard
public enum AccessType extends Enum<AccessType>

Enum for the access type of the authentication URL.

Link copied to clipboard
public final class ApplicationDetails

Class representation of a Nylas application details object

Link copied to clipboard
public final class Attachment

Class representation of a Nylas attachment object

Link copied to clipboard
public enum AuthProvider extends Enum<AuthProvider>

Enum class for the different authentication providers.

Link copied to clipboard

Enum representing the method used to determine availability for a meeting.

Link copied to clipboard
public final class AvailabilityParticipant

Class representation of participant details to check availability for.

Link copied to clipboard
public final class AvailabilityRules

Class representation of the availability rules for a Nylas calendar.

Link copied to clipboard
public final class Calendar

Class representation of a Nylas calendar object

Link copied to clipboard
public final class CleanMessagesRequest

Class representation of a Nylas clean message request

Link copied to clipboard
public final class CleanMessagesResponse
Link copied to clipboard
public final class CodeExchangeRequest

Class representation of a Nylas code exchange request

Link copied to clipboard
public final class CodeExchangeResponse

Class representation of a Nylas code exchange response

Link copied to clipboard
public final class ComposeMessageRequest

Class representing a request to compose a message.

Link copied to clipboard
public final class ComposeMessageResponse

Class representing a response to a message composition request.

Link copied to clipboard
public class Conferencing

This sealed class represents the different types of conferencing configurations.

Link copied to clipboard

Enum for the different conferencing providers.

Link copied to clipboard
public class Connector

Class representation of the Nylas connector response.

Link copied to clipboard
public final class Contact

Class representation of a Nylas contact object

Link copied to clipboard
public final class ContactEmail

Interface for email addresses in a contact.

Link copied to clipboard
public final class ContactGroup

Class representing a contact group.

Link copied to clipboard
public final class ContactGroupId

Class representing an object that points to a contact group ID.

Link copied to clipboard
public final class CreateAttachmentRequest

Class representing a Nylas attachment object.

Link copied to clipboard
public final class CreateCalendarRequest

Class representation of a Nylas create calendar request

Link copied to clipboard

This sealed class represents the base Nylas connector creation request.

Link copied to clipboard
public final class CreateContactRequest
Link copied to clipboard

Class representing a request to create a credential

Link copied to clipboard
public final class CreateDraftRequest implements IMessageAttachmentRequest

Class representing a request to create a draft.

Link copied to clipboard
public final class CreateEventQueryParams implements IQueryParams

Class representation of the query parameters for creating an event.

Link copied to clipboard
public final class CreateEventRequest

Class representing a request to create an event.

Link copied to clipboard
public final class CreateFolderRequest

Class representation of the Nylas folder creation request.

Link copied to clipboard
public final class CreateGrantRequest

Class representing a request to create a grant.

Link copied to clipboard
public final class CreateRedirectUriRequest

Class representing a request to create a redirect uri.

Link copied to clipboard
public final class CreateWebhookRequest

Class representation of a Nylas create webhook request.

Link copied to clipboard
public final class Credential
Link copied to clipboard
public class CredentialData

Sealed class representing the data needed to create a credential

Link copied to clipboard
public enum CredentialType extends Enum<CredentialType>
Link copied to clipboard
public final class CustomHeader

Custom headers to be used when drafting or sending an email.

Link copied to clipboard
public final class DeleteResponse

Class representing a response to a delete request.

Link copied to clipboard
public final class DestroyEventQueryParams implements IQueryParams

Class representing a query to delete an event.

Link copied to clipboard
public final class Draft implements IMessage

Class representing a Nylas Draft object.

Link copied to clipboard
public final class EmailName

Class representing an email address and optional name.

Link copied to clipboard
public enum Environment extends Enum<Environment>

Class representing the different Nylas environments.

Link copied to clipboard
public final class Event

Class representing a Nylas Event object.

Link copied to clipboard
public enum EventStatus extends Enum<EventStatus>

Enum representing the status of an event.

Link copied to clipboard
public enum EventType extends Enum<EventType>

Class representing the different Google Event types.

Link copied to clipboard
public enum EventVisibility extends Enum<EventVisibility>

Enum representation of visibility of the event, if the event is private or public.

Link copied to clipboard
public final class FindAttachmentQueryParams implements IQueryParams

Class representation of the query parameters for finding an attachment.

Link copied to clipboard
public final class FindContactQueryParams implements IQueryParams
Link copied to clipboard
public final class FindEventQueryParams implements IQueryParams

Class representation of the query parameters for finding an event.

Link copied to clipboard
public final class FindMessageQueryParams

Class representing the query parameters for finding a message.

Link copied to clipboard
public final class Folder

Class representation of the Nylas folder response.

Link copied to clipboard
public final class FreeBusyTimeSlot

Class representation of a Nylas free-busy time slot object.

Link copied to clipboard
public enum FreeBusyType extends Enum<FreeBusyType>

Enum representing the type of free/busy information returned for a calendar.

Link copied to clipboard
public final class GetAvailabilityRequest

Class representation of a Nylas get availability request

Link copied to clipboard
public final class GetAvailabilityResponse

Class representation of a Nylas get availability response

Link copied to clipboard
public final class GetFreeBusyRequest

Class representation of a Nylas get free-busy request

Link copied to clipboard
public class GetFreeBusyResponse

Class representation of a Nylas get free busy response. It can be either a FreeBusy or a FreeBusyError.

Link copied to clipboard
public final class GoogleConnectorSettings

Class representing Google connector setting.

Link copied to clipboard

Class representing a Google connector creation request.

Link copied to clipboard
public final class Grant

Class representing a Nylas Grant object.

Link copied to clipboard
public enum GrantStatus extends Enum<GrantStatus>
Link copied to clipboard
public enum GroupType extends Enum<GroupType>
Link copied to clipboard
public interface IMessage
Link copied to clipboard
public interface IMessageAttachmentRequest

Represents a message-related request that uses an attachment

Link copied to clipboard
public final class InstantMessagingAddress

Class representation for an IM address in a contact.

Link copied to clipboard
public interface IQueryParams

Interface for query parameters.

Link copied to clipboard
public final class ListCalendersQueryParams implements IQueryParams

Class representation of the query parameters for listing calendars.

Link copied to clipboard
public final class ListConnectorsQueryParams implements IQueryParams
Link copied to clipboard
public final class ListContactGroupsQueryParams implements IQueryParams
Link copied to clipboard
public final class ListContactsQueryParams implements IQueryParams

Class representation of the query parameters for listing calendars.

Link copied to clipboard
public final class ListCredentialsQueryParams implements IQueryParams

Class representation of the query parameters for listing credentials.

Link copied to clipboard
public final class ListDraftsQueryParams implements IQueryParams

Class representing the query parameters for listing drafts.

Link copied to clipboard
public final class ListEventQueryParams implements IQueryParams

Class representation of the query parameters for listing events.

Link copied to clipboard
public final class ListGrantsQueryParams implements IQueryParams

Class representation of the query parameters for listing grants.

Link copied to clipboard
public final class ListMessagesQueryParams implements IQueryParams

Class representing the query parameters for listing messages.

Link copied to clipboard
public final class ListResponse<T extends Object>

Class representation of a Nylas response object that contains a list of objects.

Link copied to clipboard
public final class ListThreadsQueryParams implements IQueryParams
Link copied to clipboard
public final class MeetingBuffer

Class representation of the meeting buffer object within an availability request.

Link copied to clipboard
public final class Message implements IMessage

Class representing a Nylas Message object.

Link copied to clipboard
public enum MessageFields extends Enum<MessageFields>
Link copied to clipboard
public final class MessageHeaders

Class representing a message header.

Link copied to clipboard
public final class MicrosoftConnectorSettings

Class representing Microsoft credentials and settings.

Link copied to clipboard

Class representing a Microsoft connector creation request.

Link copied to clipboard
public final class NylasApiError extends AbstractNylasApiError

Class representation of a general Nylas API error.

Link copied to clipboard
public final class NylasApiErrorResponse

Class representing an error response from the Nylas API.

Link copied to clipboard
public final class NylasOAuthError extends AbstractNylasApiError

Class representing an OAuth error returned by the Nylas API.

Link copied to clipboard

Error thrown when the Nylas API closes the connection before the Nylas SDK receives a response.

Link copied to clipboard
public final class NylasSdkTimeoutError extends AbstractNylasSdkError

Error thrown when the Nylas SDK times out before receiving a response from the server.

Link copied to clipboard
public final class OpenHours

Class representation of a participant's open hours.

Link copied to clipboard
public enum OrderBy extends Enum<OrderBy>

Enum for the order options

Link copied to clipboard
public final class Participant

Class representing an Event participant.

Link copied to clipboard

Enum representing the status of an Event participant.

Link copied to clipboard
public final class PhoneNumber

Class representation for phone numbers in a contact.

Link copied to clipboard
public final class PhysicalAddress

Class representation for a physical address in a contact.

Link copied to clipboard
public final class PKCEAuthURL

Class representing the object containing the OAuth 2.0 URL as well as the hashed secret.

Link copied to clipboard
public enum Platform extends Enum<Platform>

Enum representing the different platforms supported by the redirect URI endpoints.

Link copied to clipboard
public enum Prompt extends Enum<Prompt>
Link copied to clipboard
public final class ProviderDetectParams implements IQueryParams

Class representing the object used to set parameters for detecting a provider.

Link copied to clipboard
public final class ProviderDetectResponse

Class representing the Nylas provider detect response.

Link copied to clipboard
public final class RedirectUri

Class representation of a Redirect URI object

Link copied to clipboard
public final class RedirectUriSettings

Configuration settings for a Redirect URI object

Link copied to clipboard
public enum Region extends Enum<Region>

Enum representing the available Nylas API regions.

Link copied to clipboard
public enum ReminderMethod extends Enum<ReminderMethod>

Enum representing the different types of reminders.

Link copied to clipboard
public final class ReminderOverride

Class representing the reminder details for an event.

Link copied to clipboard
public final class Reminders

Class representing the reminders field of an event.

Link copied to clipboard
public final class RequestOverrides

Overrides to use for an outgoing request to the Nylas API.

Link copied to clipboard
public final class Response<T extends Object>

Class representation of a Nylas response object

Link copied to clipboard
public enum RsvpStatus extends Enum<RsvpStatus>

Enum representing the allowed RSVP status values.

Link copied to clipboard
public final class ScheduledMessage

Class representing information about a scheduled message.

Link copied to clipboard
public final class ScheduledMessagesList

Class representing a list of scheduled messages.

Link copied to clipboard
public final class ScheduledMessageStatus

Class representing a scheduled message status.

Link copied to clipboard
public final class SendMessageRequest implements IMessageAttachmentRequest

Class representing a request to send a message.

Link copied to clipboard
public final class SendRsvpQueryParams implements IQueryParams

Class representation of the query parameters for sending RSVP.

Link copied to clipboard
public final class SendRsvpRequest

Class representation of a Nylas send-rsvp request

Link copied to clipboard
public enum SortBy extends Enum<SortBy>

Enum for the sort options

Link copied to clipboard
public enum SourceType extends Enum<SourceType>
Link copied to clipboard
public final class StopScheduledMessageResponse

Class representing a response after stopping a scheduled message.

Link copied to clipboard
public final class Thread
Link copied to clipboard
public final class TimeSlot

Class representation of a Nylas availability time slot

Link copied to clipboard
public final class TokenExchangeRequest

Class representation of a Nylas token exchange request

Link copied to clipboard
public final class TokenInfoResponse
Link copied to clipboard
public final class TokenParams implements IQueryParams
Link copied to clipboard
public final class TrackingOptions

Class representing the different tracking options for when a message is sent.

Link copied to clipboard
public final class UpdateCalendarRequest

Class representation of a Nylas update calendar request

Link copied to clipboard

Class representing a Nylas update connector request.

Link copied to clipboard
public final class UpdateContactRequest
Link copied to clipboard
public final class UpdateCredentialRequest

Class representing a request to update a credential

Link copied to clipboard
public final class UpdateDraftRequest implements IMessageAttachmentRequest

Class representing a request to update a draft.

Link copied to clipboard
public final class UpdateEventQueryParams implements IQueryParams

Class representation of the query parameters for updating events.

Link copied to clipboard
public final class UpdateEventRequest

Class representation of a Nylas update event request

Link copied to clipboard
public final class UpdateFolderRequest

Class representation of the Nylas folder update request.

Link copied to clipboard
public final class UpdateGrantRequest

Class representation of a Nylas update grant request

Link copied to clipboard
public final class UpdateMessageRequest

Class representing a request to update a message.

Link copied to clipboard
public final class UpdateRedirectUriRequest

Class representation of a Nylas update redirect uri request

Link copied to clipboard
public final class UpdateThreadRequest

Class representing a request to update a thread.

Link copied to clipboard
public final class UpdateWebhookRequest

Class representation of a Nylas update webhook request.

Link copied to clipboard
public final class UrlForAuthenticationConfig

Configuration for generating a URL for OAuth 2.0 authentication.

Link copied to clipboard
public final class Webhook

Class representing a Nylas webhook.

Link copied to clipboard
public final class WebhookDeleteResponse

Class representing a Nylas webhook delete response.

Link copied to clipboard
public final class WebhookIpAddressesResponse

Class representing the response for getting a list of webhook ip addresses.

Link copied to clipboard
public enum WebhookStatus extends Enum<WebhookStatus>

Enum representing the possible webhook statuses.

Link copied to clipboard
public enum WebhookTriggers extends Enum<WebhookTriggers>

Enum representing the available webhook triggers.

Link copied to clipboard
public final class WebhookWithSecret

Class representing a Nylas webhook with secret.

Link copied to clipboard
public final class WebPage

Class representation for web pages in a contact.

Link copied to clipboard
public class When

This sealed class represents the different types of event time configurations.

Link copied to clipboard
public enum WhenType extends Enum<WhenType>

Enum representation of the different types of event time configurations.