The main SendSafely API. Use this API to create packages and append files and recipients.
Constructor to create a new SendSafely object.
|
||||||||||||
Return Type: N/A | ||||||||||||
Parameters:
|
Constructor to create a new SendSafely object.
|
|||||||||
Return Type: N/A | |||||||||
Parameters:
|
Constructor to create a new SendSafely object.
|
||||||||||||
Return Type: N/A | ||||||||||||
Parameters:
|
Constructor to create a new SendSafely object.
|
||||||||||||
Return Type: N/A | ||||||||||||
Parameters:
|
Constructor to create a new SendSafely object.
|
||||||
Return Type: N/A | ||||||
Parameters:
|
Add Contact Group as a recipient on a package.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Adds a recipient email address to the current user's Dropzone.
|
||||||
Return Type: void | ||||||
Parameters:
|
Adds a recipient to a given package.
|
|||||||||
Return Type: Recipient | |||||||||
Parameters:
|
Adds a phone number to a given recipient.
|
|||||||||||||||
Return Type: void | |||||||||||||||
Parameters:
|
Adds a list of recipients to a given package.
|
|||||||||
Return Type: List<Recipient> | |||||||||
Parameters:
|
Add user email address to the specified Contact Group.
|
|||||||||
Return Type: String | |||||||||
Parameters:
|
Create a new Contact Group with the passed in group name. A Contact Group allows a user to define and manage a group of recipients at the group-level, rather than individually on each package. For more information about Contact Groups, refer to http://sendsafely.github.io/overview.htm
|
||||||
Return Type: String | ||||||
Parameters:
|
Create a new Enterprise Contact Group with the passed in group name. The method caller must be a SendSafely Enterprise Administrator, and the Contact Group it creates is available to all users in an organization. For more information on Contact Groups, refer to http://sendsafely.github.io/overview.htm
|
|||||||||
Return Type: String | |||||||||
Parameters:
|
Creates a new directory in a Workspace. Only Workspace packages support directories.
|
||||||||||||
Return Type: Directory | ||||||||||||
Parameters:
|
Creates a new package for the purpose of sending files. A new package must be created before files or recipients can be added. For further information about the package flow, see http://sendsafely.github.io/overview.htm
|
Return Type: Package |
Parameters: N/A
|
Creates a new package that represents a secure Workspace. A Workspace is a type of package that supports file collaboration features, such as directories and subdirectories, file versioning, role-based access control, and activity logging. A Workspace must be created before files, directories, or collaborators can be added. For further information about the package flow and Workspaces, refer to http://sendsafely.github.io/overview.htm
|
||||||
Return Type: Package | ||||||
Parameters:
|
Creates a new package and assigns package owner to the user whose email address is passed as the method argument. The method caller must be a SendSafely Enterprise Administrator and in the same organization as the assigned package owner.
|
||||||
Return Type: Package | ||||||
Parameters:
|
Delete the Contact Group associated with the passed in group id.
|
||||||
Return Type: void | ||||||
Parameters:
|
Deletes a directory from a Workspace package.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Deletes a file from a Workspace package.
|
||||||||||||
Return Type: void | ||||||||||||
Parameters:
|
Deletes a package with the given package id.
|
||||||
Return Type: void | ||||||
Parameters:
|
Downloads a file from the server and decrypts it.
|
||||||||||||
Return Type: File | ||||||||||||
Parameters:
|
Downloads a file from the server and decrypts it.
|
|||||||||||||||
Return Type: File | |||||||||||||||
Parameters:
|
Retrieves a list of packages where the passed in email address is a package recipient.
|
||||||
Return Type: List<RecipientHistory> | ||||||
Parameters:
|
Downloads a file from the server and decrypts it.
|
||||||||||||||||||
Return Type: File | ||||||||||||||||||
Parameters:
|
Downloads a file from the server and decrypts it.
|
|||||||||||||||
Return Type: File | |||||||||||||||
Parameters:
|
Downloads a file located in a directory of a Workspace package from the server and decrypts it.
|
|||||||||||||||
Return Type: File | |||||||||||||||
Parameters:
|
Downloads a file located in a directory of a Workspace package from the server and decrypts it.
|
||||||||||||||||||
Return Type: File | ||||||||||||||||||
Parameters:
|
Encrypt and upload a new file. The file will be encrypted before being uploaded to the server. The function will block until the file is uploaded.
|
||||||||||||
Return Type: File | ||||||||||||
Parameters:
|
Encrypt and upload a new file. The file will be encrypted before being uploaded to the server. The function will block until the file is uploaded.
|
|||||||||||||||
Return Type: File | |||||||||||||||
Parameters:
|
Deletes a temporary package, which is a package that has not yet been finalized.
|
||||||
Return Type: void | ||||||
Parameters:
|
Retrieves a list of all active packages received for the given API User.
|
Return Type: List<PackageReference> |
Parameters: N/A
|
Encrypt and upload a new file to a directory in a Workspace package. The file will be encrypted before being uploaded to the server. The function will block until the file is uploaded.
|
|||||||||||||||
Return Type: File | |||||||||||||||
Parameters:
|
Encrypt and upload a new file to a directory in a Workspace package. The file will be encrypted before being uploaded to the server. the function will block until the file is uploaded.
|
||||||||||||||||||
Return Type: File | ||||||||||||||||||
Parameters:
|
Encrypt and upload a message. The message will be encrypted before being uploaded to the server.
|
||||||||||||
Return Type: void | ||||||||||||
Parameters:
|
Finalizes the package so it can be delivered to the recipients.
|
|||||||||
Return Type: PackageURL | |||||||||
Parameters:
|
Finalizes the package so it can be delivered to the recipients.
|
||||||||||||
Return Type: PackageURL | ||||||||||||
Parameters:
|
Finalizes the package so it can be delivered to the recipients.
|
|||||||||||||||
Return Type: PackageURL | |||||||||||||||
Parameters:
|
Finalizes an undisclosed package, which is a package without recipients. Anyone with access to the link can access the package.
|
|||||||||
Return Type: PackageURL | |||||||||
Parameters:
|
Finalizes an undisclosed package, which is a package without recipients, and protects it with a password. Anyone with access to the link will also be required to supply the password to access the package.
|
||||||||||||
Return Type: PackageURL | ||||||||||||
Parameters:
|
Generates a new SendSafely API key and secret for the provided SendSafely user name and password. This key and secret can be used to authenticate to the SendSafely API. If the current user has Two-Step Authentication enabled, a TwoFactorAuthException exception will be returned to the client that includes a validation token. Additionally, a verification code will be sent via SMS message to the user's mobile number. Both the validation token and verification code will be needed in a follow-up call to the generateKey2FA API method in order to complete the authentication process and receive an API key and secret.
|
|||||||||||||||
Return Type: DefaultCredentials | |||||||||||||||
Parameters:
|
Generates a new SendSafely API key and secret for a user that has Two-Step Authentication enabled. This key and secret can be used to authenticate to the SendSafely API.
|
|||||||||||||||
Return Type: DefaultCredentials | |||||||||||||||
Parameters:
|
Get all active packages for the current user.
|
Return Type: List<PackageReference> |
Parameters: N/A
|
Retrieves activity log records for a Workspace package. The method supports returning up to 10 records at a time. The caller must be the owner of the Workspace, assigned to the manager role within the Workspace, or an enterprise administrator.
|
|||||||||
Return Type: List<ActivityLogEntry> | |||||||||
Parameters:
|
Get all archived packages for the current user.
|
Return Type: List<PackageReference> |
Parameters: N/A
|
Retrieve the list of available Contact Groups for the current user profile, including all email addresses associated with each Contact Group.
|
Return Type: List<ContactGroup> |
Parameters: N/A
|
Retrieves meta data about a directory in a Workspace package.
|
|||||||||
Return Type: Directory | |||||||||
Parameters:
|
Gets all recipients assigned to the current user's Dropzone.
|
Return Type: List<String> |
Parameters: N/A
|
Retrieve the list of available Contact Groups in the user's organization, including all email addresses associated with each Contact Group.
|
Return Type: List<ContactGroup> |
Parameters: N/A
|
Retrieves information about the organization the user belongs to.
|
Return Type: EnterpriseInfo |
Parameters: N/A
|
Generates a new RSA Key pair used to encrypt keycodes. The private key as well as an identifier associating the public Key is returned to the user. The public key is uploaded and stored on the SendSafely servers.
|
||||||
Return Type: Privatekey | ||||||
Parameters:
|
Downloads and decrypts a keycode from the server for a given packageId and RSA Key pair.
|
|||||||||
Return Type: String | |||||||||
Parameters:
|
Revokes a public key from the server. Only call this if the private key has been deleted and should not be used anymore.
|
||||||
Return Type: void | ||||||
Parameters:
|
Retrieves meta data about a file in a Workspace package.
|
||||||||||||
Return Type: FileInfo | ||||||||||||
Parameters:
|
Returns packages in the current user's organization based on provided search criteria. The search defaults to returning all packages up to the current date and time, if a specific value is not passed for each search criteria. A maximum of 100 records will be returned per method call. The calling user must be a SendSafely Enterprise Administrator.
|
|||||||||||||||||||||
Return Type: PackageSearchResults | |||||||||||||||||||||
Parameters:
|
Fetch the latest package meta data about a specific package given the unique package id.
|
||||||
Return Type: Package | ||||||
Parameters:
|
Fetch the latest package meta data about a specific package given a secure link of type String.
|
||||||
Return Type: Package | ||||||
Parameters:
|
Fetch the latest package meta data about a specific package given the secure link of type java.net.URL.
|
||||||
Return Type: Package | ||||||
Parameters:
|
Returns a secure link for accessing a package. This method is intended for generating a shareable link for a Workspace package, however non-Workspace packages are also supported. Packages with a temporary or deleted PackageState are not supported by this method.
|
|||||||||
Return Type: String | |||||||||
Parameters:
|
Downloads a message from the specified secure link and decrypts it.
|
||||||
Return Type: String | ||||||
Parameters:
|
Gets a recipient from a given package.
|
|||||||||
Return Type: Recipient | |||||||||
Parameters:
|
Gets information about the current logged in user.
|
Return Type: UserInformation |
Parameters: N/A
|
Moves a directory to the specified destination directory in a Workspace package.
|
||||||||||||
Return Type: void | ||||||||||||
Parameters:
|
Moves a file to the specified destination directory in a Workspace package.
|
||||||||||||
Return Type: void | ||||||||||||
Parameters:
|
Parses out SendSafely links from a String of text.
|
||||||
Return Type: List<String> | ||||||
Parameters:
|
Remove a Contact Group from a package.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Deletes a recipient email address from the current user's Dropzone.
|
||||||
Return Type: void | ||||||
Parameters:
|
Removes a recipient from a given package.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Remove user email address from the specified Contact Group.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Renames a directory to the specified directory name in a Workspace package.
|
||||||||||||
Return Type: void | ||||||||||||
Parameters:
|
Updates the package descriptor. For a Workspaces package, this method can be used to change the name of the Workspace.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Update the package life. Setting the life to 0 means the package will not expire.
|
|||||||||
Return Type: void | |||||||||
Parameters:
|
Used to update the role of a Workspace package recipient (i.e. Workspace collaborator).
|
||||||||||||
Return Type: void | ||||||||||||
Parameters:
|
Verifies a user's API key and secret. This method is typically called when a new user uses the API for the first time.
|
Return Type: String |
Parameters: N/A
|
Verifies the current version of the SendSafely API against the server.
|
Return Type: Version |
Parameters: N/A
|