Interface EmailsService
-
- All Implemented Interfaces:
public interface EmailsServiceProgram Editor Emails tab (
CampaignEmails) configuration operations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceEmailsService.WithRawResponseA view of EmailsService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract EmailsService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract EmailsServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. CampaignEmailsretrieve(String id)Retrieves a program's email configuration — the same surface as the dashboard Program Editor's Emails tab. CampaignEmailsretrieve(String id, EmailRetrieveParams params, RequestOptions requestOptions)CampaignEmailsretrieve(String id, EmailRetrieveParams params)abstract CampaignEmailsretrieve(EmailRetrieveParams params, RequestOptions requestOptions)CampaignEmailsretrieve(EmailRetrieveParams params)CampaignEmailsretrieve(String id, RequestOptions requestOptions)CampaignEmailsupdate(String id, EmailUpdateParams params)Updates a program's email configuration. CampaignEmailsupdate(String id, EmailUpdateParams params, RequestOptions requestOptions)CampaignEmailsupdate(String id)CampaignEmailsupdate(EmailUpdateParams params)abstract CampaignEmailsupdate(EmailUpdateParams params, RequestOptions requestOptions)CampaignEmailsupdate(String id, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract EmailsService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract EmailsService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
retrieve
CampaignEmails retrieve(String id)
Retrieves a program's email configuration — the same surface as the dashboard Program Editor's Emails tab. Returns each editable email template (
subject,preheader,body,isEnabled) plus thesettingsblock (sender, contact, and design). The set of email templates returned depends on the program type (referral vs affiliate).
-
retrieve
CampaignEmails retrieve(String id, EmailRetrieveParams params, RequestOptions requestOptions)
-
retrieve
CampaignEmails retrieve(String id, EmailRetrieveParams params)
-
retrieve
abstract CampaignEmails retrieve(EmailRetrieveParams params, RequestOptions requestOptions)
-
retrieve
CampaignEmails retrieve(EmailRetrieveParams params)
-
retrieve
CampaignEmails retrieve(String id, RequestOptions requestOptions)
-
update
CampaignEmails update(String id, EmailUpdateParams params)
Updates a program's email configuration. Only the fields you send are changed; omitted fields are left untouched. You may only write the email templates the dashboard exposes for the program type — writing a template that is not available for the program type returns a
400. Some fields are read-only (settings.sender.fromEmail, whose custom value requires dashboard domain verification).
-
update
CampaignEmails update(String id, EmailUpdateParams params, RequestOptions requestOptions)
-
update
CampaignEmails update(String id)
-
update
CampaignEmails update(EmailUpdateParams params)
-
update
abstract CampaignEmails update(EmailUpdateParams params, RequestOptions requestOptions)
-
update
CampaignEmails update(String id, RequestOptions requestOptions)
-
-
-
-