Skip to content

Commit

Permalink
Update content for launch
Browse files Browse the repository at this point in the history
  • Loading branch information
karlchillmaid authored Apr 11, 2023
1 parent 1862f44 commit 1be980f
Showing 1 changed file with 6 additions and 28 deletions.
34 changes: 6 additions & 28 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,15 +219,13 @@ To send a file by email, add a placeholder to the template then upload a file. T

The links are unique and unguessable. GOV.UK Notify cannot access or decrypt your file.

Your file will be available to download for a default period of 78 weeks (18 months). From 12 April 2023 we will reduce this to 26 weeks (6 months) for all new files. Files sent before 12 April will not be affected.
Your file will be available to download for a default period of 26 weeks (6 months).

To help protect your files you can also:

* ask recipients to confirm their email address before downloading
* choose the length of time that a file is available to download

To turn these features on or off, you will need version 6.4.0 of the Python client library or a more recent version.

#### Add contact details to the file download page

1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
Expand Down Expand Up @@ -281,35 +279,13 @@ with open('file.csv', 'rb') as f:

#### Ask recipients to confirm their email address before they can download the file

This new security feature is optional. You should use it if you send files that are sensitive - for example, because they contain personal information about your users.

When a recipient clicks the link in the email you’ve sent them, they have to enter their email address. Only someone who knows the recipient’s email address can download the file.

From 12 April 2023, we will turn this feature on by default for every file you send. Files sent before 12 April will not be affected.

##### Turn on email address check

To use this feature before 12 April 2023 you will need version 6.4.0 of the Python client library, or a more recent version.

To make the recipient confirm their email address before downloading the file, set the `confirm_email_before_download` flag to `True`.

You will not need to do this after 12 April.

```python
from notifications_python_client import prepare_upload

with open('file.pdf', 'rb') as f:
...
personalisation={
'first_name': 'Amala',
'application_date': '2018-01-01',
'link_to_file': prepare_upload(f, confirm_email_before_download=True),
}
```
This security feature is turned on by default.

##### Turn off email address check (not recommended)

If you do not want to use this feature after 12 April 2023, you can turn it off on a file-by-file basis.
If you do not want to use this feature, you can turn it off on a file-by-file basis.

To do this you will need version 6.4.0 of the Python client library, or a more recent version.

Expand Down Expand Up @@ -342,7 +318,9 @@ You can choose any value between 1 week and 78 weeks.

To use this feature will need version 6.4.0 of the Python client library, or a more recent version.

If you do not choose a value, the file will be available for the default period of 78 weeks (18 months).
If you do not choose a value, the file will be available for the default period of 26 weeks (6 months).

Files sent before 12 April 2023 had a longer default period of 78 weeks (18 months).

```python
from notifications_python_client import prepare_upload
Expand Down

0 comments on commit 1be980f

Please sign in to comment.