Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update DOCUMENTATION.md #131

Merged
merged 2 commits into from
Mar 29, 2023
Merged

Update DOCUMENTATION.md #131

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4042c4
Update DOCUMENTATION.md
saimaghafoor Mar 29, 2023
7c383db
Change not needed yet
karlchillmaid Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions DOCUMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ 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 29 March 2023 we will reduce this to 26 weeks (6 months) for all new files. Files sent before 29 March will not be affected.
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.

To help protect your files you can also:

Expand Down Expand Up @@ -293,15 +293,15 @@ This new security feature is optional. You should use it if you send files that

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 29 March 2023, we will turn this feature on by default for every file you send. Files sent before 29 March will not be affected.
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 29 March 2023 you will need version 5.4.0 of the Ruby client library, or a more recent version.
To use this feature before 12 April 2023 you will need version 5.4.0 of the Ruby 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 29 March.
You will not need to do this after 12 April.

```ruby
File.open("file.pdf", "rb") do |f|
Expand All @@ -316,7 +316,7 @@ end

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

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

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

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

To use this feature will need version 5.4.0 of the Ruby 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).
karlchillmaid marked this conversation as resolved.
Show resolved Hide resolved

```ruby
File.open("file.pdf", "rb") do |f|
Expand Down