File Coverage

blib/lib/WebService/Mattermost/V4/API/Resource/Email.pm

Criterion	Covered	Total	%
statement	3	6	50.0
branch			n/a
condition			n/a
subroutine	1	2	50.0
pod	1	1	100.0
total	5	9	55.5

package WebService::Mattermost::V4::API::Resource::Email;
  2: 
  3: # ABSTRACT: Wrapped API methods for the email API endpoints.  4: 
  5: use Moo;
  6: 
  7: extends 'WebService::Mattermost::V4::API::Resource';
  8: 
  9: ################################################################################
 10: 
 11: sub send_test {
 12:     my $self = shift;
 13:     my $args = shift;
 14: 
 15:     return $self->_single_view_post({
 16:         endpoint => 'test',
 17:         view     => 'Status',
 18:     });
 19: }
 20: 
 21: ################################################################################
 22: 
 23: 1;
 24: 
 25: __END__
 26: 
 27: =pod
 28: 
 29: =encoding UTF-8
 30: 
 31: =head1 NAME
 32: 
 33: WebService::Mattermost::V4::API::Resource::Email - Wrapped API methods for the email API endpoints.
 34: 
 35: =head1 VERSION
 36: 
 37: version 0.28
 38: 
 39: =head1 DESCRIPTION
 40: 
 41: =head2 USAGE
 42: 
 43:     use WebService::Mattermost;
 44: 
 45:     my $mm = WebService::Mattermost->new({
 46:         authenticate => 1,
 47:         username     => '[e-mail]',
 48:         password     => 'hunter2',
 49:         base_url     => 'https://my.mattermost.server.com/api/v4/',
 50:     });
 51: 
 52:     my $resource = $mm->api->email;
 53: 
 54: =head2 METHODS
 55: 
 56: =over 4
 57: 
 58: =item C<send_test()>
 59: 
 60: L<Send a test email|https://api.mattermost.com/#tag/system%2Fpaths%2F~1database~1recycle%2Fpost>
 61: 
 62: There are many available parameters for this API call which may require reading
 63: of the API documentation.
 64: 
 65: Providing no parameters will use the ones set on your Mattermost server.
 66: 
 67:     my $response = $resource->send_test({
 68:         # Optional parameters:
 69:         ServiceSettings      => {},
 70:         TeamSettings         => {},
 71:         SqlSettings          => {},
 72:         LogSettings          => {},
 73:         PasswordSettings     => {},
 74:         FileSettings         => {},
 75:         EmailSettings        => {},
 76:         RateLimitSettings    => {},
 77:         PrivacySettings      => {},
 78:         SupportSettings      => {},
 79:         GitLabSettings       => {},
 80:         GoogleSettings       => {},
 81:         Office365Settings    => {},
 82:         LdapSettings         => {},
 83:         ComplianceSettings   => {},
 84:         LocalizationSettings => {},
 85:         SamlSettings         => {},
 86:         NativeAppSettings    => {},
 87:         ClusterSettings      => {},
 88:         MetricsSettings      => {},
 89:         AnalyticsSettings    => {},
 90:         WebrtcSettings       => {},
 91:     });
 92: 
 93: =back
 94: 
 95: =head1 AUTHOR
 96: 
 97: Mike Jones <[e-mail]>
 98: 
 99: =head1 COPYRIGHT AND LICENSE
100: 
101: This software is Copyright (c) 2020 by Mike Jones.
102: 
103: This is free software, licensed under:
104: 
105:   The MIT (X11) License
106: 
107: =cut
108: