FTPConnect

https://pub.dev/packages/ftpconnect
Admin
FTPConnect is a simple and robust Dart FTP library for Flutter applications to upload, download, and...
Tokens:1,937
Snippets:18
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### FTP Operations with ftpconnect

Source: https://pub.dev/packages/ftpconnect/example

Demonstrates connecting to an FTP server, uploading files, and downloading files with both standard and retry-enabled methods.

```dart
import 'dart:io';

import 'package:ftpconnect/ftpconnect.dart';

void main() async {
  final FTPConnect ftpConnect = FTPConnect(
    "users.on.net",
    user: "pvpt",
    pass: "Lachdhaf",
    showLog: true,
  );

  ///an auxiliary function that manage showed log to UI
  Future<void> log(String log) async {
    print(log);
    await Future.delayed(Duration(seconds: 1));
  }

  ///mock a file for the demonstration example
  Future<File> fileMock({fileName = 'FlutterTest.txt', content = ''}) async {
    final Directory directory = Directory('/test')..createSync(recursive: true);
    final File file = File('${directory.path}/$fileName');
    await file.writeAsString(content);
    return file;
  }

  Future<void> uploadStepByStep() async {
    try {
      await log('Connecting to FTP ...');
      await ftpConnect.connect();
      await ftpConnect.changeDirectory('upload');
      File fileToUpload = await fileMock(
          fileName: 'uploadStepByStep.txt', content: 'uploaded Step By Step');
      await log('Uploading ...');
      await ftpConnect.uploadFile(fileToUpload);
      await log('file uploaded sucessfully');
      await ftpConnect.disconnect();
    } catch (e) {
      await log('Error: ${e.toString()}');
    }
  }

  Future<void> uploadWithRetry() async {
    try {
      File fileToUpload = await fileMock(
          fileName: 'uploadwithRetry.txt', content: 'uploaded with Retry');
      await log('Uploading ...');
      await ftpConnect.connect();
      await ftpConnect.changeDirectory('upload');
      bool res =
          await ftpConnect.uploadFileWithRetry(fileToUpload, pRetryCount: 2);
      await log('file uploaded: ${res ? 'SUCCESSFULLY' : 'FAILED'}');
      await ftpConnect.disconnect();
    } catch (e) {
      await log('Downloading FAILED: ${e.toString()}');
    }
  }

  Future<void> downloadWithRetry() async {
    try {
      await log('Downloading ...');

      String fileName = '../512KB.zip';
      await ftpConnect.connect();
      //here we just prepare a file as a path for the downloaded file
      File downloadedFile = await fileMock(fileName: 'downloadwithRetry.txt');
      bool res = await ftpConnect
          .downloadFileWithRetry(fileName, downloadedFile, pRetryCount: 2);
      await log(
          'file downloaded  ${res ? 'path: ${downloadedFile.path}' : 'FAILED'}');
      await ftpConnect.disconnect();
    } catch (e) {
      await log('Downloading FAILED: ${e.toString()}');
    }
  }

  Future<void> downloadStepByStep() async {
    try {
      await log('Connecting to FTP ...');

      await ftpConnect.connect();

      await log('Downloading ...');
      String fileName = '../512KB.zip';

      //here we just prepare a file as a path for the downloaded file
      File downloadedFile = await fileMock(fileName: 'downloadStepByStep.txt');
      await ftpConnect.downloadFile(fileName, downloadedFile);
      await log('file downloaded path: ${downloadedFile.path}');
      await ftpConnect.disconnect();
    } catch (e) {
      await log('Downloading FAILED: ${e.toString()}');
    }
  }

  await uploadStepByStep();
  await uploadWithRetry();
  await downloadWithRetry();
  await downloadStepByStep();
}
```

--------------------------------

### Add Dependency via Command Line

Source: https://pub.dev/packages/ftpconnect/install

Use these commands to add the package to your project via the terminal.

```bash
$ dart pub add ftpconnect
```

```bash
$ flutter pub add ftpconnect
```

--------------------------------

### Manage FTP directories

Source: https://pub.dev/packages/ftpconnect

Provides methods for listing, creating, changing, and deleting directories on the FTP server.

```dart
//Get directory content
ftpConnect.listDirectoryContent();

//Create directory
ftpConnect.makeDirectory('newDir');

//Change directory
ftpConnect.changeDirectory('moveHereDir');

//get current directory
ftpConnect.currentDirectory();

//Delete directory
ftpConnect.deleteDirectory('dirToDelete');

//check for directory existance
ftpConnect.checkFolderExistence('dirToCheck');

//create a directory if it does not exist
ftpConnect.createFolderIfNotExist('dirToCreate');
```

--------------------------------

### Manage FTP files

Source: https://pub.dev/packages/ftpconnect

Provides methods for renaming, checking size, verifying existence, and deleting files on the FTP server.

```dart
//rename file
ftpConnect.rename('test1.txt', 'test2.txt');

//file size
ftpConnect.sizeFile('test1.txt');

//file existence
ftpConnect.existFile('test1.txt');

//delete file
ftpConnect.deleteFile('test2.zip');
```

--------------------------------

### Upload files to FTP server

Source: https://pub.dev/packages/ftpconnect

Uploads a local file to the FTP server using either a retry-enabled method or a manual step-by-step approach.

```dart
import 'dart:io';
import 'package:ftpconnect/ftpConnect.dart';

main() async{
    FTPConnect ftpConnect = FTPConnect('example.com',user:'user', pass:'pass');
    File fileToUpload = File('fileToUpload.txt');
    await ftpConnect.connect();
    bool res = await ftpConnect.uploadFileWithRetry(fileToUpload, pRetryCount: 2);
    await ftpConnect.disconnect();
    print(res);
}
```

```dart
import 'dart:io';
import 'package:ftpconnect/ftpConnect.dart';

main() async{
  FTPConnect ftpConnect = FTPConnect('example.com',user:'user', pass:'pass');
 try {
      File fileToUpload = File('fileToUpload.txt');
      await ftpConnect.connect();
      await ftpConnect.uploadFile(fileToUpload);
      await ftpConnect.disconnect();
    } catch (e) {
      //error
    }
}
```

--------------------------------

### Import Library

Source: https://pub.dev/packages/ftpconnect/install

Include this import statement in your Dart files to access the library functionality.

```dart
import 'package:ftpconnect/ftpconnect.dart';
```

--------------------------------

### Download files from FTP server

Source: https://pub.dev/packages/ftpconnect

Downloads a file from the FTP server to the local file system, supporting both retry-enabled and manual error-handling patterns.

```dart
import 'dart:io';
import 'package:ftpconnect/ftpConnect.dart';

main() async{
    FTPConnect ftpConnect = FTPConnect('example.com',user:'user', pass:'pass');
    String fileName = 'toDownload.txt';
    await ftpConnect.connect();
    bool res = await ftpConnect.downloadFileWithRetry(fileName, File('myFileFromFTP.txt'));
    await ftpConnect.disconnect();
    print(res)
}
```

```dart
import 'dart:io';
import 'package:ftpconnect/ftpConnect.dart';

main() {
  FTPConnect ftpConnect = FTPConnect('example.com',user:'user', pass:'pass');
 try {
      String fileName = 'toDownload.txt';
      await ftpConnect.connect();
      await ftpConnect.downloadFile(fileName, File('myFileFromFTP.txt'));
      await ftpConnect.disconnect();
    } catch (e) {
      //error
    }
}
```

--------------------------------

### Add Dependency to pubspec.yaml

Source: https://pub.dev/packages/ftpconnect/install

Manually add this line to your project's pubspec.yaml file to include the dependency.

```yaml
dependencies:
  ftpconnect: ^2.0.10
```
Tokens:
Raw